This page assumes you have created a project or are working with an existing project. This page explains how to rename a project and make other changes to a project.
There are two basic categories of projects:
- Projects listed in the top section of the LookML Projects page are projects that have been created, possibly including generating model and view files. If you are a Looker admin, or if you have
developpermission for at least one model in a project, you can see the project in the Develop menu and in the top section of the LookML Projects page.
- Projects listed in the Pending Projects section of the LookML Projects page are projects where the Looker admin has configured the allowed connections for a model but the Looker developers have not yet generated the project and modeling. If you have
developpermission, you can see these projects.
Accessing Project Files
You can access project files either from the Develop section in Looker or from the UI.
Accessing Project Files from the Develop Menu
You can access project files by going to the Develop navigation menu and selecting the project you would like to view. This will take you to the LookML file browser page.
Project files are shown in the side panel of the Looker IDE. If your project is enabled for folders in the IDE, LookML developers can customize the file organization to match your project. If your project is not enabled for folders, the IDE organizes your files according to file type, such as document, Model, View, Dashboard, or Data.
You must be in Development Mode in order to edit files.
- Click Develop to open the Develop menu.
- Click the project you want to access.
- Click the file you want to access. If your project is enabled for folders in the IDE, files with changes are shown in blue font in the IDE sidebar. If your project is not enabled for folders, a file with changes is indicated by a green dot.
- View the code in that file. Lines with additions or changes are highlighted on the edge in green; lines that have been deleted are marked with a red dotted line in the margin. These change markers are displayed until the changes are committed.
- Expand the right sidebar to see explanations and options for the current location in the code. You also can click a parameter name in the sidebar to go to Looker documentation for that parameter.
Searching for Project Files
Looker provides an integrated development environment (IDE) for creating and managing your project files. The IDE is often referred to as the LookML editor as that’s where you edit LookML files.
In the Looker IDE, you can search for and open a project file using a keyboard shortcut described in the Keyboard Shortcuts documentation page. Open the search window using the keyboard shortcut Command-J (Mac) or Ctrl+J (Windows):
- In the Jump to file field, enter a search term. The search term can be a word or any part of a word.
- The file list will show only those files that include your search term. The results show each file’s name and file type. Click the file you want to open.
If your project has IDE folders enabled, you can also click the Jump to file button to search for a project file:
Accessing LookML from an Explore
You can also directly access the LookML for an Explore or a field from an Explore. This can be done in several ways:
To see the LookML for an Explore, hover over the Explore name in the top left corner, and click on the Looker icon:
To see the LookML for a field, you can click the Looker icon that appears to the right of the field name:
To see the LookML for a field, you also can click Go to LookML from the gear drop-down menu for a field:
After selecting a field, you will be taken directly to the field definition in the corresponding view file.
Existing Projects and Their Models
In the top section of the LookML Projects page, you can see certain existing projects. In Production Mode, you see projects that have been generated and pushed to production. In Development Mode, you see projects that you have pulled from production or generated yourself in your Development Mode.
To see a project, you must have the
manage_models permission, or have the
develop permission for at least one model in the project.
If you have the
manage_models permission, you can add or edit the configuration for any model listed under the projects.
To specify a new project or a new model for an existing project, see the Creating a New LookML Project documentation page.
Viewing the Listing for a Project
Below you can see an example of the project listings in the Projects section. Each element of a project listing is described below.
This is the name of the project. Each project may have one or more models listed next to it. You can click on the project name to navigate to the LookML for that project. If the project uses the older YAML-based LookML, that is indicated next to the project name.
The set of LookML model files for the given project.
If your Development Mode environment differs from production, this list can change between Development Mode and Production Mode. For example, if you might have created a new model in Development Mode that you have not yet pushed to production.
If there is a problem with a model, the model will show a status indicating the problem with the configuration.
|LookML model file doesn’t exist yet||You see this issue if someone configured a model on this page but has not yet created a corresponding LookML file for it.|
|Configuration required for use||You see this issue if someone created a new LookML model file in an existing project, but has not configured it on this page yet.|
|Connection ‘x’ does not exist||The
|Model ‘x’ is not allowed to use connection ‘y’||The
|A model named ‘x’ is already configured in project ‘y’||Model names must be unique within your Looker instance, even if they are in different projects.|
Adding and Editing Configurations
If the Configure button is available next to the project’s listing, you can add or edit the project’s model configuration.
If the model does not have a configuration, when you click Configure, Looker displays the Configure a Model page. On the Configure a Model page, you can specify the model name, project name, and specify which connections are available to the model:
If the model does have a configuration, when you click Configure, Looker displays the Edit Model Configuration page. On the Edit Model Configuration page, you can change which connections are available to the model:
You can view the model name but not rename it. Models are named according to the filenames you use in the Models section of the Looker IDE.
In the Project field, you can specify that the model should be associated with a different project. For example, if you created a new project including a model with the same name, you can transition the model configuration to be associated with the new project’s model.
In the Allowed Connections field, you can limit the model to use a list of specific connections, or you can allow the model to use any connection (all current and future connections).
Renaming a Project
Once you have created your project, if you are a Looker admin, you can change the project name using the project’s Project Settings page.
Looker developers who are not admins can view the Project Settings page but cannot change the options there.
To rename a project:
- Verify that you have Development Mode turned on.
- Navigate to your project in the Develop menu.
- Click the drop-down arrow to expand the project’s Git menu.
- Select Project Settings.
- In the Project Settings page, use the Name field to edit the name of your project.
- To save the new project name, click Save Project Settings.
Deleting a Project
If you are a Looker admin, you can delete an existing project. Clicking the Delete Project button will remove all LookML from the project, in all development and production environments across your Looker instance.
Please be certain you want to delete a project before you do so. It cannot be undone and is difficult and laborious to recover.
A deleted project will no longer appear in the Projects section of the LookML Projects page, but will still appear in the Configured Projects section.
To remove the project configuration, which will remove the project from your development environment completely, select the project from the Develop menu, click on the Git menu and select Project Settings, then click Delete Project.
Projects with Only a Configuration
The Pending Projects section contains models that are configured with a project name, but not yet generated.
Thus the Pending Projects section contains projects and models that are only configured, that do not yet have any LookML.
Configuring models before the project exists is useful if you have developers who have not been given the
manage_models permission. Because the model has already been configured, those developers will be able to run queries as soon as they create the project and that model. When the project is generated, the listing for that project moves to the top section of the LookML Projects page.
Viewing the Listing for a Project
Below you can see an example of the Pending Projects section. The elements of this section are described below.
This section lists projects that are configured but not yet generated, so the project name in this field is the intended name of the project when it is later generated. Clicking the project name takes you to the New Project page where you can generate that project. You must be in Development Mode to reach the New Project page.
This is the model name that was specified when creating the model configuration.
The column to the right of the model name shows the connections that were allowed for this model when creating the model configuration.
Editing a Configuration
The Configuration button lets you change the project name and the connections that are permitted for this model. Click it to edit the model configuration.
On the Edit Model Configuration page, you can change which connections are available to the model. You can view the model name but not rename it.
You can also specify that the model should be associated with a different project. For example, if you created a new project including a model with the same name, you can transition the model configuration to be associated with the new project’s model.
Adding LookML to a Project
The Add LookML button opens the New Project page for that project, letting you use the LookML generator to automatically generate LookML based on a set of tables in your database.