How to Configure Table Keys

TL;DR

In Settings → Table Keys, define the named keys that tables share. Each key is just a name and a description. You map it to a table's column during Table registration, where a Constraint setting marks how that column behaves as a key.

Admin guide

This page is for administrators with write access to Table Keys.

Configure a table key

A table key is a shared name that tables map their columns to, so the platform knows which tables join on the same identifier. It’s intentionally minimal, just a name and a description.

Go to Settings → Table Keys and click + New Table Key:

• Name * - a valid variable name (letters, numbers, underscores), for example application_id or member_id.
• Description * - what the key represents and which columns it maps to across tables.

Click Save. A table key can be deleted only if no table maps to it.

How it’s used

When you register a table, each column you want to use as a key gets two settings:

• Key - which configured table key the column maps to. Ordinary data columns are left blank.
• Constraint - how the column behaves as a key: Primary for the table’s main identifier (primary tables only), Unique if its values never repeat, or leave it blank.

The table key is just the shared name; whether a column is primary or unique is set on the column, table by table. For example, map the app_id column of loan_applications to the application_id key with Primary. Another table carrying an application identifier maps its own column to the same key, and the platform then knows the two tables join on it.

What’s next

• Register a Table and map its columns to these keys.