Skip to main content

connection_data.proto

path mgmt/v1alpha1/connection_data.proto

package mgmt.v1alpha1


Messages

AwsS3SchemaConfig

NameTypeDescription
job_idstring
job_run_idstring

AwsS3StreamConfig

NameTypeDescription
job_idstring
job_run_idstring

ConnectionSchemaConfig

NameTypeDescription
pg_configPostgresSchemaConfig
aws_s3_configAwsS3SchemaConfig
mysql_configMysqlSchemaConfig

ConnectionStreamConfig

NameTypeDescription
pg_configPostgresStreamConfig
aws_s3_configAwsS3StreamConfig
mysql_configMysqlStreamConfig

DatabaseColumn

NameTypeDescription
schemastringThe database schema. Ex: public
tablestringThe name of the table in the schema
columnstringThe name of the column
data_typestringThe datatype of the column
is_nullablestringThe isNullable Flag of the column
column_defaultoptional stringThe default value of the column if available

DatabaseTable

NameTypeDescription
schemastring
tablestring

ForeignConstraint

NameTypeDescription
columnstring
is_nullablebool
foreign_keyForeignKey

ForeignConstraintTables

NameTypeDescription
constraintsrepeated ForeignConstraint

ForeignKey

NameTypeDescription
tablestring
columnstring

GetAiGeneratedDataRequest

NameTypeDescription
ai_connection_idstring
countint64
model_namestring
user_promptoptional string
data_connection_idstring
tableDatabaseTable

GetAiGeneratedDataResponse

NameTypeDescription
recordsrepeated google.protobuf.StructA list of generated records

GetConnectionDataStreamRequest

NameTypeDescription
connection_idstring
stream_configConnectionStreamConfig
schemastring
tablestring

GetConnectionDataStreamResponse

Each stream response is a single row in the requested schema and table

NameTypeDescription
rowrepeated GetConnectionDataStreamResponse.RowEntryA map of column name to the bytes value of the data that was found for that column and row

GetConnectionDataStreamResponse.RowEntry

NameTypeDescription
keystring
valuebytes

GetConnectionForeignConstraintsRequest

NameTypeDescription
connection_idstring

GetConnectionForeignConstraintsResponse

Dependency constraints for a specific table

NameTypeDescription
table_constraintsrepeated GetConnectionForeignConstraintsResponse.TableConstraintsEntrythe key here is <schema>.<table> and the list of tables that it depends on, also `<schema>.<table>` format.

GetConnectionForeignConstraintsResponse.TableConstraintsEntry

NameTypeDescription
keystring
valueForeignConstraintTables

GetConnectionInitStatementsRequest

NameTypeDescription
connection_idstring
optionsInitStatementOptions

GetConnectionInitStatementsResponse

Init statement for a specific table

NameTypeDescription
table_init_statementsrepeated GetConnectionInitStatementsResponse.TableInitStatementsEntrythe key here is <schema>.<table> and value is the table init statement.
table_truncate_statementsrepeated GetConnectionInitStatementsResponse.TableTruncateStatementsEntrythe key here is <schema>.<table> and value is the table truncate statement.

GetConnectionInitStatementsResponse.TableInitStatementsEntry

NameTypeDescription
keystring
valuestring

GetConnectionInitStatementsResponse.TableTruncateStatementsEntry

NameTypeDescription
keystring
valuestring

GetConnectionPrimaryConstraintsRequest

Primary constraints for a specific table

NameTypeDescription
connection_idstring

GetConnectionPrimaryConstraintsResponse

NameTypeDescription
table_constraintsrepeated GetConnectionPrimaryConstraintsResponse.TableConstraintsEntrythe key here is <schema>.<table> and value is the primary constraint

GetConnectionPrimaryConstraintsResponse.TableConstraintsEntry

NameTypeDescription
keystring
valuePrimaryConstraint

GetConnectionSchemaRequest

NameTypeDescription
connection_idstring
schema_configConnectionSchemaConfig

GetConnectionSchemaResponse

NameTypeDescription
schemasrepeated DatabaseColumn

GetConnectionUniqueConstraintsRequest

Unique constraints for a specific table

NameTypeDescription
connection_idstring

GetConnectionUniqueConstraintsResponse

NameTypeDescription
table_constraintsrepeated GetConnectionUniqueConstraintsResponse.TableConstraintsEntrythe key here is <schema>.<table> and value is the unique constraint

GetConnectionUniqueConstraintsResponse.TableConstraintsEntry

NameTypeDescription
keystring
valueUniqueConstraint

InitStatementOptions

NameTypeDescription
init_schemabool
truncate_before_insertbool
truncate_cascadebool

MysqlSchemaConfig

NameTypeDescription

MysqlStreamConfig

NameTypeDescription

PostgresSchemaConfig

NameTypeDescription

PostgresStreamConfig

NameTypeDescription

PrimaryConstraint

NameTypeDescription
columnsrepeated string

UniqueConstraint

NameTypeDescription
columnsrepeated string

Services

ConnectionDataService

Service for managing connection data. This is used in handle data from a connection

GetConnectionDataStream

MethodGetConnectionDataStream
RequestGetConnectionDataStreamRequest
ResponseGetConnectionDataStreamResponse stream
DescriptionStreaming endpoint that will stream the data available from the Connection to the client. Used primarily by the CLI sync command.

GetConnectionSchema

MethodGetConnectionSchema
RequestGetConnectionSchemaRequest
ResponseGetConnectionSchemaResponse
DescriptionReturns the schema for a specific connection. Used mostly for SQL-based connections

GetConnectionForeignConstraints

MethodGetConnectionForeignConstraints
RequestGetConnectionForeignConstraintsRequest
ResponseGetConnectionForeignConstraintsResponse
DescriptionFor a specific connection, returns the foreign key constraints. Mostly useful for SQL-based Connections. Used primarily by the CLI sync command to determine stream order.

GetConnectionPrimaryConstraints

MethodGetConnectionPrimaryConstraints
RequestGetConnectionPrimaryConstraintsRequest
ResponseGetConnectionPrimaryConstraintsResponse
DescriptionFor a specific connection, returns the primary key constraints. Mostly useful for SQL-based Connections. Used primarily by the CLI sync command to determine stream order.

GetConnectionInitStatements

MethodGetConnectionInitStatements
RequestGetConnectionInitStatementsRequest
ResponseGetConnectionInitStatementsResponse
DescriptionFor a specific connection, returns the init table statements. Mostly useful for SQL-based Connections. Used primarily by the CLI sync command to create table schema init statement.

GetConnectionUniqueConstraints

MethodGetConnectionUniqueConstraints
RequestGetConnectionUniqueConstraintsRequest
ResponseGetConnectionUniqueConstraintsResponse
DescriptionFor a specific connection, returns the unique constraints. Mostly useful for SQL-based connections.

GetAiGeneratedData

MethodGetAiGeneratedData
RequestGetAiGeneratedDataRequest
ResponseGetAiGeneratedDataResponse
DescriptionQuery an AI connection by providing the necessary values. Typically used for generating preview data