​

Services

​

EntitiesService

(synq.entities.custom.v1.EntitiesService)

custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Synq.

Entities are identified by a unique identifier and can be created, updated, read and deleted.

​

UpsertEntity

UpsertEntity (UpsertEntityRequest) UpsertEntityResponse

Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

​

DeleteEntity

DeleteEntity (DeleteEntityRequest) DeleteEntityResponse

Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

​

ListEntities

ListEntities (ListEntitiesRequest) ListEntitiesResponse

List all entities.

​

RelationshipsService

(synq.entities.custom.v1.RelationshipsService)

RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Synq native entity.enum There is no option to create relationships between 2 Synq native entities (dbt model, BI dashboard, etc.).

​

UpsertRelationships

UpsertRelationships (UpsertRelationshipsRequest) UpsertRelationshipsResponse

Create or update relationships between entities. If the relationship already exists, it will be updated, otherwise it will be created.

​

DeleteRelationships

DeleteRelationships (DeleteRelationshipsRequest) DeleteRelationshipsResponse

Delete relationships between entities. If the relationship does not exist, it will be ignored.

​

ChecksRelationshipsService

(synq.entities.custom.v1.ChecksRelationshipsService)

​

UpsertCheckRelationships

UpsertCheckRelationships (UpsertCheckRelationshipsRequest) UpsertCheckRelationshipsResponse

​

DeleteCheckRelationships

DeleteCheckRelationships (DeleteCheckRelationshipsRequest) DeleteCheckRelationshipsResponse

​

FeaturesService

(synq.entities.custom.v1.FeaturesService)

​

UpsertEntityFeature

UpsertEntityFeature (UpsertEntityFeatureRequest) UpsertEntityFeatureResponse

Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

​

DeleteEntityFeature

DeleteEntityFeature (DeleteEntityFeatureRequest) DeleteEntityFeatureResponse

Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

​

ListEntityFeatures

ListEntityFeatures (ListEntityFeaturesRequest) ListEntityFeaturesResponse

List all entities.

​

TypesService

(synq.entities.custom.v1.TypesService)

TypesService is a service for managing custom entity types.

​

UpsertType

UpsertType (UpsertTypeRequest) UpsertTypeResponse

Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

​

DeleteType

DeleteType (DeleteTypeRequest) DeleteTypeResponse

Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

​

ListTypes

ListTypes (ListTypesRequest) ListTypesResponse

List all entities.

​

LineageService

(synq.entities.lineage.v1.LineageService)

LineageService allows you to fetch:

• Entity level lineage from a starting point of one or more entities.
• Column Level lineage from a starting point of multiple columns of a single entity.

​

GetLineage

GetLineage (GetLineageRequest) GetLineageResponse

​

EntitiesService

(synq.entities.entities.v1.EntitiesService)

EntitiesService is a service for retriving any entity.

​

GetEntity

GetEntity (GetEntityRequest) GetEntityResponse

Get specific entity by its identifier.

​

BatchGetEntities

BatchGetEntities (BatchGetEntitiesRequest) BatchGetEntitiesResponse

Get multiple entities by their identifiers.

​

EntityExecutionsService

(synq.entities.executions.v1.EntityExecutionsService)

​

UpsertExecution

UpsertExecution (UpsertExecutionRequest) UpsertExecutionResponse

​

EntityIssuesService

(synq.entities.status.v1.EntityIssuesService)

EntityIssuesService is the service which retrieves entity issues status.

​

GetIssuesStatus

GetIssuesStatus (GetIssuesStatusRequest) GetIssuesStatusResponse

Get specific entity status by its identifier.

​

BatchGetIssuesStatus

BatchGetIssuesStatus (BatchGetIssuesStatusRequest) BatchGetIssuesStatusResponse

Get multiple entity statuses by their identifiers.

​

EntityIncidentsService

(synq.entities.status.v1.EntityIncidentsService)

EntityIncidentsService is the service which retrieves entity status.

​

GetIncidents

GetIncidents (GetIncidentsRequest) GetIncidentsResponse

Get specific entity status by its identifier.

​

BatchGetIncidents

BatchGetIncidents (BatchGetIncidentsRequest) BatchGetIncidentsResponse

Get multiple entity statuses by their identifiers.

​

SqlTestsService

(synq.datachecks.sqltests.v1.SqlTestsService)

SqlTestsService is a service for managing SqlTests.

​

BatchUpsertSqlTests

BatchUpsertSqlTests (BatchUpsertSqlTestsRequest) BatchUpsertSqlTestsResponse

Upsert SqlTests based on a unique ID.

​

ListSqlTests

ListSqlTests (ListSqlTestsRequest) ListSqlTestsResponse

List SqlTests for given annotations.

​

BatchGetSqlTests

