Skip to main content

Config Database: connectors and definitions

active_declarative_manifest​

Column NameDatatypeDescription
actor_definition_idUUIDPrimary key. References the actor_definition table.
versionBIGINTVersion of the manifest.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last updated.

Indexes and Constraints​

  • Primary Key: (actor_definition_id)
  • Foreign Key: actor_definition_id references actor_definition(id)

actor​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the actor.
workspace_idUUIDForeign key referencing the workspace table.
actor_definition_idUUIDForeign key referencing actor_definition table.
nameVARCHAR(256)Name of the actor.
configurationJSONBConfiguration JSON blob specific to the actor.
actor_typeENUMIndicates whether the actor is a source or destination.
tombstoneBOOLEANSoft delete flag.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last updated.
resource_requirementsJSONBDefines resource requirements for the actor.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: workspace_id references workspace(id)
  • Foreign Key: actor_definition_id references actor_definition(id)
  • Index: actor_definition_id_idx on (actor_definition_id)
  • Index: actor_workspace_id_idx on (workspace_id)

actor_catalog​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the catalog.
catalogJSONBJSON representation of the catalog.
catalog_hashVARCHAR(32)Hash of the catalog for quick comparison.
created_atTIMESTAMPTimestamp when the record was created.
modified_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Index: actor_catalog_catalog_hash_id_idx on (catalog_hash)

actor_catalog_fetch_event​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the fetch event.
actor_catalog_idUUIDForeign key referencing actor_catalog(id).
actor_idUUIDForeign key referencing actor(id).
config_hashVARCHAR(32)Hash of the configuration at the time of the fetch.
actor_versionVARCHAR(256)Version of the actor definition when the fetch occurred.
created_atTIMESTAMPTimestamp when the record was created.
modified_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: actor_catalog_id references actor_catalog(id)
  • Foreign Key: actor_id references actor(id)
  • Index: actor_catalog_fetch_event_actor_catalog_id_idx on (actor_catalog_id)
  • Index: actor_catalog_fetch_event_actor_id_idx on (actor_id)

actor_definition​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the actor definition.
nameVARCHAR(256)Name of the connector.
iconVARCHAR(256)Icon for the connector.
actor_typeENUMIndicates whether the actor is a source or destination.
source_typeENUMSource category (e.g., API, Database).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
tombstoneBOOLEANSoft delete flag.
resource_requirementsJSONBDefines default resource requirements.
publicBOOLEANDetermines if the definition is publicly available.
customBOOLEANIndicates if the connector is user-defined.
max_seconds_between_messagesINTMaximum allowed seconds between messages.
default_version_idUUIDForeign key referencing actor_definition_version(id).
icon_urlVARCHAR(256)URL of the icon image.
metricsJSONBMetadata about the connector.
enterpriseBOOLEANWhether the connector is part of the enterprise edition.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: default_version_id references actor_definition_version(id)

actor_definition_breaking_change​

Column NameDatatypeDescription
actor_definition_idUUIDForeign key referencing actor_definition(id).
versionVARCHAR(256)Version of the breaking change.
migration_documentation_urlVARCHAR(256)URL linking to migration documentation.
upgrade_deadlineDATEDeadline for upgrading to the new version.
messageTEXTDescription of the breaking change.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
scoped_impactJSONBJSON object describing the impact scope.
deadline_actionVARCHAR(256)Action required before the deadline.

Indexes and Constraints​

  • Primary Key: (actor_definition_id, version)
  • Foreign Key: actor_definition_id references actor_definition(id)

actor_definition_config_injection​

