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
mongo_config	MongoSchemaConfig
gcp_cloudstorage_config	GcpCloudStorageSchemaConfig

ConnectionStreamConfig

Name	Type	Description
pg_config	PostgresStreamConfig
aws_s3_config	AwsS3StreamConfig
mysql_config	MysqlStreamConfig
gcp_cloudstorage_config	GcpCloudStorageStreamConfig

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
is_nullable	string	The isNullable Flag of the column
column_default	optional string	The default value of the column if available
generated_type	optional string	Populated if the column is generated. The value is the type of generated column it is. For example, postgres is 's' for stored May be other values in the future, or other DB providers may use a different value types.
identity_generation	optional string	Populated if the column is an identity. The value is the type of the identity column it is. For example, postgres is 'd' for generated by default, or 'a' for generated always.

DatabaseTable

Name	Type	Description
schema	string
table	string

ForeignConstraint

Name	Type	Description
column	string	@deprecated - use columns
is_nullable	bool	@deprecated - use not_nullable
foreign_key	ForeignKey
columns	repeated string
not_nullable	repeated bool

ForeignConstraintTables

Name	Type	Description
constraints	repeated ForeignConstraint

ForeignKey

Name	Type	Description
table	string
column	string	@deprecated - use columns
columns	repeated string

GcpCloudStorageSchemaConfig

Name	Type	Description
job_id	string
job_run_id	string

GcpCloudStorageStreamConfig

Name	Type	Description
job_id	string
job_run_id	string

GetAiGeneratedDataRequest

Name	Type	Description
ai_connection_id	string
count	int64
model_name	string
user_prompt	optional string
data_connection_id	string
table	DatabaseTable

GetAiGeneratedDataResponse

Name	Type	Description
records	repeated google.protobuf.Struct	A list of generated records

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.
table_truncate_statements	repeated GetConnectionInitStatementsResponse.TableTruncateStatementsEntry	the key here is <schema>.<table> and value is the table truncate statement.
schema_init_statements	repeated SchemaInitStatements

GetConnectionInitStatementsResponse.TableInitStatementsEntry

Name	Type	Description
key	string
value	string

GetConnectionInitStatementsResponse.TableTruncateStatementsEntry

Name	Type	Description
key	string
value	string

GetConnectionPrimaryConstraintsRequest

Primary constraints for a specific table

Name	Type	Description
connection_id	string

GetConnectionPrimaryConstraintsResponse

Name	Type	Description
table_constraints	repeated GetConnectionPrimaryConstraintsResponse.TableConstraintsEntry	the key here is <schema>.<table> and value is the primary constraint

GetConnectionPrimaryConstraintsResponse.TableConstraintsEntry

Name	Type	Description
key	string
value	PrimaryConstraint

GetConnectionSchemaRequest

Name	Type	Description
connection_id	string
schema_config	ConnectionSchemaConfig

GetConnectionSchemaResponse

Name	Type	Description
schemas	repeated DatabaseColumn

GetConnectionTableConstraintsRequest

Name	Type	Description
connection_id	string

GetConnectionTableConstraintsResponse

Name	Type	Description
foreign_key_constraints	repeated GetConnectionTableConstraintsResponse.ForeignKeyConstraintsEntry	the key here is <schema>.<table> and the list of tables that it depends on, also `<schema>.<table>` format.
primary_key_constraints	repeated GetConnectionTableConstraintsResponse.PrimaryKeyConstraintsEntry	the key here is <schema>.<table> and value is the primary constraint
unique_constraints	repeated GetConnectionTableConstraintsResponse.UniqueConstraintsEntry	the key here is <schema>.<table> and value is the unique constraint

GetConnectionTableConstraintsResponse.ForeignKeyConstraintsEntry

Name	Type	Description
key	string
value	ForeignConstraintTables

GetConnectionTableConstraintsResponse.PrimaryKeyConstraintsEntry

Name	Type	Description
key	string
value	PrimaryConstraint

GetConnectionTableConstraintsResponse.UniqueConstraintsEntry

Name	Type	Description
key	string
value	UniqueConstraints

GetConnectionUniqueConstraintsRequest

Unique constraints for a specific table

Name	Type	Description
connection_id	string

GetConnectionUniqueConstraintsResponse

Name	Type	Description
table_constraints	repeated GetConnectionUniqueConstraintsResponse.TableConstraintsEntry	the key here is <schema>.<table> and value is the unique constraint

GetConnectionUniqueConstraintsResponse.TableConstraintsEntry

Name	Type	Description
key	string
value	UniqueConstraint

GetTableRowCountRequest

Name	Type	Description
connection_id	string
schema	string
table	string
where_clause	optional string

GetTableRowCountResponse

Name	Type	Description
count	int64

InitStatementOptions

Name	Type	Description
init_schema	bool
truncate_before_insert	bool
truncate_cascade	bool

MongoSchemaConfig

Name	Type	Description

MysqlSchemaConfig

Name	Type	Description

MysqlStreamConfig

Name	Type	Description

PostgresSchemaConfig

Name	Type	Description

PostgresStreamConfig

Name	Type	Description

PrimaryConstraint

Name	Type	Description
columns	repeated string

SchemaInitStatements

Name	Type	Description
label	string
statements	repeated string

UniqueConstraint

Name	Type	Description
columns	repeated string

UniqueConstraints

Name	Type	Description
constraints	repeated UniqueConstraint

---

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

GetConnectionTableConstraints

Method	GetConnectionTableConstraints
Request	GetConnectionTableConstraintsRequest
Response	GetConnectionTableConstraintsResponse
Description	For a specific connection, returns the table constraints. Mostly useful 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.

GetConnectionPrimaryConstraints

Method	GetConnectionPrimaryConstraints
Request	GetConnectionPrimaryConstraintsRequest
Response	GetConnectionPrimaryConstraintsResponse
Description	For 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

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.

GetConnectionUniqueConstraints

Method	GetConnectionUniqueConstraints
Request	GetConnectionUniqueConstraintsRequest
Response	GetConnectionUniqueConstraintsResponse
Description	For a specific connection, returns the unique constraints. Mostly useful for SQL-based connections.

GetAiGeneratedData

Method	GetAiGeneratedData
Request	GetAiGeneratedDataRequest
Response	GetAiGeneratedDataResponse
Description	Query an AI connection by providing the necessary values. Typically used for generating preview data

GetTableRowCount

Method	GetTableRowCount
Request	GetTableRowCountRequest
Response	GetTableRowCountResponse
Description	Query table with subset to get row count

---