BatchGetSqlTests (BatchGetSqlTestsRequest) BatchGetSqlTestsResponse

Get SqlTests by their IDs.

​

BatchDeleteSqlTests

BatchDeleteSqlTests (BatchDeleteSqlTestsRequest) BatchDeleteSqlTestsResponse

Delete SqlTests by their IDs.

​

SqlMeshService

(synq.ingest.sqlmesh.v1.SqlMeshService)

​

IngestMetadata

IngestMetadata (IngestMetadataRequest) IngestMetadataResponse

​

IngestExecution

IngestExecution (IngestExecutionRequest) IngestExecutionResponse

​

DbtService

(synq.ingest.dbt.v1.DbtService)

​

IngestInvocation

IngestInvocation (IngestInvocationRequest) IngestInvocationResponse

​

Messages

​

SqlDefinition

(synq.entities.custom.features.v1.SqlDefinition)

SqlDefinition is a feature that allows to define lineage via SQL for a custom entity. Used to generate dependencies and other metadata. If parsed successfully, it will provide a code and column level lineage. Can be used to define simplified transformation of data which component performs using e.g. INSERT INTO foo SELECT * FROM bar.

Field	Type	Description
state_at	Timestamp	Time when the sql was defined, will default to now if not set.
dialect	SqlDialect	SQL dialect used in the SQL.
sql	string	Final form of the SQL as executed in the database/data warehouse. Must be a valid SQL in the selected dialect.

​

GitFileReference

(synq.entities.custom.features.v1.GitFileReference)

GitFileReference represents a reference to a file in a git repository.

Field	Type	Description
repository_url	string	URL of the git repository. Preferably SSH clone URL.
branch_name	string	Name of the branch in the git repository.
file_path	string	Path to the file in the git repository.

​

Code

(synq.entities.custom.features.v1.Code)

Code feature represents a code snippet associated with the entity. If support for code parsing and dependency extraction is needed use SqlDefinition.

Field	Type	Description
name	string	Might be e.g. name of the file or a function.
code_type	CodeType	Type of the code.
content	string	Content of the code. Displayed in the UI.

​

Schema

(synq.entities.custom.features.v1.Schema)

Schema represents a schema of a table like entity

Field	Type	Description
state_at	Timestamp	Time when the schema was defined, will default to now if not set.
columns	repeated SchemaColumn	Columns of the schema Columns are ordered by ordinal_position, it has to be defined for all or none of the columns, when not defined, ordinal positions are attached according to the order of columns in the list.

​

SchemaColumn

(synq.entities.custom.features.v1.SchemaColumn)

Field	Type	Description
name	string	Human readable name of the column as present in dbt or data warehouse.
native_type	string	Native data type of the column as present in data warehouse.
description	string	Description of the column
ordinal_position	int32	Ordinal position of the column in the table, starting from 1
is_struct	bool	Indicates that the column type could be used as a struct/json in a data warehouse
is_repeated	bool	Indicates that the column is a repeated field in a data warehouse (e.g. array)
fields	repeated SchemaColumnField	Fields inside of the struct/record like column

​

SchemaColumnField

(synq.entities.custom.features.v1.SchemaColumnField)

Field	Type	Description
name	string	Human readable name of the column as present in dbt or data warehouse.
native_type	string	Native data type of the column as present in data warehouse.
description	string	Description of the column
ordinal_position	int32	Ordinal position of the column in the struct, starting from 1
is_struct	bool	Indicates that the field type could be used as a struct/json in a data warehouse
is_repeated	bool	Indicates that the field is a repeated field in a data warehouse (e.g. array)
fields	repeated SchemaColumnField	Fields inside of the struct/record like field

​

DeleteEntityRequest

(synq.entities.custom.v1.DeleteEntityRequest)

DeleteEntityRequest is the request message for the DeleteEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to delete.

​

DeleteEntityResponse

(synq.entities.custom.v1.DeleteEntityResponse)

DeleteEntityResponse is the response message for the DeleteEntity method.

​

ListEntitiesRequest

(synq.entities.custom.v1.ListEntitiesRequest)

​

ListEntitiesResponse

(synq.entities.custom.v1.ListEntitiesResponse)

Field	Type	Description
entities	repeated Entity	none

​

UpsertEntityRequest

(synq.entities.custom.v1.UpsertEntityRequest)

UpsertEntityRequest is the request message for the UpsertEntity method.

Field	Type	Description
entity	Entity	The entity to create or update.

​

UpsertEntityResponse

(synq.entities.custom.v1.UpsertEntityResponse)

UpsertEntityResponse is the response message for the UpsertEntity method.

​

DeleteRelationshipsRequest

