Skip to main content

Managing Table Indices (2.9)

This page explains how to add custom indices to tables in InterSystems® Data Fabric Studio™ and explains how the system automatically builds indices as needed.

Adding an Index to a Staging Table

Within the definition of a recipe, you can add custom indices to the generated staging table. To do so:

  1. Click the Recipes icon in the application menu.

  2. If the recipe is in a group, expand that group.

  3. Click the recipe name.

  4. At the bottom of the page, see the list in Indices and Staging Table Details.

    This section shows one row for each data source used in the recipe.

  5. Click the row for a given data source. The page then lists the generated staging tables associated with this data source.

  6. Click a table name in this list. The right side of the page then provides information about the indices on the table, along with details about the fields in this table.

  7. For Index Name, type a unique index name.

  8. For Property 1, select the field to index.

    To create an index on multiple fields, repeat with Property 2 and so on.

  9. Because there is now a new index, the Build Indices button is enabled. You can click that to immediately start building this index for any existing data in this staging table.

    However, even if you do not click Build Indices, the system automatically schedules a background task that will build this index for any existing data in this staging table. The system will also automatically index new data.

Adding an Index to a Snapshot

Within the definition of a snapshot, you can add custom indices to the generated snapshot table. To do so:

  1. Click the Snapshot icon in the application menu.

  2. Click the snapshot you want to edit.

  3. Click Edit.

  4. Click New Index.

  5. For Index Name, type a unique index name.

  6. For Property 1, select the field to index.

    To create an index on multiple fields, repeat with Property 2 and so on.

When you add an index, the system automatically detects this change and schedules a background task that will build this index for any existing data in this table. The system will also automatically index new data.

Index Build Pending Message

Sometimes the process of building an index can be time-consuming and it is necessary to wait before performing recipe runs or snapshots that use the table being indexed. In such a case, the system displays a message indicating that it is in the process of building a required index. The system prevents you from prematurely using the data.

See Also

FeedbackOpens in a new tab