connection_data.proto

path mgmt/v1alpha1/connection_data.proto

package mgmt.v1alpha1

---

Messages

AwsDynamoDBStreamConfig

Name	Type	Description

AwsS3SchemaConfig

Name	Type	Description
job_id	string	The unique identifier of the job to get the schema for.
job_run_id	string	The unique identifier of the job run to get the schema for.

AwsS3StreamConfig

Name	Type	Description
job_id	string	The unique identifier of the job to get the data stream for.
job_run_id	string	The unique identifier of the job run to get the data stream for.

ConnectionSchemaConfig

Name	Type	Description
pg_config	PostgresSchemaConfig
aws_s3_config	AwsS3SchemaConfig
mysql_config	MysqlSchemaConfig
mongo_config	MongoSchemaConfig
gcp_cloudstorage_config	GcpCloudStorageSchemaConfig
dynamodb_config	DynamoDBSchemaConfig
mssql_config	MssqlSchemaConfig

ConnectionStreamConfig

Name	Type	Description
pg_config	PostgresStreamConfig
aws_s3_config	AwsS3StreamConfig
mysql_config	MysqlStreamConfig
gcp_cloudstorage_config	GcpCloudStorageStreamConfig
dynamodb_config	AwsDynamoDBStreamConfig

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	The schema of the table
table	string	The table name

DynamoDBSchemaConfig

Name	Type	Description

ForeignConstraint

Name	Type	Description
foreign_key	ForeignKey	The foreign key that is associated with the constraint
columns	repeated string	The columns that are part of the constraint
not_nullable	repeated bool	The not nullable flag for each column

ForeignConstraintTables

Name	Type	Description
constraints	repeated ForeignConstraint	A list of foreign key constraints

ForeignKey

Name	Type	Description
table	string	The table that the foreign key is associated with
columns	repeated string	The columns that are part of the foreign key

GcpCloudStorageSchemaConfig

Name	Type	Description
job_id	string	The unique identifier of the job to get the schema for.
job_run_id	string	The unique identifier of the job run to get the schema for.

GcpCloudStorageStreamConfig

Name	Type	Description
job_id	string	The unique identifier of the job to get the data stream for.
job_run_id	string	The unique identifier of the job run to get the data stream for.

GetAiGeneratedDataRequest

Name	Type	Description
ai_connection_id	string	The unique identifier of a connection, specifically one that is configured for LLM use.
count	int64	The number of records to generate
model_name	string	The LLM model name to use that works with the configured connection id.
user_prompt	optional string	The prompt that will be used to further refine the data generation. This is appended to the prompt that Neosync generates that includes schema information.
data_connection_id	string	The unique identifier of a connection that the AI generated data would be inserted into. This is used to generate and send schema information to the LLM to help shape the generated data.
table	DatabaseTable	The table to generate data for.

GetAiGeneratedDataResponse

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

GetConnectionDataStreamRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the data stream for.
stream_config	ConnectionStreamConfig	The stream configuration to use for the data stream.
schema	string	The schema of the table to get the data stream for.
table	string	The table to get the data stream for.

GetConnectionDataStreamResponse

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

Name	Type	Description
row_bytes	bytes	A map of column name to column value, where the value is serialized as bytes. The value represents a map[string]any structure.

GetConnectionInitStatementsRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the init statements for.
options	InitStatementOptions	The options to use for the init statements.

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	A list of schema initialization statements

GetConnectionInitStatementsResponse.TableInitStatementsEntry

Name	Type	Description
key	string
value	string

GetConnectionInitStatementsResponse.TableTruncateStatementsEntry

Name	Type	Description
key	string
value	string

GetConnectionSchemaMapRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the schema map for.
schema_config	ConnectionSchemaConfig	The schema configuration to use for the schema map.

GetConnectionSchemaMapResponse

Name	Type	Description
schema_map	repeated GetConnectionSchemaMapResponse.SchemaMapEntry	Returns the database columns separated by the fully qualified <schema>.<table>

GetConnectionSchemaMapResponse.SchemaMapEntry

Name	Type	Description
key	string
value	GetConnectionSchemaResponse

GetConnectionSchemaMapsRequest

Name	Type	Description
requests	repeated GetConnectionSchemaMapRequest	List of connection schema maps to request

GetConnectionSchemaMapsResponse

Name	Type	Description
responses	repeated GetConnectionSchemaMapResponse	List of responses in the same order as the input
connection_ids	repeated string	Parallel array of each connection id that matches with the response

GetConnectionSchemaRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the schema for.
schema_config	ConnectionSchemaConfig	The schema configuration to use for the schema map.

GetConnectionSchemaResponse

Name	Type	Description
schemas	repeated DatabaseColumn	The list of database columns

GetConnectionTableConstraintsRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the constraints for.

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

GetTableRowCountRequest

Name	Type	Description
connection_id	string	The unique identifier of the connection to get the row count for.
schema	string	The schema of the table to get the row count for.
table	string	The table to get the row count for.
where_clause	optional string	The optional where clause to filter the rows by.

GetTableRowCountResponse

Name	Type	Description
count	int64	The count of the rows in the table

InitStatementOptions

Name	Type	Description
init_schema	bool	Whether or not to generate schema init statements.
truncate_before_insert	bool	Whether or not to generate truncation statements
truncate_cascade	bool	Whether or not to generate truncate cascade statements.

MongoSchemaConfig

Name	Type	Description

MssqlSchemaConfig

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	The columns that are part of the primary constraint

SchemaInitStatements

Name	Type	Description
label	string	A friendly label associated with the generated schema init statement(s)
statements	repeated string	A list of SQL statements that may be used to initialize a database from scratch.

UniqueConstraint

Name	Type	Description
columns	repeated string	The columns that are part of the unique constraint

UniqueConstraints

Name	Type	Description
constraints	repeated UniqueConstraint	The unique constraints found for the table

---

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

GetConnectionSchemaMap

Method	GetConnectionSchemaMap
Request	GetConnectionSchemaMapRequest
Response	GetConnectionSchemaMapResponse
Description	Returns the schema in map format. The keys are the fully qualified table in the format <schema>.<table>

GetConnectionSchemaMaps

Method	GetConnectionSchemaMaps
Request	GetConnectionSchemaMapsRequest
Response	GetConnectionSchemaMapsResponse
Description	Returns the schema in map format for every request provided

GetConnectionTableConstraints

Method	GetConnectionTableConstraints
Request	GetConnectionTableConstraintsRequest
Response	GetConnectionTableConstraintsResponse
Description	For a specific connection, returns the table constraints. Mostly useful for SQL-based Connections.

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.

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

---