(synq.entities.custom.v1.DeleteRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

​

DeleteRelationshipsResponse

(synq.entities.custom.v1.DeleteRelationshipsResponse)

​

Relationship

(synq.entities.custom.v1.Relationship)

Field	Type	Description
upstream	Identifier	none
downstream	Identifier	none

​

UpsertRelationshipsRequest

(synq.entities.custom.v1.UpsertRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

​

UpsertRelationshipsResponse

(synq.entities.custom.v1.UpsertRelationshipsResponse)

​

CheckRelationship

(synq.entities.custom.v1.CheckRelationship)

Field	Type	Description
check	Identifier	none
checked	Identifier	none
checked_columns	repeated string	none

​

DeleteCheckRelationshipsRequest

(synq.entities.custom.v1.DeleteCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

​

DeleteCheckRelationshipsResponse

(synq.entities.custom.v1.DeleteCheckRelationshipsResponse)

​

UpsertCheckRelationshipsRequest

(synq.entities.custom.v1.UpsertCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

​

UpsertCheckRelationshipsResponse

(synq.entities.custom.v1.UpsertCheckRelationshipsResponse)

​

DeleteEntityFeatureRequest

(synq.entities.custom.v1.DeleteEntityFeatureRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to delete feature from.
feature_id	string	Identifier of the feature to delete.

​

DeleteEntityFeatureResponse

(synq.entities.custom.v1.DeleteEntityFeatureResponse)

​

Feature

(synq.entities.custom.v1.Feature)

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
entity_id	Identifier	The identifier of the entity to create or update feature for.
feature_id	string	Identifier of the feature. Can be any string, e.g. “sql” for SQL feature. Use same identifier to update the feature. Do not use random identifier as it will create a new feature on every update.
oneof feature.sql_definition	SqlDefinition	Only one feature per entity.
oneof feature.git_file_reference	GitFileReference	Multiple features per entity.
oneof feature.code	Code	Multiple features per entity.
oneof feature.schema	Schema	Only one feature per entity.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.

​

ListEntityFeaturesRequest

(synq.entities.custom.v1.ListEntityFeaturesRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to get features for.

​

ListEntityFeaturesResponse

(synq.entities.custom.v1.ListEntityFeaturesResponse)

Field	Type	Description
features	repeated Feature	List of features for the entity.

​

UpsertEntityFeatureRequest

(synq.entities.custom.v1.UpsertEntityFeatureRequest)

Field	Type	Description
feature	Feature	The feature to create or update.

​

UpsertEntityFeatureResponse

(synq.entities.custom.v1.UpsertEntityFeatureResponse)

​

DeleteTypeRequest

(synq.entities.custom.v1.DeleteTypeRequest)

Field	Type	Description
type_id	int32	Identifier of the custom entity type to delete.

​

DeleteTypeResponse

(synq.entities.custom.v1.DeleteTypeResponse)

​

ListTypesRequest

(synq.entities.custom.v1.ListTypesRequest)

​

ListTypesResponse

(synq.entities.custom.v1.ListTypesResponse)

Field	Type	Description
types	repeated Type	List of entities.

​

UpsertTypeRequest

(synq.entities.custom.v1.UpsertTypeRequest)

Field	Type	Description
type	Type	Entity to create or update.

​

UpsertTypeResponse

(synq.entities.custom.v1.UpsertTypeResponse)

​

CllDetails

(synq.entities.lineage.v1.CllDetails)

Field	Type	Description
columns	repeated Column	Column details for CLL.
cll_state	CllState	State of the CLL parse. UNSPECIFIED if CLL was not requested.
cll_messages	repeated string	Messages related to CLL. e.g. Description of parse errors, etc.

​

Column

(synq.entities.lineage.v1.Column)

Column in a table-like asset (used in CLL mode).

Field	Type	Description
column_id	string	ID string for the column. This is the parsed column name.
oneof _name.name	optional string	Original column name as fetched from the table.
oneof _native_type.native_type	optional string	Column type as fetched from the table.

​

ColumnDependency

(synq.entities.lineage.v1.ColumnDependency)

Indicates data flow between columns. Source columns are used to compute value of target columns.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
source_node_column_id	string	none
target_node_idx	uint32	Index of target node in the lineage nodes list.
target_node_column_id	string	none

​

Lineage

(synq.entities.lineage.v1.Lineage)

Lineage defines the lineage of table-like entities.

Field	Type	Description
nodes	repeated LineageNode	Nodes in the lineage with their identities and columns.
node_dependencies	repeated NodeDependency	All edges in the lineage between nodes. This can be parsed to create a graph of all the nodes.
is_cll	bool	Indicates whether the lineage was filtered for column level lineage (CLL).
column_dependencies	repeated ColumnDependency	Dependencies between columns. Populated only for CLL.

​

LineageNode

(synq.entities.lineage.v1.LineageNode)

Node in a lineage graph representing one or more entities (e.g. database table).

Field	Type	Description
ids	repeated Identifier	All entities which have the same identity as this node. Must be at least one item. These are sorted by closeness to the type of the start point entities. e.g. if requesting lineage of a DBT source, first entity should be from DBT, similarly when viewing table it will be other tables.
position	NodePosition	Position of the node in the lineage.
oneof _cll_details.cll_details	optional CllDetails	Populated only for Column Level Lineage (CLL).

​

NodeDependency

(synq.entities.lineage.v1.NodeDependency)

Indicates data flow between nodes. Source nodes are used to compute value of target nodes.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
target_node_idx	uint32	Index of target node in the lineage nodes list.

​

EntitiesStartPoint

(synq.entities.lineage.v1.EntitiesStartPoint)

Field	Type	Description
entities	repeated Identifier	none

​

EntityColumnsStartPoint

(synq.entities.lineage.v1.EntityColumnsStartPoint)

Field	Type	Description
id	Identifier	none
column_names	repeated string	none

​

GetLineageRequest

(synq.entities.lineage.v1.GetLineageRequest)

Field	Type	Description
lineage_direction	LineageDirection	none
start_point	GetLineageStartPoint	none
oneof _max_depth.max_depth	optional int32	none

​

GetLineageResponse

(synq.entities.lineage.v1.GetLineageResponse)

Field	Type	Description
lineage	Lineage	none

​

GetLineageStartPoint

(synq.entities.lineage.v1.GetLineageStartPoint)

Possible starting points to get lineage from.

Field	Type	Description
oneof from.entities	EntitiesStartPoint	none
oneof from.entity_columns	EntityColumnsStartPoint	none

​

BatchGetEntitiesRequest

(synq.entities.entities.v1.BatchGetEntitiesRequest)

BatchGetEntitiesRequest is the request message for the BatchGetEntities method.

Field	Type	Description
ids	repeated Identifier	Identifiers of the entities to get.

​

BatchGetEntitiesResponse

(synq.entities.entities.v1.BatchGetEntitiesResponse)

BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

Field	Type	Description
entities	repeated Entity	The entities that were retrieved.

​

GetEntityRequest

(synq.entities.entities.v1.GetEntityRequest)

GetEntityRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get.

​

GetEntityResponse

(synq.entities.entities.v1.GetEntityResponse)

GetEntityResponse is the response message for the GetEntity method.

Field	Type	Description
entity	Entity	The entity that was retrieved.

​

Annotation

(synq.entities.v1.Annotation)

Annotations can be used to annotate any entity with a key:value pair. These annotations can be used for filtering and searching entities.

Field	Type	Description
name	string	String key for the annotation.
values	repeated string	Optional list of values that the annotation can carry.

​

Entity

(synq.entities.v1.Entity)

Entity is the base type for all entities in the system. Its always attached to a given client workspace and can be uniquely identified by its id.

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
id	Identifier	Unique identifier for this entity.
type_id	int32	Id of custom type or default type when 0
name	string	Name of the entity that is displayed to the user.
description	string	Description of the entity that is displayed in relevant contexts. Can contain Markdown.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.
synq_path	string	Return only value. Synq Path to the entity. This is a unique path that can be used to access the entity in the Synq’s UI.
synq_catalog_url	string	Return only value. Synq URL to the entity. This is a unique URL that can be used to access the entity in the Synq’s UI.
annotations	repeated Annotation	Annotations attached to the entity. Annotations are key-value pairs that can be used to store metadata about the entity.

​

AirflowDagIdentifier

(synq.entities.v1.AirflowDagIdentifier)

Field	Type	Description
integration_id	string	Synq integration_id that identifies the Airflow instance
dag_id	string	Airflow dag_id that identifies the DAG

​

AirflowTaskIdentifier

(synq.entities.v1.AirflowTaskIdentifier)

Field	Type	Description
integration_id	string	Synq integration_id that identifies the Airflow instance
dag_id	string	Airflow dag_id that identifies the DAG
task_id	string	Airflow task_id that identifies the task within the DAG

​

BigqueryTableIdentifier

(synq.entities.v1.BigqueryTableIdentifier)

Field	Type	Description
project	string	BigQuery project
dataset	string	BigQuery dataset id
table	string	BigQuery table name

​

ClickhouseTableIdentifier

(synq.entities.v1.ClickhouseTableIdentifier)

Field	Type	Description
host	string	Clickhouse host inclusive of port
schema	string	Clickhouse database
table	string	Clickhouse table

​

CustomIdentifier

(synq.entities.v1.CustomIdentifier)

Field	Type	Description
id	string	Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

​

DatabricksTableIdentifier

(synq.entities.v1.DatabricksTableIdentifier)

Field	Type	Description
workspace	string	URL of Databricks workspace
catalog	string	Databricks catalog
schema	string	Databricks schema
table	string	Databricks table or view

​

DataproductIdentifier

(synq.entities.v1.DataproductIdentifier)

Field	Type	Description
id	string	Dataproduct id that identifies the Dataproduct

​

DbtCloudNodeIdentifier

(synq.entities.v1.DbtCloudNodeIdentifier)

Field	Type	Description
project_id	string	Your dbt Cloud project id
account_id	string	Your dbt Cloud account id
node_id	string	Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​

DbtCoreNodeIdentifier

(synq.entities.v1.DbtCoreNodeIdentifier)

Field	Type	Description
integration_id	string	Synq integration_id that identifies the dbt Core project
node_id	string	Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​

Identifier

(synq.entities.v1.Identifier)

Identifier is a unique reference to an entity in Synq system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.

Field	Type	Description
oneof id.dbt_core_node	DbtCoreNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project
oneof id.dbt_cloud_node	DbtCloudNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project
oneof id.bigquery_table	BigqueryTableIdentifier	BigQuery table identifier
oneof id.snowflake_table	SnowflakeTableIdentifier	Snowflake table identifier
oneof id.redshift_table	RedshiftTableIdentifier	Redshift table identifier
oneof id.postgres_table	PostgresTableIdentifier	Postgres table identifier
oneof id.mysql_table	MysqlTableIdentifier	Mysql table identifier
oneof id.clickhouse_table	ClickhouseTableIdentifier	Clickhouse table identifier
oneof id.databricks_table	DatabricksTableIdentifier	Databricks table identifier
oneof id.airflow_dag	AirflowDagIdentifier	Airflow DAG identifier
oneof id.airflow_task	AirflowTaskIdentifier	Airflow task identifier within a given DAG
oneof id.custom	CustomIdentifier	Custom identifier to be used with all custom created entities
oneof id.dataproduct	DataproductIdentifier	Dataproduct identifier
oneof id.synq_path	SynqPathIdentifier	SynqPath identifier

​

MysqlTableIdentifier

(synq.entities.v1.MysqlTableIdentifier)

Field	Type	Description
host	string	Mysql host inclusive of port
schema	string	Mysql database
table	string	Mysql table

​

PostgresTableIdentifier

(synq.entities.v1.PostgresTableIdentifier)

Field	Type	Description
host	string	Postgres host inclusive of port
database	string	Postgres database
schema	string	Postgres schema
table	string	Postgres table

​

RedshiftTableIdentifier

(synq.entities.v1.RedshiftTableIdentifier)

Field	Type	Description
cluster	string	Redshift cluster
database	string	Redshift database
schema	string	Redshift schema
table	string	Redshift table

​

SnowflakeTableIdentifier

(synq.entities.v1.SnowflakeTableIdentifier)

Field	Type	Description
account	string	Snowflake account
database	string	Snowflake database
schema	string	Snowflake schema
table	string	Snowflake table

​

SynqPathIdentifier

(synq.entities.v1.SynqPathIdentifier)

Field	Type	Description
path	string	Synq path that identifies the Synq entity, needs to be one of supported paths

​

Type

(synq.entities.v1.Type)

Custom entity type that is used to categorize custom entities.

Field	Type	Description
workspace	string	Immutable workspace identifier that this custom entity type belongs to.
type_id	int32	none
name	string	Name of the custom entity type that is displayed to the user.
svg_icon	bytes	SVG icon of the custom entity type that is displayed to the user.
svg_icon_id	string	SYNQ identifier used for CDN purposes, read-only.
created_at	Timestamp	Timestamp when the custom entity type was created.
updated_at	Timestamp	Timestamp when the custom entity type was last updated.
deleted_at	Timestamp	Timestamp when the custom entity type was deleted. If this is set, the custom entity type is considered deleted.

​

Execution

(synq.entities.executions.v1.Execution)

Field	Type	Description
id	Identifier	none
status	ExecutionStatus	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none
extras	repeated ExecutionExtra	none

​

ExecutionExtra

(synq.entities.executions.v1.ExecutionExtra)

Field	Type	Description
oneof extra.executed_sql	string	none

​

UpsertExecutionRequest

(synq.entities.executions.v1.UpsertExecutionRequest)

Field	Type	Description
execution	Execution	none

​

UpsertExecutionResponse

(synq.entities.executions.v1.UpsertExecutionResponse)

​

BatchGetIssuesStatusRequest

(synq.entities.status.v1.BatchGetIssuesStatusRequest)

BatchGetIssuesStatusRequest is the request message for the BatchGetIssues method.

Field	Type	Description
requests	repeated GetIssuesStatusRequest	none

​

BatchGetIssuesStatusResponse

(synq.entities.status.v1.BatchGetIssuesStatusResponse)

BatchGetIssuesStatusResponse is the response message for the BatchGetIssues method.

Field	Type	Description
responses	repeated GetIssuesStatusResponse	none

​

GetIssuesStatusRequest

(synq.entities.status.v1.GetIssuesStatusRequest)

GetIssuesStatusRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get status for.
fetch_upstream_status	bool	Retrieve status of upstream entities.

​

GetIssuesStatusResponse

(synq.entities.status.v1.GetIssuesStatusResponse)

GetIssuesStatusResponse is the response message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity.
entity_issues_status	IssueStatus	Status of the entity requested.
entity_issues_summary	IssuesSummary	none
upstream_issues_status	IssueStatus	Optionally, the status of all upstream entities.
upstream_issues_summary	IssuesSummary	none

​

GetIssuesStatusResponse.IssuesSummary

(synq.entities.status.v1.GetIssuesStatusResponse.IssuesSummary)

Field	Type	Description
total_count	int32	Number of issues for the entity.
warn_count	int32	Number of issues for the entity with status ‘warn’.
error_count	int32	Number of issues for the entity with status ‘error’.
critical_count	int32	Number of issues for the entity with status ‘critical’.

​

EntityIncident

(synq.entities.status.v1.EntityIncident)

Field	Type	Description
id	string	Unique identifier of the incident.
url	string	URL of the incident.
name	string	Name of the incident give by the user.
created_by	string	Information about author of the incident.
created_at	Timestamp	Time when the incident was created.
updated_by	string	Information about the user who last updated the incident.
updated_at	Timestamp	Time when the incident was last updated.
is_resolved	bool	Indicates if all issues inside the incident are resolved.

​

BatchGetIncidentsRequest

(synq.entities.status.v1.BatchGetIncidentsRequest)

BatchGetIncidentsRequest is the request message for the BatchGetIssues method.

Field	Type	Description
requests	repeated GetIncidentsRequest	none

​

BatchGetIncidentsResponse

(synq.entities.status.v1.BatchGetIncidentsResponse)

BatchGetIncidentsResponse is the response message for the BatchGetIssues method.

Field	Type	Description
responses	repeated GetIncidentsResponse	none

​

GetIncidentsRequest

(synq.entities.status.v1.GetIncidentsRequest)

GetIncidentsRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get incidents for.
fetch_upstream_incidents	bool	Retrieve incidents of upstream entities.

​

GetIncidentsResponse

(synq.entities.status.v1.GetIncidentsResponse)

GetIncidentsResponse is the response message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity.
entity_open_incidents	repeated EntityIncident	Open incident associated with the entity requested.
upstream_open_incidents	repeated EntityIncident	Open incidents associated with the upstream entities if requested.

​

ScopeAuthorization

(synq.v1.ScopeAuthorization)

Field	Type	Description
scopes	repeated Scope	none

​

BigqueryIdentifier

(synq.platforms.v1.BigqueryIdentifier)

Field	Type	Description
project	string	BigQuery project

​

ClickhouseIdentifier

(synq.platforms.v1.ClickhouseIdentifier)

Field	Type	Description
host	string	Clickhouse host inclusive of port
schema	string	Clickhouse database

​

DataPlatformIdentifier

(synq.platforms.v1.DataPlatformIdentifier)

DataPlatformIdentifier is a unique reference to a data platform integrated with Synq.

Field	Type	Description
oneof id.unknown	UnknownDataPlatform	none
oneof id.bigquery	BigqueryIdentifier	none
oneof id.clickhouse	ClickhouseIdentifier	none
oneof id.snowflake	SnowflakeIdentifier	none
oneof id.redshift	RedshiftIdentifier	none
oneof id.postgres	PostgresIdentifier	none
oneof id.mysql	MysqlIdentifier	none
oneof id.databricks	DatabricksIdentifier	none

​

DatabricksIdentifier

(synq.platforms.v1.DatabricksIdentifier)

Field	Type	Description
workspace	string	URl of the databricks workspace

​

MysqlIdentifier

(synq.platforms.v1.MysqlIdentifier)

Field	Type	Description
host	string	Mysql host inclusive of port

​

PostgresIdentifier

(synq.platforms.v1.PostgresIdentifier)

Field	Type	Description
host	string	Postgres host inclusive of port
database	string	Postgres database

​

RedshiftIdentifier

(synq.platforms.v1.RedshiftIdentifier)

Field	Type	Description
cluster	string	Redshift cluster
database	string	Redshift database

​

SnowflakeIdentifier

(synq.platforms.v1.SnowflakeIdentifier)

Field	Type	Description
account	string	Snowflake account
database	string	Snowflake database

​

UnknownDataPlatform

(synq.platforms.v1.UnknownDataPlatform)

​

SqlTest

(synq.datachecks.sqltests.v1.SqlTest)

The SqlTest is a SQL test that is executed on a synq entity.

Field	Type	Description
platform	DataPlatformIdentifier	Identifier for the data platform which the SqlTest would be executed on.
id	string	Unique resource identifier for the SqlTest. This is externally maintained and can be used to fetch/update/delete this test.
name	string	Human friendly name.
sql_expression	string	A valid SQL expression which is the test.
recurrence_rule	string	Recurrence rule for the execution schedule of the SqlTest.
annotations	repeated Annotation	Annotations for the given SqlTest.These help filter the SqlTests for later operations like listing by API, selection in UI, analytics, etc.
save_failures	bool	Boolean flag to to toggle saving of failure runs.

​

BatchDeleteSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTests to delete.

​

BatchDeleteSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsResponse)

​

BatchGetSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchGetSqlTestsRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTests to fetch.

​

BatchGetSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse)

Field	Type	Description
sql_tests	map SqlTestsEntry	none

​

BatchGetSqlTestsResponse.SqlTestsEntry

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse.SqlTestsEntry)

Field	Type	Description
key	string	none
value	SqlTest	none

​

BatchUpsertSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsRequest)

Field	Type	Description
sql_tests	repeated SqlTest	List of SqlTests to upsert. The upsert is performed based on the unique path provided for each SqlTest.

​

BatchUpsertSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsResponse)

Field	Type	Description
created_ids	repeated string	IDs for which SqlTests were created without error.
updated_ids	repeated string	IDs for which SqlTests were updated without error.
errors	repeated UpsertError	Errors raised while upsert. This list will be empty if there were no errors.

​

BatchUpsertSqlTestsResponse.UpsertError

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsResponse.UpsertError)