Column NameDatatypeDescription
json_to_injectJSONBJSON configuration to inject.
injection_pathVARCHARPath where the injection applies.
actor_definition_idUUIDForeign key referencing actor_definition(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.

Indexes and Constraints​

  • Primary Key: (actor_definition_id, injection_path)
  • Foreign Key: actor_definition_id references actor_definition(id)

actor_definition_version​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the version.
actor_definition_idUUIDForeign key referencing actor_definition(id).
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
documentation_urlVARCHAR(256)Documentation URL for this version.
docker_repositoryVARCHAR(256)Docker repository name.
docker_image_tagVARCHAR(256)Docker image tag for this version.
specJSONBSpecification JSON blob.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: actor_definition_id references actor_definition(id)
  • Unique Constraint: actor_definition_id, docker_image_tag

actor_definition_workspace_grant​

Column NameDatatypeDescription
actor_definition_idUUIDForeign key referencing actor_definition(id).
workspace_idUUIDForeign key referencing workspace(id).
scope_idUUIDScope identifier.

Indexes and Constraints​

  • Unique Constraint: actor_definition_id, scope_id, scope_type

actor_oauth_parameter​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier.
workspace_idUUIDForeign key referencing workspace(id).
actor_definition_idUUIDForeign key referencing actor_definition(id).

Indexes and Constraints​

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

connector_builder_project​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the project.
workspace_idUUIDForeign key referencing workspace(id).
nameVARCHARName of the connector project.
manifest_draftJSONBJSON draft of the connector manifest.
actor_definition_idUUIDForeign key referencing actor_definition(id).
tombstoneBOOLEANIndicates if the project is deleted.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
testing_valuesJSONBJSON containing test values for the connector.
base_actor_definition_version_idUUIDForeign key referencing actor_definition_version(id).
contribution_pull_request_urlVARCHARURL for the contribution PR.
contribution_actor_definition_idUUIDForeign key referencing actor_definition(id).
components_file_contentTEXTRaw content of component files.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: workspace_id references workspace(id)
  • Foreign Key: actor_definition_id references actor_definition(id)
  • Foreign Key: base_actor_definition_version_id references actor_definition_version(id)
  • Foreign Key: contribution_actor_definition_id references actor_definition(id)
  • Index: connector_builder_project_workspace_idx on (workspace_id)

connector_rollout​

Column NameDatatypeDescription
idUUIDPrimary key. Unique identifier for the rollout.
actor_definition_idUUIDForeign key referencing actor_definition(id).
release_candidate_version_idUUIDForeign key referencing actor_definition_version(id).
initial_version_idUUIDForeign key referencing actor_definition_version(id).
stateVARCHARCurrent state of the rollout.
initial_rollout_pctINTInitial rollout percentage.
current_target_rollout_pctINTCurrent target rollout percentage.
final_target_rollout_pctINTFinal target rollout percentage.
has_breaking_changesBOOLEANIndicates if the rollout has breaking changes.
max_step_wait_time_minsINTMaximum wait time between rollout steps.
updated_byUUIDForeign key referencing user(id).
created_atTIMESTAMPTimestamp when the rollout started.
updated_atTIMESTAMPTimestamp when the record was last modified.
completed_atTIMESTAMPTimestamp when the rollout was completed.
expires_atTIMESTAMPTimestamp when the rollout expires.
error_msgVARCHARError message if the rollout failed.
failed_reasonVARCHARReason for failure.
rollout_strategyVARCHARStrategy used for the rollout.
workflow_run_idVARCHARWorkflow run identifier.
paused_reasonVARCHARReason for pausing the rollout.

Indexes and Constraints​

  • Primary Key: (id)
  • Foreign Key: actor_definition_id references actor_definition(id)
  • Foreign Key: release_candidate_version_id references actor_definition_version(id)
  • Foreign Key: initial_version_id references actor_definition_version(id)
  • Foreign Key: updated_by references user(id)
  • Unique Index: actor_definition_id_state_unique_idx on actor_definition_id
    • Condition: (state in ['errored', 'finalizing', 'in_progress', 'initialized', 'paused', 'workflow_started'])

declarative_manifest​

Column NameDatatypeDescription
actor_definition_idUUIDForeign key referencing actor_definition(id).
descriptionVARCHARDescription of the manifest.
manifestJSONBJSON representation of the manifest.
specJSONBJSON specification for the manifest.
versionBIGINTVersion number of the manifest.
created_atTIMESTAMPTimestamp when the record was created.

Indexes and Constraints​

  • Primary Key: (actor_definition_id, version)

declarative_manifest_image_version​

Column NameDatatypeDescription
major_versionINTPrimary key. Major version number.
image_versionVARCHARVersion of the image.
created_atTIMESTAMPTimestamp when the record was created.
updated_atTIMESTAMPTimestamp when the record was last modified.
image_shaVARCHARSHA checksum of the image.

Indexes and Constraints​

  • Primary Key: (major_version)