Skip to main content

Config Database: connections and syncs

connection​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the connection.
namespace_definitionENUMDefines how the namespace is set.
namespace_formatVARCHARFormat for the namespace when using custom.
prefixVARCHARPrefix added to destination tables.
source_idUUIDForeign key referencing actor(id).
destination_idUUIDForeign key referencing actor(id).
nameVARCHARName of the connection.
catalogJSONBJSON blob defining the connection catalog.
statusENUMConnection status (active, inactive, etc.).
scheduleJSONBJSON blob defining the connection schedule.
manualBOOLEANIndicates if the connection runs manually.
resource_requirementsJSONBResource requirements for the connection.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: source_id references actor(id)
  • Foreign Key: destination_id references actor(id)
  • Index: connection_source_id_idx on (source_id)
  • Index: connection_destination_id_idx on (destination_id)

connection_operation​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the record.
connection_idUUIDForeign key referencing connection(id).
operation_idUUIDForeign key referencing operation(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id, connection_id, operation_id)
  • Foreign Key: connection_id references connection(id)
  • Foreign Key: operation_id references operation(id)
  • Index: connection_operation_connection_id_idx on (connection_id)

connection_tag​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the record.
tag_idUUIDForeign key referencing tag(id).
connection_idUUIDForeign key referencing connection(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: tag_id references tag(id)
  • Foreign Key: connection_id references connection(id)
  • Unique Constraint: (tag_id, connection_id)

connection_timeline_event​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the event.
connection_idUUIDForeign key referencing connection(id).
user_idUUIDForeign key referencing user(id).
event_typeVARCHARType of event that occurred.
summaryJSONBJSON blob containing event details.
created_atTIMESTAMPTimestamp when the event occurred.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)
  • Foreign Key: user_id references user(id)
  • Index: idx_connection_timeline_connection_id on (connection_id, created_at, event_type)

notification_configuration​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the notification configuration.
enabledBOOLEANIndicates if the notification is enabled.
notification_typeENUMType of notification.
connection_idUUIDForeign key referencing connection(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)

operation​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the operation.
workspace_idUUIDForeign key referencing workspace(id).
nameVARCHARName of the operation.
operator_typeENUMType of operator (dbt, normalization, etc.).
operator_normalizationJSONBJSON blob defining normalization settings.
operator_dbtJSONBJSON blob defining dbt settings.
tombstoneBOOLEANIndicates if the operation is deleted.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
operator_webhookJSONBJSON blob defining webhook settings.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: workspace_id references workspace(id)

schema_management​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for schema management.
connection_idUUIDForeign key referencing connection(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
auto_propagation_statusENUMStatus of automatic schema propagation.
backfill_preferenceENUMUser preference for backfill operations.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)
  • Index: connection_idx on (connection_id)

state​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the state record.
connection_idUUIDForeign key referencing connection(id).
stateJSONBJSON blob storing the state information.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
stream_nameTEXTName of the stream associated with this state.
namespaceTEXTNamespace of the stream.
typeENUMType of state (STREAM, GLOBAL, LEGACY).

Indexes and Constraints​

  • Primary Key: (id, connection_id)
  • Foreign Key: connection_id references connection(id)
  • Unique Constraint: (connection_id, stream_name, namespace)

stream_generation​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the stream generation record.
connection_idUUIDForeign key referencing connection(id).
stream_nameVARCHARName of the stream.
stream_namespaceVARCHARNamespace of the stream.
generation_idBIGINTIdentifier for the stream generation.
start_job_idBIGINTJob ID that started this stream generation.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)
  • Index: stream_generation_connection_id_stream_name_generation_id_idx on (connection_id, stream_name, generation_id)
  • Index: stream_generation_connection_id_stream_name_stream_namespace_idx on (connection_id, stream_name, stream_namespace, generation_id)

stream_refreshes​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the stream refresh record.
connection_idUUIDForeign key referencing connection(id).
stream_nameVARCHARName of the stream.
stream_namespaceVARCHARNamespace of the stream.
created_atTIMESTAMPTimestamp when the record was created.
refresh_typeENUMType of refresh operation performed.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)
  • Index: stream_refreshes_connection_id_idx on (connection_id)
  • Index: stream_refreshes_connection_id_stream_name_idx on (connection_id, stream_name)
  • Index: stream_refreshes_connection_id_stream_name_stream_namespace_idx on (connection_id, stream_name, stream_namespace)

stream_reset​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the stream reset record.
connection_idUUIDForeign key referencing connection(id).
stream_namespaceTEXTNamespace of the stream.
stream_nameTEXTName of the stream being reset.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: connection_id references connection(id)
  • Unique Constraint: (connection_id, stream_name, stream_namespace)
  • Index: connection_id_stream_name_namespace_idx on (connection_id, stream_name, stream_namespace)

tag​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the tag.
workspace_idUUIDForeign key referencing workspace(id).
nameVARCHARName of the tag.
colorCHAR(6)Hexadecimal color code for the tag.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: workspace_id references workspace(id)
  • Unique Constraint: (name, workspace_id)
  • Index: tag_workspace_id_idx on (workspace_id)

workload​

Column NameDatatypeDescription
idVARCHARPrimary key. Unique identifier for the workload.
dataplane_idVARCHARIdentifier for the dataplane handling this workload.
statusENUMStatus of the workload (pending, running, etc.).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
last_heartbeat_atTIMESTAMPTimestamp of the last heartbeat received.
input_payloadTEXTPayload associated with the workload.
log_pathTEXTPath to logs for the workload.
geographyVARCHARGeography associated with the workload.
mutex_keyVARCHARMutex key used for workload execution control.
typeENUMType of workload being processed.
termination_sourceVARCHARSource that terminated the workload.
termination_reasonTEXTReason for workload termination.
auto_idUUIDAuto-generated identifier for the workload.
deadlineTIMESTAMPDeadline for workload execution.
signal_inputTEXTSignal input for the workload.
dataplane_groupVARCHARDataplane group associated with the workload.
priorityINTPriority level of the workload.

Indexes and Constraints​

  • Primary Key: (id)
  • Index: active_workload_by_mutex_idx on (mutex_key) where (status is active)
  • Index: workload_deadline_idx on (deadline) where (deadline IS NOT NULL)
  • Index: workload_mutex_idx on (mutex_key)
  • Index: workload_status_idx on (status)

workload_label​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the label.
workload_idVARCHARForeign key referencing workload(id).
keyVARCHARLabel key.
valueVARCHARLabel value.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: workload_id references workload(id)
  • Unique Constraint: (workload_id, key)
  • Index: workload_label_workload_id_idx on (workload_id)