Details of errors encountered during the upsert operation.

Field	Type	Description
id	string	none
reason	string	none

​

ListSqlTestsRequest

(synq.datachecks.sqltests.v1.ListSqlTestsRequest)

Field	Type	Description
annotations	repeated Annotation	Optional annotations to fetch SqlTests for.

​

ListSqlTestsResponse

(synq.datachecks.sqltests.v1.ListSqlTestsResponse)

Field	Type	Description
sql_tests	repeated SqlTest	none

​

GitContext

(synq.ingest.sqlmesh.v1.GitContext)

Field	Type	Description
clone_url	string	none
branch	string	none
commit_sha	string	none

​

IngestExecutionRequest

(synq.ingest.sqlmesh.v1.IngestExecutionRequest)

Field	Type	Description
command	repeated string	Command passed to the sqlmesh tool
exit_code	int32	Exit code of the sqlmesh command
std_out	bytes	Standard output log of the SqlMesh command
std_err	bytes	Standard error log of the SqlMesh command
environment_vars	map EnvironmentVarsEntry	Environment variables collected during execution
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool
started_at	Timestamp	Time at which the execution started
finished_at	Timestamp	Time at which the execution finished
git_context	GitContext	Git context of the project

​

IngestExecutionRequest.EnvironmentVarsEntry

