Manage Schema Monitoring

Enable or disable schema monitoring, edit the format of data source or SQL table names, or change the frequency of schema monitoring and column detection jobs

Edit schema project connection

Requirement: Must be an owner of the schema project

1. Navigate to the Project Overview tab.

2. Click Edit Connection.

3. Use the modal to edit the connection information or column detection.

4. Click Save.

Edit schema monitoring

Requirement: Must be an owner of the schema project

1. Navigate to the Project Overview tab.

2. Click Edit Schema Monitoring.

3. Use the modal to make any necessary changes:

   1. Basic Information: Use this section to edit the format that data sources will be named with when a new table is discovered in your platform by schema monitoring.

      1. Opt to edit the SQL Schema Name Format to be the SQL name that the data source exists under in Immuta. It must include a schema macro but you may personalize it using lowercase letters, numbers, and underscores. It may have up to 255 characters.

      2. The Schema Project Name Format cannot be changed in the schema monitoring settings.

      3. Opt to edit the Data Source Name Format, which will be the format of the name of the data source in the Immuta UI.

         • <Tablename>: The data source name will be the name of the remote table, and the case of the data source name will match the case of the macro.

         • <Schema><Tablename>: The data source name will be the name of the remote schema followed by the name of the remote table, and the case of the data source name will match the cases of the macros.

         • Custom: Enter a custom template for the data source name. You may personalize this field as you wish, but it must include a tablename macro. The case of the macro will apply to the data source name (i.e., <Tablename> will result in "Data Source Name," <tablename> will result in "data source name," and <TABLENAME> will result in "DATA SOURCE NAME").

      4. Opt to edit the SQL Table Name Format, which will be the format of the name of the table in Immuta. It must include a tablename macro, but you may personalize the format using lowercase letters, numbers, and underscores. It may have up to 255 characters.

   2. Schema Monitoring:

      1. Select the toggle to enable or disable schema monitoring.

      2. If schema monitoring is enabled, there must be a schema detection owner. Use the dropdown menu in the modal to select a new schema detection owner. The new owner must be an owner of one or more of the data sources belonging to that schema.

4. Click Save.

Change the frequency of schema monitoring jobs

Requirement: Immuta permission USER_ADMIN

1. Navigate to the App Settings page and scroll down to the Advanced Configuration.

2. Copy and paste this YAML into the text box:

   schedule:
     schemaEvolutionCheck: <your-new-frequency>

   Replace your-new-frequency with the time you would like between schema jobs. For example use */30 * * * * for the queries to run every 30 minutes.

3. Click Save.

Change the frequency of column detection jobs

Requirement: Immuta permission USER_ADMIN

1. Navigate to the App Settings page and scroll down to the Advanced Configuration.

2. Copy and paste this YAML into the text box:

   schedule:
     columnEvolutionCheck: <your-new-frequency>

   Replace your-new-frequency with the time you would like between column detection jobs. For example use */30 * * * * for the queries to run every 30 minutes.

3. Click Save.