connection_data.proto

path mgmt/v1alpha1/connection_data.proto

package mgmt.v1alpha1

---

Messages

AwsS3SchemaConfig

Name	Type	Description
job_id	string
job_run_id	string

AwsS3StreamConfig

Name	Type	Description
job_id	string
job_run_id	string

ConnectionSchemaConfig

Name	Type	Description
pg_config	PostgresSchemaConfig
aws_s3_config	AwsS3SchemaConfig
mysql_config	MysqlSchemaConfig

ConnectionStreamConfig

Name	Type	Description
pg_config	PostgresStreamConfig
aws_s3_config	AwsS3StreamConfig
mysql_config	MysqlStreamConfig

DatabaseColumn

Name	Type	Description
schema	string	The database schema. Ex: public
table	string	The name of the table in the schema
column	string	The name of the column
data_type	string	The datatype of the column

ForeignConstraintTables

Name	Type	Description
tables	repeated string

GetConnectionDataStreamRequest

Name	Type	Description
connection_id	string
stream_config	ConnectionStreamConfig
schema	string
table	string

GetConnectionDataStreamResponse

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

Name	Type	Description
row	repeated GetConnectionDataStreamResponse.RowEntry	A map of column name to the bytes value of the data that was found for that column and row

GetConnectionDataStreamResponse.RowEntry

Name	Type	Description
key	string
value	bytes

GetConnectionForeignConstraintsRequest

Name	Type	Description
connection_id	string

GetConnectionForeignConstraintsResponse

Dependency constraints for a specific table

Name	Type	Description
table_constraints	repeated GetConnectionForeignConstraintsResponse.TableConstraintsEntry	the key here is <schema>.<table> and the list of tables that it depends on, also `<schema>.<table>` format.

GetConnectionForeignConstraintsResponse.TableConstraintsEntry

Name	Type	Description
key	string
value	ForeignConstraintTables

GetConnectionInitStatementsRequest

Name	Type	Description
connection_id	string
options	InitStatementOptions

GetConnectionInitStatementsResponse

Init statement for a specific table

Name	Type	Description
table_init_statements	repeated GetConnectionInitStatementsResponse.TableInitStatementsEntry	the key here is <schema>.<table> and value is the table init statement.

GetConnectionInitStatementsResponse.TableInitStatementsEntry

Name	Type	Description
key	string
value	string

GetConnectionSchemaRequest

Name	Type	Description
connection_id	string
schema_config	ConnectionSchemaConfig

GetConnectionSchemaResponse

Name	Type	Description
schemas	repeated DatabaseColumn

InitStatementOptions

Name	Type	Description
init_schema	bool
truncate_before_insert	bool
truncate_cascade	bool

MysqlSchemaConfig

Name	Type	Description

MysqlStreamConfig

Name	Type	Description

PostgresSchemaConfig

Name	Type	Description

PostgresStreamConfig

Name	Type	Description

---

Services

ConnectionDataService

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

GetConnectionDataStream

Method	GetConnectionDataStream
Request	GetConnectionDataStreamRequest
Response	GetConnectionDataStreamResponse stream
Description	Streaming endpoint that will stream the data available from the Connection to the client. Used primarily by the CLI sync command.

GetConnectionSchema

Method	GetConnectionSchema
Request	GetConnectionSchemaRequest
Response	GetConnectionSchemaResponse
Description	Returns the schema for a specific connection. Used mostly for SQL-based connections

GetConnectionForeignConstraints

Method	GetConnectionForeignConstraints
Request	GetConnectionForeignConstraintsRequest
Response	GetConnectionForeignConstraintsResponse
Description	For 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.

GetConnectionInitStatements

Method	GetConnectionInitStatements
Request	GetConnectionInitStatementsRequest
Response	GetConnectionInitStatementsResponse
Description	For 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.

---