(synq.ingest.sqlmesh.v1.IngestExecutionRequest.EnvironmentVarsEntry)

Field	Type	Description
key	string	none
value	string	none

​

IngestExecutionResponse

(synq.ingest.sqlmesh.v1.IngestExecutionResponse)

​

IngestMetadataRequest

(synq.ingest.sqlmesh.v1.IngestMetadataRequest)

Field	Type	Description
api_meta	bytes	Data from /api/meta
models	bytes	Data from /api/models
model_details	map ModelDetailsEntry	Data from /api/models/
model_lineage	map ModelLineageEntry	Data from /api/lineage/
files	bytes	Data from /api/files
file_content	map FileContentEntry	Data from /api/file/
environments	bytes	Data from /api/environments
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool
state_at	Timestamp	Time at which state was collected
git_context	GitContext	Git context of the project

​

IngestMetadataRequest.FileContentEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.FileContentEntry)

Field	Type	Description
key	string	none
value	bytes	none

​

IngestMetadataRequest.ModelDetailsEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.ModelDetailsEntry)

Field	Type	Description
key	string	none
value	bytes	none

​

IngestMetadataRequest.ModelLineageEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.ModelLineageEntry)

Field	Type	Description
key	string	none
value	bytes	none

​

IngestMetadataResponse

