Create and manage folders

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of theService Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see thelaunch stage descriptions.

Note: To give feedback or request support for this feature, send an email tobigquery-explorer-feedback@google.com.

The following document describes how create and manage folders inBigQuery. You can use folders to organize and control access tosingle file code assets, such asnotebooks,saved queries,data canvases, anddata preparation files.BigQuery offers user folders for individuals to manage their owncode assets, and team folders to manage a team's code assets.

BigQuery folders are powered byDataform.

Before creating folders, learn how BigQuery folders workby readingOrganize code assets with folders.

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery and Dataform APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery and Dataform APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

Enable the APIs

Required roles

To get the permissions that you need to complete the tasks in this document, askyour administrator to grant you the appropriate IAM roles on theproject, folder, or resource.

To get the permissions that you need to use the BigQuery filebrowser, ask your administrator to grant you theBigQueryUser (roles/bigquery.user) orBigQuery Studio User(roles/bigquery.studioUser) role on the project.

Permissions granted on a folder propagate to all the files and folders containedwithin it.

The following apply to files and the folders that contain them:

Role	Granted on	Permissions and use cases
Code Owner (roles/dataform.codeOwner)	File or folder	Grants full control over a resource in the files and folders system. A user with this role can perform all actions, including deleting the resource, setting its IAM policy, and moving it.
Code Editor (roles/dataform.codeEditor)	File or folder	Allows for editing and managing content. A user with this role can add content to folders, edit files, and get the IAM policy for a file or folder. This role is also required on the destination folder when moving a resource.
Code Commenter (roles/dataform.codeCommenter)	File or folder	Allows for commenting on code assets or folders.
Code Viewer (roles/dataform.codeViewer)	File or folder	Provides read-only access. A user with this role can query the contents of files and folders.
Code Creator (roles/dataform.codeCreator)	Project	Grants permission to create new files and folders within a project.

The following roles are specific to managing team folders:

Role	Granted on	Permissions and use cases
Team Folder Owner (roles/dataform.teamFolderOwner)	Team folder	Grants full control over a team folder in the files and folders system. A user with this role can delete the team folder and set its IAM policy.
Team Folder Contributor (roles/dataform.teamFolderContributor)	Team folder	Allows for content management within a team folder. A user with this role can update a team folder.
Team Folder Commenter (roles/dataform.teamFolderCommenter)	Team folder	Allows for commenting on a team folder and the code assets that it contains.
Team Folder Viewer (roles/dataform.teamFolderViewer)	Team folder	Provides read-only access to a team folder and its contents. A user with this role can view a team folder and get its IAM policy.
Team Folder Creator (roles/dataform.teamFolderCreator)	Project	Grants permission to create new team folders within a project.

For more information about granting roles, seeManage access to projects, folders, and organizations.

These predefined roles contain the permissions required to complete thetasks in this document. To see the exact permissions that are required, expandtheRequired permissions section:

You might also be able to get these permissions withcustom rolesor otherpredefined roles.

To gain full access to all the folders and files in your project, ask youradministrator to grant you the following IAM roles on theproject:

• Dataform Admin(roles/dataform.admin)
• Dataform Editor(roles/dataform.editor)
• Dataform Viewer(roles/dataform.viewer)

View resources

Follow these steps to view folders and code assets inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

   If you don't see the left pane, clicklast_pageExpand left pane to open the pane.

3. Do one of the following to view folders and code assets in the selectedproject and code region:

   • Expand theUser (your email address) node to see folders and filesthat you have created.
   • Expand theTeam folders node to view all team folders that you haveaccess to.
   • Expand theShared with me node to view all folders and files thatother users have shared with you.

Change the code region

You can have folders and code assets indifferent code regions.Follow these steps to change the code region that you are viewing:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Next to the project name, clickmore_vertView files panel actions>Switch code region.

4. Select the code region that you want to view.

5. ClickSave.

Create a folder or code asset

Use this procedure to create any of the following resources:

• A user folder or code asset at any level.
• A subfolder in a team folder.
• A code asset in the subfolder of a team folder.

For information about creating a team folder, seeCreate a team folder.

Follow these steps to create a folder or code asset in BigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the user root node or the folder in which you want to create theresource.

4. Clickmore_vertView actions>Create, and then select the type ofresource that you want to create.

5. In the create resource pane, type a name for the new resource.

6. ClickSave.

Create a team folder

Follow these steps to create a team folder in BigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the team folder root node.

4. Clickmore_vertView actions>Create team folder.

5. In theCreate team folder dialog, type a name for the team folder.

6. ClickCreate.

Upload a code asset

Follow these steps to upload a code asset in BigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder to which you want to upload the code asset.

4. Clickmore_vertView actions>Upload, and then select the type ofcode asset that you want to upload.

5. In the upload resource pane, do one of the following:

   • Click theFile upload radio button, and then browse for and select alocal file.
   • Click theURL radio button, and then type the URL for a code assetfile that resides in a GitHub repository.

6. Type a name for the code asset.

7. Optional: Select a region in which to store the code asset. If you selecta different region than the default value, the region that you selectbecomes the default region where all new code assets are createdgoing forward.

8. ClickSave.

Download a code asset

Follow these steps to download a code asset in BigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the code asset that you want to download.

4. Clickmore_vertView actions>Download.

Rename a folder or code asset

Follow these steps to rename a folder or code asset inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder or code asset that you want to rename.

4. Clickmore_vertView actions>Rename.

5. In the resource renaming dialog, type a new name for the resource.

6. ClickRename.

Share a folder or code asset

Follow these steps to share a folder or code asset inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder or code asset that you want to share.

4. In theShare permissions pane, clickAdd User/Group.

5. In theNew principals field, enter a principal.

6. Do one of the following:

   • In theRole list, select one of the following roles to share a codeasset, including a user folder:

     • roles/dataform.codeOwner: Canperform any action on the code asset, including deleting or sharing it.
     • roles/dataform.codeEditor: Canperform any action on the code asset except for deleting or sharing it.
     • roles/dataform.codeCommenter: Canview and comment on the code asset.
     • roles/dataform.codeViewer: Canview the code asset.

   • In theRole list, select one ofthe following roles to share a team folder:

     • roles/dataform.teamFolderOwner: Canperform any action on the team folder, including deleting or sharing it.
     • roles/dataform.teamFolderContributor: Canperform any action on the team folder except for deleting or sharing it.
     • roles/dataform.teamFolderCommenter: Canview and comment on the team folder and the code assets that it contains.
     • roles/dataform.teamFolderViewer: Canview the team folder and the code assets that it contains.

7. ClickSave.

8. To return to the notebook information page, clickClose.

Move a folder or code asset

Follow these steps to move a folder or code asset inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder or code asset that you want to move.

4. Clickmore_vertView actions>Move.

5. In the move resource dialog, select the user or team folder to which you wantto move the resource.

6. ClickMove.

Copy a folder or code asset

Follow these steps to copy a folder or code asset inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder or code asset that you want to copy.

4. Clickmore_vertView actions>Copy.

5. In the copy resource dialog, select the user or team folder to which you wantto copy the resource.

6. ClickCopy.

Delete a folder or code asset

Follow these steps to delete a folder or code asset inBigQuery:

1. Go to theBigQuery page.

   Go to BigQuery

2. In the left pane, clickfolderFilesto open the file browser:

   

3. Select the folder or code asset that you want to delete.

4. Clickmore_vertView actions>Delete.

5. In the delete resource dialog, clickDelete.

What's next

• Organize code assets with folders
• Create notebooks
• Create saved queries
• Create data canvases
• Create data preparations