Skip to content

You are viewing documentation for Immuta version 2020.3.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Immuta Quickstart Guide

Audience: Data Owners

Content Summary: This guide outlines how to add a data source and apply Local Policies in Immuta to demonstrate dynamic policy enforcement. While in the Immuta UI, you may use the Guidance icon in the bottom left corner for further instructions.

Prerequisites: an Immuta instance.

1 - Create a Data Source

Create a data source by connecting your own data:

  1. Click the Data Sources icon in the left sidebar.
  2. Click New Data Source.
  3. Select the storage technology tile that contains the data you want to expose. The list of enabled technologies is configurable and may differ from the image below.

    Data Source Creation Storage Technology

  4. Complete the required fields in the Connection Information section and click Test Connection.

  5. Decide how to virtually populate the data source by selecting Table or SQL Statement.


    1. If you choose Table, click Edit in the table selection box that appears.

    2. By default, all tables are selected. Select and deselect tables by clicking the checkbox to the left of the table name in the Import Tables menu. You can create multiple data sources at one time by selecting multiple tables.

    3. After making your selection(s), click Apply.

      Multiple Data Sources

    SQL Statement

    1. Before entering a SQL statement, test the statement to verify that it works.
    2. Enter your SQL statement in the text box.
    3. Click Validate Statement.
  6. Complete the Basic Information section:

    • The SQL Schema Name field is the SQL name that the data source will exist under in the Immuta Query Engine.
    • The Data Source Name field is the name that will be shown in the Immuta UI.
    • The SQL Table Name will be the name of the table in the Immuta Query Engine.

      Data Source Creation Basic Information

  7. Click Create.

For an extensive tutorial on creating a data sources see Chapter 4: Connecting Data.

2 - Build a Data Policy

  1. Navigate to the Data Source, and then click the Policies tab.
  2. Scroll to the Data Policies menu, and click New Policy.
  3. Select Mask from the dropdown menu.
  4. Select using hashing and the column you would like to mask in the subsequent dropdown menus.
  5. Choose the conditions that will drive the policy: select for, and then select everyone.
  6. Click Create and then Save All to create your new policy.

    Policy Builder

For a more extensive tutorial on Local Policies, see Chapter 4: Connecting Data. For Global Policy tutorials, see Chapter 3: Writing Global Policies for Compliance.

3 - Query the Data

  1. Click the Query Editor icon in the left sidebar.

    Query Editor

  2. Select the data source you just applied the policy to from the Tables list.

  3. Click the dropdown menu icon next to the data source, and select Preview Sample Data.

    Preview Sample Data

  4. View data in the Results panel.


The images below display the results of a query before and after the masking policy was applied to the phone column.

Query Results Before Policy is Applied


Query Results After Policy is Applied


Additional Tutorials

Beyond the dynamic policy enforcement illustrated above, the chapters listed below explain and illustrate other features of Immuta, including Global Policies, Sensitive Data Detection, Schema Monitoring, and native project workspaces (which allow users to write data back to Immuta).