(synq.ingest.sqlmesh.v1.IngestMetadataResponse)

​

DbtArtifact

(synq.ingest.dbt.v1.DbtArtifact)

https://docs.getdbt.com/reference/artifacts/dbt-artifacts

Field	Type	Description
oneof artifact.manifest_json	bytes	none
oneof artifact.run_results_json	bytes	none
oneof artifact.catalog_json	bytes	none
oneof artifact.sources_json	bytes	none
oneof artifact.semantic_manifest_json	bytes	none

​

IngestInvocationRequest

(synq.ingest.dbt.v1.IngestInvocationRequest)

Field	Type	Description
args	repeated string	Arguments passed to the dbt executable
exit_code	int32	Exit code of the dbt command
std_out	bytes	Standard output log of the dbt command
std_err	bytes	Standard error log of the dbt command
environment_vars	map EnvironmentVarsEntry	Environment variables collected during execution
artifacts	repeated DbtArtifact	Artifacts generated by the dbt command
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool

​

IngestInvocationRequest.EnvironmentVarsEntry

(synq.ingest.dbt.v1.IngestInvocationRequest.EnvironmentVarsEntry)

Field	Type	Description
key	string	none
value	string	none

​

IngestInvocationResponse

(synq.ingest.dbt.v1.IngestInvocationResponse)

