Skip to content

Project Member Guide

Subscribe to a project

  1. Click Data in the navigation menu and then select Projects.
  2. Click Join Project from either the all projects view or the project overview tab, which can be accessed by clicking on the project.
  3. Click Join to confirm you want to join the project.
  4. After you have been granted access to the project, go to the project and click I Agree to acknowledge that you will only use the project for its specified purposes.

Change project contexts

Switch projects in the Immuta UI

  1. Click the dropdown menu in the top right corner of the console.

  2. Select a project. Once selected, the current project will display at all times in the top right corner of the console.

If you unsubscribe from the project, this display will default to No Current Project.

Switch projects using UDFs in Databricks

  1. View your available projects by running the following query in Spark: select * from immuta.list_projects. In the resulting table, note the values listed in the id column; this value will be used at the parameter in the following step.
  2. Run select immuta.set_current_project(<id>). This UDF must be called in its own notebook cell to ensure the changes take effect.

Your project context will be switched, and that project's data sources and workspaces will now be visible. To set your project context to None, run select immuta.set_current_project() with no parameters.

Note: Since the UDFs are not actually registered with the FunctionRegistry, if you call DESCRIBE FUNCTION immuta.set_current_project, you won't get back the documentation for the UDF. For a complete list of functions, see the Project UDFs reference guide.

Create a project-based API key

Any project member can create project-based API keys, which are used for authenticating external tools with Immuta.

  1. Navigate to the Project Overview tab.

  2. Click the Get API Key button at the bottom of the left panel.

  3. An API Key modal will display with your requested information. Please store these credentials somewhere secure. If you misplace this information, you will have to generate a new key and re-authenticate all services connected to Immuta via this key.

  4. Click the Close button.

Create project-based SQL connections

Project SQL accounts are unique to each project and only provide access to the data sources in that project. Project SQL credentials cannot be retrieved from Immuta if they are lost. Credentials can only be re-generated using the instructions below. When a user generates new SQL credentials for a project, any existing SQL credentials for that project the user may have had are revoked.

  1. Navigate to the Project Overview tab.

  2. Click SQL Connection in the upper right corner.

  3. A window will display with the connection information. Store these credentials somewhere secure. If you misplace them, you will have to generate a new account and re-authenticate all services connected to Immuta via this account.

  4. Click Close.

Leave a project

  1. Navigate to the Project Overview tab.
  2. Click the Leave Project button in the upper right corner, and then click Confirm.

Manage project data sources

Add data sources to a project

Any project member can add data sources to a project, unless the project equalization or allow masked joins features are enabled; in those cases only project owners can add data sources to the project.

  1. Select the project, and then navigate to the Project Overview tab.
  2. Click the Add Data Sources button in the Data Sources section in the center pane.
  3. Start typing the name of a data source you'd like to include in the project.
  4. Select the data source from the list of auto-completed options in the dropdown menu.
  5. Repeat this process to add additional data sources to the list. Click Remove to remove them.
  6. When complete, click the Add button at the bottom of the list.

Add data sources by purpose

You can automatically add all data sources to a project that contain a Limit usage to purpose policy that matches the purpose of that project.

  1. Select a Project, and click the Add Data Sources button on the Data Sources tab.

  2. Click Add By Purpose in the top right of the dialog.

  3. All data sources matching the project's purpose(s) will populate at the bottom of the dialog. Review this list, and then click Save.

Create a derived data source outside a workspace

Deprecation notice

Support for this feature has been deprecated.

  1. Select a project and navigate to the Overview or Data Sources tab.

  2. Click Add Derived Data Source.

  3. Begin typing in the Search by Name or Description text box, and then select the data source(s) from which your new data source will be derived.

  4. Click Save.

  5. Follow the instructions for creating a data source.

Remove data sources from a project

As a project member, you can only delete data sources you've added to the project.

  1. Select a project, and then click the Data Sources tab.
  2. Click the Remove Data Source icon in the Actions column of the data source you want to remove.
  3. Click Confirm in the window that appears.

Search for projects

Immuta's UI provides a list of all projects, excluding those that have been set to private. Users can search for projects by keyword, tag, or data source.

  1. To access a list of all projects, click the projects icon in the left sidebar, and then click the All Projects tab.
  2. To filter projects by keyword, type one or more keywords into the search box at the top of the page, and select a keyword from the auto-completed results. If a list does not display, then no keywords matching that text currently exist.
  3. To filter projects by tags, type one or more tag names into the search box at the top of the page and select a tag from the list of auto-completed results. If a list of tags does not display, then no tags matching that text currently exist.
  4. To filter projects by data sources, type one or more data source names into the search box at the top of the page and select a data source from the list of auto-completed results. If a list of data sources does not display, then no data sources matching that text currently exist.