Skip to main content

Multi Table Metadata

Visual metadata editor​

The editor displays tables as nodes and relationships as edges, making it easy to view and manage complex multi-table metadata.

Your progress is saved as a draft when you close the metadata editor. Resume editing by clicking the Resume Metadata button. While editing, you can discard changes and reset to the last published or last generated state. The Re-generate metadata button allows you to recalculate metadata for all tables currently in the editor. To submit metadata, click the Submit metadata button.

Nodes (tables)​

Each node represents a table. Hovering over or selecting a node highlights all its entity relationships.

Max Subject References​

  • The maximum number of rows that can be treated as a single entity.
  • Max subject references is not editable.
  • Max subject references for all tables is recalculated automatically when you:
    • Add a foreign key
    • Remove a foreign key
    • Change the min or max foreign key references

Privacy status​

  • Privacy status determines whether a table represents sensitive data.
  • AGENT supports two privacy statuses: Public and Private.

Public

Data does not represent sensitive data. Don’t mark Public if rows describe people/events or contain linkable IDs or PII.

Private

Data in a Private table represents sensitive data (people or their events).
Note

Privacy status modification is restricted for subject tables; they must remain private.

Privacy status inheritance validation

A Public table cannot inherit from a Private table.

Recalculate Table Bounds​

  • Click the Recalculate Table Bounds button to automatically recalculate bounds for the table. This will open a pop-up window where you can configure options such as partial subject level differential privacy and categorical data detection parameters.
Learn More About Subject Level Privacy Implementation

To learn more about how we implement Subject Level Differential Privacy, see Subject Level Privacy

Edit primary key​

  • Primary key for a table is editable through checkboxes rendered on far-left of each row(each row represents a column in the table)
  • For a column to be eligible for primary key, it should be unique and non-nullable.
Tip

Any edges invalidated due to editing primary keys will be highlighted in red.

Preview​

  • Preview all columns of the table.
  • To preview a table's data, click the Ellipsis menu on top-right of the node and select Preview option to open a pop-up window showing the first 5 rows.

Edit Column Selection​

  • Edit column selection for a table to included in metadata.
1
Click the Ellipsis menu on top-right of the node.
2
Select Edit Column Selection option.
3
Check or uncheck columns in the pop-up window.
4
Click Okay to save updated column selection.

Remove table​

  • Click the Ellipsis menu on top-right of the node and select Delete Table option, or select the node and press the delete key.
Note

The remove node option is only available when there is more than one table in the editor.

Subject table deletion

Subject table cannot be removed. Removing Subject Table throws a warning and prompts metadata regeneration to assign a new Subject Table.

Columns​

Each row in a node represents a column

Tip

For more information on edges, see Edges

Edit Column Semantic Type​
  • Semantic type defines how synthetic data is generated for a column.
  • Semantic type can be updated through Semantic Type dropdown associated with each column.
  • Supported semantic types include:
1
LLM Generation Prompt

Represents a prompt for generating similar data using an LLM.

2
Random String

Represents a random string of no specific semantic type.

3
Regex

Represents a regular expression that can generate data of similar type.

4
Faker

Faker functions

Note

Only string Metadata type supports Semantic types.

Note

For LLM Generation Prompt and Random String semantic types, auto-generated prompts or regex patterns require user approval before submission to ensure they do not disclose sensitive information.

Toggle a columns metadata between categorical and non-categorical​
  • Represents whether a column has categorical or non-categorical metadata.
  • Can be toggled through categorical checkbox associated with each column.
Note

Categorical checkbox is disabled for bool and byte metadata types. These metadata types do not support categorical metadata.

Edit metadata for a column​
1
Locate the node (table) and row containing the column you want to edit.
2
Edit the metadata inputs directly in the row. Required fields are marked with a red asterisk.
3
To add more attributes, click Add Additional Attributes.
4
Hover over the ? icon for descriptions of each field.
Recalculate Column Bounds​
  • Recalculate the metadata bounds for the column.
  • Click the Recalculate bounds button to automatically recalculate bounds for the column. This will open a pop-up window where you can configure options such as partial subject level differential privacy and categorical data detection parameters.
Learn More About Subject Level Privacy Implementation

To learn more about how we implement Subject Level Differential Privacy, see Subject Level Privacy

Note

To recalculate categorical bounds, ensure the Categorical checkbox is checked. To recalculate non-categorical bounds, leave it unchecked.

Edges​

Edges represent entity relationships between columns. The editor supports one-to-one and one-to-many relationships, distinguished by their markers.

One-to-one

An entity in one table is related to a single entity in another table.

One-to-many

An entity in one table can be related to multiple entities in another table. The maximum number of references allowed is shown as a label near the target handle and can be edited by clicking the label.

Create a new edge (entity relation) between two columns:​

1
Hover over the handle of the source column (must be a primary key).
2
Drag from the handle to the handle of the target column in another node (must have the same metadata type).
3
If valid, the edge will be created and shown in the editor.
Tip

When creating an edge, the target handle is highlighted green if valid, red if invalid. Edges are only created if valid.

Edge validation​

Only single-column primary keys can initiate edges. Foreign keys from composite primary keys are not supported.

Connections are only allowed between columns of the same Metadata Type and from different tables. Self-referencing relationships are not supported.

When creating an edge, the target handle is highlighted green if valid, red if invalid. Edges are only created if valid. Invalid edges are highlighted in red.

Editing edges​

  • Select or hover over an edge to reveal its menu button. Click to open edit options:
1
Change entity relation type

Convert between one-to-one and one-to-many.

note

When converting to one-to-many, you must specify the minimum and maximum number of references.

2
Edit maximum references

Click the label near the target handle to change the value.

3
Delete edge

Click delete in the menu or select the edge and press delete.

4
Resize edge

Drag from the menu button to adjust the edge.

See all connected edges of a node​

  • Hover over or click on a node to highlight all of its connected edges.

Other Actions​

1

Recalculate or regenerate metadata for all tables

Recalculate or regenerate metadata for all tables​

Click the Re-generate metadata button in the editor toolbar.

2

Discard changes and reset

Discard changes and reset​

While editing, use the reset option to revert to the last published or last generated state.

3

Resume editing a draft

Resume editing a draft​

If you close the editor, your progress is saved as a draft. Click Resume Metadata to continue where you left off.