​

Enums

​

SqlDialect

(synq.entities.custom.features.v1.SqlDialect)

Name	Number	Description
SQL_DIALECT_UNSPECIFIED	0	none
SQL_DIALECT_BIGQUERY	1	none
SQL_DIALECT_CLICKHOUSE	2	none
SQL_DIALECT_DATABRICKS	3	none
SQL_DIALECT_MYSQL	4	none
SQL_DIALECT_POSTGRESQL	5	none
SQL_DIALECT_REDSHIFT	6	none
SQL_DIALECT_SNOWFLAKE	7	none

​

CodeType

(synq.entities.custom.features.v1.CodeType)

Name	Number	Description
CODE_TYPE_UNSPECIFIED	0	none
CODE_TYPE_SQL	1	none
CODE_TYPE_PYTHON	2	none

​

CllState

(synq.entities.lineage.v1.CllState)

Name	Number	Description
CLL_STATE_UNSPECIFIED	0	Unspecified state.
CLL_STATE_PARSE_FAILED	1	Parsing of the asset SQL failed. No upstream dependencies can be found.
CLL_STATE_EXTRACTION_FAILED	2	Extraction of the asset SQL failed. Some unsupported SQL features may be used. Some details might be missing.
CLL_STATE_RESOLUTION_FAILED	3	Not all columns or tables were found upstream, lineage is not complete.
CLL_STATE_OK	10	No known issues present.

​

NodePosition

(synq.entities.lineage.v1.NodePosition)

Name	Number	Description
NODE_POSITION_UNSPECIFIED	0	none
NODE_POSITION_START_NODE	1	Node is one of the requested start point.
NODE_POSITION_UPSTREAM	2	Node is upstream of the requested start point.
NODE_POSITION_DOWNSTREAM	3	Node is downstream of the requested start point.

​

LineageDirection

(synq.entities.lineage.v1.LineageDirection)

Direction of the lineage to query.

Name	Number	Description
LINEAGE_DIRECTION_UNSPECIFIED	0	none
LINEAGE_DIRECTION_UPSTREAM	1	none
LINEAGE_DIRECTION_DOWNSTREAM	2	none
LINEAGE_DIRECTION_UPSTREAM_DOWNSTREAM	3	none

​

ExecutionStatus

(synq.entities.executions.v1.ExecutionStatus)

Name	Number	Description
EXECUTION_STATUS_UNSPECIFIED	0	none
EXECUTION_STATUS_OK	1	none
EXECUTION_STATUS_WARN	2	none
EXECUTION_STATUS_ERROR	3	none
EXECUTION_STATUS_CRITICAL	4	none

​

IssueStatus

(synq.entities.status.v1.IssueStatus)

Name	Number	Description
ISSUE_STATUS_UNSPECIFIED	0	none
ISSUE_STATUS_OK	10	none
ISSUE_STATUS_WARN	20	none
ISSUE_STATUS_ERROR	30	none
ISSUE_STATUS_CRITICAL	40	none

​

Scope

(synq.v1.Scope)

This has to match auth/v1/scope.proto

Name	Number	Description
SCOPE_UNSPECIFIED	0	none
SCOPE_ENTITY_READ	1	none
SCOPE_ENTITY_EDIT	2	none
SCOPE_LINEAGE_READ	10	none
SCOPE_LINEAGE_EDIT	11	none
SCOPE_STATUS_READ	20	none
SCOPE_INGEST_DBT	30	none
SCOPE_INGEST_SQLMESH	31	none
SCOPE_DATACHECKS_SQLTESTS_READ	50	none
SCOPE_DATACHECKS_SQLTESTS_EDIT	51	none
SCOPE_EXECUTION_EDIT	60	none
SCOPE_ENTITY_TYPE_READ	70	none
SCOPE_ENTITY_TYPE_EDIT	71	none