​

Services

​

IssuesService

(synq.issues.issues.v1.IssuesService)

IssuesService is a service for managing Issues.

​

MarkInvestigating

MarkInvestigating (MarkInvestigatingRequest) MarkInvestigatingResponse

Mark issue as being investigated.

​

MarkFixed

MarkFixed (MarkFixedRequest) MarkFixedResponse

Mark issue as fixed.

​

MarkExpected

MarkExpected (MarkExpectedRequest) MarkExpectedResponse

Mark issue as expected.

​

MarkNoActionNeeded

MarkNoActionNeeded (MarkNoActionNeededRequest) MarkNoActionNeededResponse

Mark issue as no action needed.

​

PostComment

PostComment (PostCommentRequest) PostCommentResponse

Post a comment on an issue.

​

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.

​

GetSqlTestAudit

GetSqlTestAudit (GetSqlTestAuditRequest) GetSqlTestAuditResponse

Get SqlTest audit from a given execution ID in jwt token.

​

DwhAgentService

(synq.agent.dwh.v1.DwhAgentService)

​

Connect

Connect (ConnectRequest) ConnectResponse

buf:lint:ignore RPC_NO_CLIENT_STREAMING

​

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.

​

GroupsService

(synq.entities.custom.v1.GroupsService)

It eliminates the need to keep state on client side to remember which assets were already created and which should be deleted. The server will keep track of the current state of the group and client can always send the intended new state. The server will calculate the diff and entities that are no longer present in the group will be removed.

Example:

1. group has entities A, B, C at time t1
2. client sends group with entities B, C, D at time t2
3. server will remove entity A from the system and update the current state of the group to B, C, D

The service is designed to be idempotent and can be called multiple times with the same state without causing any side effects.

​

ListEntityGroups

ListEntityGroups (ListEntityGroupsRequest) ListEntityGroupsResponse

ListEntityGroups lists all groups.

​

UpsertEntitiesGroup

UpsertEntitiesGroup (UpsertEntitiesGroupRequest) UpsertEntitiesGroupResponse

UpsertEntitiesGroup updates current definition of group to the server. As part of the upsert operation the difference of entity ids is calculated between past state and the current state and entities that are no longer part of the group are removed.

​

DeleteEntitiesGroup

DeleteEntitiesGroup (DeleteEntitiesGroupRequest) DeleteEntitiesGroupResponse

DeleteEntitiesGroup deletes a group by its identifier. If the group does not exist, it will be a no-op.

​

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.

​

ListRelationships

ListRelationships (ListRelationshipsRequest) ListRelationshipsResponse

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.

​

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.

​

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.

​

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

Execution affects status of the custom entity

​

UpsertLogEntry

UpsertLogEntry (UpsertLogEntryRequest) UpsertLogEntryResponse

LogEntry is a log message for the custom entity

​

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

​

DomainsService

(synq.domains.v1.DomainsService)

DomainsService can be used to manage domains.

​

Upsert

Upsert (UpsertRequest) UpsertResponse

Create or update a domain.

​

BatchGet

BatchGet (BatchGetRequest) BatchGetResponse

Get multiple domains by their identifiers.

​

FetchDomainWithSubDomains

FetchDomainWithSubDomains (FetchDomainWithSubDomainsRequest) FetchDomainWithSubDomainsResponse

Get a domain with its sub-domains

​

List

List (ListRequest) ListResponse

List all the domains in the current workspace.

​

Delete

Delete (DeleteRequest) DeleteResponse

Delete a domain by its identifier.

​

SetDefinition

SetDefinition (SetDefinitionRequest) SetDefinitionResponse

Set the definition for an existing domain.

​

AddDefinitionPart

AddDefinitionPart (AddDefinitionPartRequest) AddDefinitionPartResponse

Add definition part to the definition of an existing domain.

​

RemoveDefinitionPart

RemoveDefinitionPart (RemoveDefinitionPartRequest) RemoveDefinitionPartResponse

Remove definition part from the definition of an existing domain.

​

DomainMembersService

(synq.domains.members.v1.DomainMembersService)

DomainMembersService can be used to manage domain memberships.

​

AddDomainMembers

AddDomainMembers (AddDomainMembersRequest) AddDomainMembersResponse

Add domain members.

​

RemoveDomainMembers

RemoveDomainMembers (RemoveDomainMembersRequest) RemoveDomainMembersResponse

Remove domain members.

​

ListDomainMembers

ListDomainMembers (ListDomainMembersRequest) ListDomainMembersResponse

List domain members.

​

ListUserDomains

ListUserDomains (ListUserDomainsRequest) ListUserDomainsResponse

List domains for the given user.

​

SetDefaultUserDomain

SetDefaultUserDomain (SetDefaultUserDomainRequest) SetDefaultUserDomainResponse

Set default domain for user.

​

DbtService

(synq.ingest.dbt.v1.DbtService)

​

IngestInvocation

IngestInvocation (IngestInvocationRequest) IngestInvocationResponse

​

DwhService

(synq.ingest.dwh.v1.DwhService)

​

IngestObjectInformation

IngestObjectInformation (IngestObjectInformationRequest) IngestObjectInformationResponse

​

IngestSqlDefinitions

IngestSqlDefinitions (IngestSqlDefinitionsRequest) IngestSqlDefinitionsResponse

​

IngestSchemas

IngestSchemas (IngestSchemasRequest) IngestSchemasResponse

​

IngestObjectMetrics

IngestObjectMetrics (IngestObjectMetricsRequest) IngestObjectMetricsResponse

​

SqlMeshService

(synq.ingest.sqlmesh.v1.SqlMeshService)

​

IngestMetadata

IngestMetadata (IngestMetadataRequest) IngestMetadataResponse

​

IngestExecution

IngestExecution (IngestExecutionRequest) IngestExecutionResponse

​

DataproductsService

(synq.dataproducts.v1.DataproductsService)

DataproductsService can be used to manage data products.

​

Upsert

Upsert (UpsertRequest) UpsertResponse

Create or update a dataproduct.

​

Get

Get (GetRequest) GetResponse

Get multiple dataproducts by their identifiers.

​

List

List (ListRequest) ListResponse

List all the dataproducts in the current scope.

​

Delete

Delete (DeleteRequest) DeleteResponse

Delete a dataproduct by its identifier. Soft deletes by default. Optionally purge the dataproduct to release the identifier.

​

SetDefinition

SetDefinition (SetDefinitionRequest) SetDefinitionResponse

Set the definition for an existing dataproduct.

​

AddDefinitionPart

AddDefinitionPart (AddDefinitionPartRequest) AddDefinitionPartResponse

Add definition part to the definition of an existing dataproduct.

​

RemoveDefinitionPart

RemoveDefinitionPart (RemoveDefinitionPartRequest) RemoveDefinitionPartResponse

Remove definition part from the definition of an existing dataproduct.

​

Messages

​

IdentifierList

(synq.queries.v1.IdentifierList)

Resolves to entities matching any of the given identifiers.

Field	Type	Description
identifiers	repeated Identifier	none

​

InDataPlatform

(synq.queries.v1.InDataPlatform)

Resolves to all entities that belong to the given data platform.

Field	Type	Description
identifier	DataPlatformIdentifier	none

​

InDataproduct

(synq.queries.v1.InDataproduct)

Resolves to all the assets that belong to the given data product.

Field	Type	Description
identifier	DataproductIdentifier	none

​

InFolder

(synq.queries.v1.InFolder)

Resolves to all entities belonging to the given folder structure.

Field	Type	Description
path	repeated string	none

​

Unsupported

(synq.queries.v1.Unsupported)

Collects all the parts of the query that are currently unsupported in translation. These represent an internal structure that are not yet completely available on the API.

Field	Type	Description
query_json	string	none

​

WithAnnotation

(synq.queries.v1.WithAnnotation)

Resolves to all entities that contain the annotation with the provided accepted value. In case of no given accepted value, all entities that carry the given annotation are returned.

Field	Type	Description
name	string	none
oneof _accepted_value.accepted_value	optional string	none

​

WithNameSearch

(synq.queries.v1.WithNameSearch)

Resolves to all entities matching the given name search.

Field	Type	Description
search_query	string	none

​

WithType

(synq.queries.v1.WithType)

Resolves to all the entities that have the provided type.

Field	Type	Description
type	Type	none

​

WithType.Type

(synq.queries.v1.WithType.Type)

Field	Type	Description
oneof entity_type.default	EntityType	Default SYNQ types
oneof entity_type.custom	int32	Custom types as defined through synq.entities.custom.v1.TypesService

​

IssuesCommand

(synq.issues.commands.v1.IssuesCommand)

Not to be used directly. Use the IssuesService instead when calling via API.

Field	Type	Description
workspace	string	none
oneof action.mark_investigating	MarkInvestigatingRequest	none
oneof action.mark_fixed	MarkFixedRequest	none
oneof action.mark_expected	MarkExpectedRequest	none
oneof action.mark_no_action_needed	MarkNoActionNeededRequest	none
oneof action.post_comment	PostCommentRequest	none

​

MarkExpectedRequest

(synq.issues.issues.v1.MarkExpectedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as expected.
actor	Actor	Actor marking the issue as expected.
time	Timestamp	Time at which the issue was marked as expected. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

​

MarkExpectedResponse

(synq.issues.issues.v1.MarkExpectedResponse)

​

MarkFixedRequest

(synq.issues.issues.v1.MarkFixedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as fixed.
actor	Actor	Actor marking the issue as fixed.
time	Timestamp	Time at which the issue was marked as fixed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

​

MarkFixedResponse

(synq.issues.issues.v1.MarkFixedResponse)

​

MarkInvestigatingRequest

(synq.issues.issues.v1.MarkInvestigatingRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as investigating.
actor	Actor	Actor marking the issue as investigating.
time	Timestamp	Time at which the issue was marked as investigating. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

​

MarkInvestigatingResponse

(synq.issues.issues.v1.MarkInvestigatingResponse)

​

MarkNoActionNeededRequest

(synq.issues.issues.v1.MarkNoActionNeededRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as no action needed.
actor	Actor	Actor marking the issue as no action needed.
time	Timestamp	Time at which the issue was marked as no action needed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

​

MarkNoActionNeededResponse

(synq.issues.issues.v1.MarkNoActionNeededResponse)

​

PostCommentRequest

(synq.issues.issues.v1.PostCommentRequest)

Field	Type	Description
issue_id	string	ID of the issue to post a comment on.
actor	Actor	Actor posting the comment.
comment	string	Comment to post.
time	Timestamp	Time at which the comment was posted. Defaults to the current time.

​

PostCommentResponse

(synq.issues.issues.v1.PostCommentResponse)

Field	Type	Description
comment_id	string	none

​

Actor

(synq.issues.actor.v1.Actor)

Field	Type	Description
name	string	none
oneof user.slack	SlackUser	none
oneof user.email	EmailUser	none
oneof user.pagerduty	PagerdutyUser	none

​

EmailUser

(synq.issues.actor.v1.EmailUser)

Field	Type	Description
user_email	string	none

​

PagerdutyUser

(synq.issues.actor.v1.PagerdutyUser)

Field	Type	Description
user_id	string	none

​

SlackUser

(synq.issues.actor.v1.SlackUser)

Field	Type	Description
user_id	string	none

​

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

​

GetSqlTestAuditRequest

(synq.datachecks.sqltests.v1.GetSqlTestAuditRequest)

​

GetSqlTestAuditResponse

(synq.datachecks.sqltests.v1.GetSqlTestAuditResponse)

Field	Type	Description
audit	SqlTestAudit	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

​

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.

​

SqlTestAudit

(synq.datachecks.sqltests.v1.SqlTestAudit)

Field	Type	Description
execution_id	string	none
rows_count	int32	none
result	string	none
created_at	Timestamp	none

​

AgentTask

(synq.agent.dwh.v1.AgentTask)

Field	Type	Description
connection_id	string	none
task_id	string	none
oneof command.fetch_full_catalog	FetchFullCatalogCommand	none
oneof command.fetch_full_metrics	FetchFullMetricsCommand	none

​

ConnectRequest

(synq.agent.dwh.v1.ConnectRequest)

Field	Type	Description
oneof message.hello	Hello	none
oneof message.log	Log	none

​

ConnectResponse

(synq.agent.dwh.v1.ConnectResponse)

Field	Type	Description
tasks	repeated AgentTask	none

​

FetchFullCatalogCommand

(synq.agent.dwh.v1.FetchFullCatalogCommand)

​

FetchFullMetricsCommand

(synq.agent.dwh.v1.FetchFullMetricsCommand)

​

Hello

(synq.agent.dwh.v1.Hello)

Field	Type	Description
name	string	none
build_version	string	none
build_time	string	none
available_connections	repeated AvailableConnection	none

​

Hello.AvailableConnection

(synq.agent.dwh.v1.Hello.AvailableConnection)

Field	Type	Description
connection_id	string	Identifier which will receive commands
name	string	User provided connection name
disabled	bool	Indicates that agent has that connection disabled
type	string	Type of the DWH, e.g. bigquery, duckdb, clickhouse
instance	string	This will be hostname in most cases
databases	repeated string	Enabled databases to query if connection supports multiple databases, can be empty.

​

Log

(synq.agent.dwh.v1.Log)

Field	Type	Description
time	Timestamp	none
message	string	none
level	LogLevel	none

​

BigQueryConf

(synq.agent.dwh.v1.BigQueryConf)

BigQuery specific configuration

Field	Type	Description
project_id	string	GCP project ID
service_account_key	string	Service account key JSON
service_account_key_file	string	Location of service account key file
region	string	Region for BigQuery resources

​

ClickhouseConf

(synq.agent.dwh.v1.ClickhouseConf)

Field	Type	Description
host	string	Host address
port	int32	Port number
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to use disable SSL for connection

​

Config

(synq.agent.dwh.v1.Config)

Config represents the main configuration for the DWH agent

Field	Type	Description
agent	Agent	Agent configuration
synq	SYNQ	SYNQ platform configuration
connections	map ConnectionsEntry	Map of connection configurations

​

Config.Agent

(synq.agent.dwh.v1.Config.Agent)

Agent contains metadata about this agent instance

Field	Type	Description
name	string	Name of the agent instance
tags	repeated string	Tags to categorize and organize the agent
log_level	LogLevel	none
oneof _log_json.log_json	optional bool	none
oneof _log_report_caller.log_report_caller	optional bool	none

​

Config.Connection

(synq.agent.dwh.v1.Config.Connection)

Connection represents a database connection configuration

Field	Type	Description
name	string	Name of the connection
disabled	bool	none
parallelism	int32	How many queries to DWH can be executed in parallel, defaults to 2
oneof config.bigquery	BigQueryConf	none
oneof config.clickhouse	ClickhouseConf	none
oneof config.databricks	DatabricksConf	none
oneof config.mysql	MySQLConf	none
oneof config.postgres	PostgresConf	none
oneof config.redshift	RedshiftConf	none
oneof config.snowflake	SnowflakeConf	none

​

Config.ConnectionsEntry

(synq.agent.dwh.v1.Config.ConnectionsEntry)

Field	Type	Description
key	string	none
value	Connection	none

​

Config.SYNQ

(synq.agent.dwh.v1.Config.SYNQ)

SYNQ contains authentication and connection details for the SYNQ platform

Field	Type	Description
client_id	string	Client ID for OAuth authentication
client_secret	string	Client secret for OAuth authentication
endpoint	string	SYNQ API agent endpoint (host:port)
ingest_endpoint	string	SYNQ API ingest endpoint (host:port)
oauth_url	string	OAuth authentication URL

​

DatabricksConf

(synq.agent.dwh.v1.DatabricksConf)

Field	Type	Description
workspace_url	string	none
oneof _auth_token.auth_token	optional string	none
oneof _auth_client.auth_client	optional string	none
oneof _auth_secret.auth_secret	optional string	none
oneof _warehouse.warehouse	optional string	none
refresh_table_metrics	bool	none
refresh_table_metrics_use_scan	bool	none
fetch_table_tags	bool	none
use_show_create_table	bool	none

​

MySQLConf

(synq.agent.dwh.v1.MySQLConf)

MySQL specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to allow insecure connections
params	map ParamsEntry	Additional connection parameters

​

MySQLConf.ParamsEntry

(synq.agent.dwh.v1.MySQLConf.ParamsEntry)

Field	Type	Description
key	string	none
value	string	none

​

PostgresConf

(synq.agent.dwh.v1.PostgresConf)

Postgres specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to allow insecure connections

​

RedshiftConf

(synq.agent.dwh.v1.RedshiftConf)

Redshift specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
freshness_from_query_logs	bool	Estimate table freshness based on query logs

​

SnowflakeConf

(synq.agent.dwh.v1.SnowflakeConf)

Snowflake specific configuration

Field	Type	Description
account	string	Snowflake account identifier
warehouse	string	Virtual warehouse to use
role	string	Role to assume
username	string	Username for authentication
password	string	Password for authentication
private_key	string	Content of Private key used for Snowflake authentication
databases	repeated string	Database to connect to
use_get_ddl	bool	Use GET_DDL to determine queries used for table/view creation

​

ScopeAuthorization

(synq.v1.ScopeAuthorization)

Field	Type	Description
scopes	repeated Scope	none

​

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.

​

DeleteEntitiesGroupRequest

(synq.entities.custom.v1.DeleteEntitiesGroupRequest)

Field	Type	Description
group_id	string	none

​

DeleteEntitiesGroupResponse

(synq.entities.custom.v1.DeleteEntitiesGroupResponse)

​

Group

(synq.entities.custom.v1.Group)

Group is a collection of entities.

Field	Type	Description
group_id	string	Identifier of the group.
entity_ids	repeated Identifier	Identifiers of entities that belong to the group.
created_at	Timestamp	Timestamp when the group was created.
updated_at	Timestamp	Timestamp when the group was last updated.

​

ListEntityGroupsRequest

(synq.entities.custom.v1.ListEntityGroupsRequest)

​

ListEntityGroupsResponse

(synq.entities.custom.v1.ListEntityGroupsResponse)

Field	Type	Description
entities_groups	repeated Group	none

​

UpsertEntitiesGroupRequest

(synq.entities.custom.v1.UpsertEntitiesGroupRequest)

Field	Type	Description
group	Group	none
dry_run	bool	none

​

UpsertEntitiesGroupResponse

(synq.entities.custom.v1.UpsertEntitiesGroupResponse)

Field	Type	Description
deleted_ids	repeated Identifier	none

​

DeleteRelationshipsRequest

(synq.entities.custom.v1.DeleteRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

​

DeleteRelationshipsResponse

(synq.entities.custom.v1.DeleteRelationshipsResponse)

​

ListRelationshipsRequest

(synq.entities.custom.v1.ListRelationshipsRequest)

Field	Type	Description
ids	repeated Identifier	Return relationships for the given entity_id. Either upstream or downstream.

​

ListRelationshipsResponse

(synq.entities.custom.v1.ListRelationshipsResponse)

Field	Type	Description
relationships	repeated Relationship	none

​

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.
oneof feature.check_category	CheckCategory	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)

​

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

​

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.

​

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.

​

CheckCategory

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

Checks feature indicates that the entity is testing in some way different entity. To define the kind of the check use the kind field. The package field is optional. It is used to categorize the entities which check other entities.

Field	Type	Description
package	string	Grouping of check kinds. e.g. “gcs”, “sql”, “queue”
kind	string	Kind of the check. e.g “not_null”, “unique”, “foreign_key”, “row_count”.
oneof _category.category	optional string	Explicit name of the Check category. If it is not defined categorisation rules are applied based on package + kind.

​

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.

​

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.

​

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’.

​

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.

​

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.

​

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.

​

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

​

LogEntry

(synq.entities.executions.v1.LogEntry)

Field	Type	Description
id	Identifier	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none

​

UpsertExecutionRequest

(synq.entities.executions.v1.UpsertExecutionRequest)

Field	Type	Description
execution	Execution	none

​

UpsertExecutionResponse

(synq.entities.executions.v1.UpsertExecutionResponse)

​

UpsertLogEntryRequest

(synq.entities.executions.v1.UpsertLogEntryRequest)

Field	Type	Description
log_entry	LogEntry	none

​

UpsertLogEntryResponse

(synq.entities.executions.v1.UpsertLogEntryResponse)

​

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

​

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)

​

AssetSelectionQuery

(synq.domains.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

​

AssetSelectionQuery.QueryPart

(synq.domains.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

​

DomainDefinition

(synq.domains.v1.DomainDefinition)

Field	Type	Description
parts	repeated Part	none

​

DomainDefinition.Part

(synq.domains.v1.DomainDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.dataproduct	DataproductIdentifier	none
oneof part.query	AssetSelectionQuery	none

​

Domain

(synq.domains.v1.Domain)

Field	Type	Description
id	string	none
name	string	none
description	string	none
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none
definition	DomainDefinition	none
oneof _parent_id.parent_id	optional string	none

​

AddDefinitionPartRequest

(synq.domains.v1.AddDefinitionPartRequest)

Field	Type	Description
domain_id	string	none
part	Part	none

​

AddDefinitionPartResponse

(synq.domains.v1.AddDefinitionPartResponse)

​

BatchGetRequest

(synq.domains.v1.BatchGetRequest)

Field	Type	Description
domain_ids	repeated string	none

​

BatchGetResponse

(synq.domains.v1.BatchGetResponse)

Field	Type	Description
domains	map DomainsEntry	none

​

BatchGetResponse.DomainsEntry

(synq.domains.v1.BatchGetResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

​

DeleteRequest

(synq.domains.v1.DeleteRequest)

Field	Type	Description
domain_id	string	none

​

DeleteResponse

(synq.domains.v1.DeleteResponse)

​

FetchDomainWithSubDomainsRequest

(synq.domains.v1.FetchDomainWithSubDomainsRequest)

Field	Type	Description
domain_id	string	none

​

FetchDomainWithSubDomainsResponse

(synq.domains.v1.FetchDomainWithSubDomainsResponse)

Field	Type	Description
domains	map DomainsEntry	none

​

FetchDomainWithSubDomainsResponse.DomainsEntry

(synq.domains.v1.FetchDomainWithSubDomainsResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

​

ListRequest

(synq.domains.v1.ListRequest)

Field	Type	Description
oneof _parent_id.parent_id	optional string	none

​

ListResponse

(synq.domains.v1.ListResponse)

Field	Type	Description
domains	repeated Domain	none

​

RemoveDefinitionPartRequest

(synq.domains.v1.RemoveDefinitionPartRequest)

Field	Type	Description
domain_id	string	none
part_id	string	none

​

RemoveDefinitionPartResponse

(synq.domains.v1.RemoveDefinitionPartResponse)

​

SetDefinitionRequest

(synq.domains.v1.SetDefinitionRequest)

Field	Type	Description
domain_id	string	none
definition	DomainDefinition	none

​

SetDefinitionResponse

(synq.domains.v1.SetDefinitionResponse)

​

UpsertRequest

(synq.domains.v1.UpsertRequest)

Field	Type	Description
id	string	none
name	string	none
description	string	none
oneof _parent_id.parent_id	optional string	none

​

UpsertResponse

(synq.domains.v1.UpsertResponse)

​

DomainMembership

(synq.domains.members.v1.DomainMembership)

Field	Type	Description
user_id	string	none
domain_id	string	none
is_default	bool	none

​

AddDomainMembersRequest

(synq.domains.members.v1.AddDomainMembersRequest)

Field	Type	Description
domain_id	string	none
user_ids	repeated string	none

​

AddDomainMembersResponse

(synq.domains.members.v1.AddDomainMembersResponse)

​

ListDomainMembersRequest

(synq.domains.members.v1.ListDomainMembersRequest)

Field	Type	Description
domain_id	string	none

​

ListDomainMembersResponse

(synq.domains.members.v1.ListDomainMembersResponse)

Field	Type	Description
memberships	repeated DomainMembership	none

​

ListUserDomainsRequest

(synq.domains.members.v1.ListUserDomainsRequest)

Field	Type	Description
user_id	string	none

​

ListUserDomainsResponse

(synq.domains.members.v1.ListUserDomainsResponse)

Field	Type	Description
memberships	repeated DomainMembership	none

​

RemoveDomainMembersRequest

(synq.domains.members.v1.RemoveDomainMembersRequest)

Field	Type	Description
domain_id	string	none
user_ids	repeated string	none

​

RemoveDomainMembersResponse

(synq.domains.members.v1.RemoveDomainMembersResponse)

​

SetDefaultUserDomainRequest

(synq.domains.members.v1.SetDefaultUserDomainRequest)

Field	Type	Description
domain_id	string	none
user_id	string	none

​

SetDefaultUserDomainResponse

(synq.domains.members.v1.SetDefaultUserDomainResponse)

​

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
git_context	GitContext	Git context of the project

​

IngestInvocationRequest.EnvironmentVarsEntry

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

Field	Type	Description
key	string	none
value	string	none

​

IngestInvocationResponse

(synq.ingest.dbt.v1.IngestInvocationResponse)

​

IngestObjectInformationRequest

(synq.ingest.dwh.v1.IngestObjectInformationRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
objects	repeated ObjectInformation	none

​

IngestObjectInformationResponse

(synq.ingest.dwh.v1.IngestObjectInformationResponse)

​

IngestObjectMetricsRequest

(synq.ingest.dwh.v1.IngestObjectMetricsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
metrics	repeated ObjectMetrics	none

​

IngestObjectMetricsResponse

(synq.ingest.dwh.v1.IngestObjectMetricsResponse)

​

IngestSchemasRequest

(synq.ingest.dwh.v1.IngestSchemasRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
schemas	repeated Schema	none

​

IngestSchemasResponse

(synq.ingest.dwh.v1.IngestSchemasResponse)

​

IngestSqlDefinitionsRequest

(synq.ingest.dwh.v1.IngestSqlDefinitionsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
sql_definitions	repeated SqlDefinition	none

​

IngestSqlDefinitionsResponse

(synq.ingest.dwh.v1.IngestSqlDefinitionsResponse)

​

Fqn

(synq.ingest.dwh.v1.Fqn)

Field	Type	Description
instance_name	string	none
database_name	string	none
schema_name	string	none
object_name	string	none

​

ObjectInformation

(synq.ingest.dwh.v1.ObjectInformation)

Field	Type	Description
fqn	Fqn	none
object_native_type	string	none
is_view	bool	none
is_table	bool	none
tags	repeated Tag	none
oneof _description.description	optional string	none

​

ObjectMetrics

(synq.ingest.dwh.v1.ObjectMetrics)

Field	Type	Description
fqn	Fqn	none
oneof _row_count.row_count	optional int64	none
oneof _updated_at.updated_at	optional Timestamp	none
oneof _size_bytes.size_bytes	optional int64	none

​

Schema

(synq.ingest.dwh.v1.Schema)

Field	Type	Description
fqn	Fqn	none
columns	repeated SchemaColumn	none

​

SchemaColumn

(synq.ingest.dwh.v1.SchemaColumn)

Field	Type	Description
name	string	none
native_type	string	none
ordinal_position	int32	none
oneof _description.description	optional string	none
tags	repeated Tag	none
is_struct	bool	none
is_repeated	bool	none
fields	repeated SchemaColumnField	none

​

SchemaColumnField

(synq.ingest.dwh.v1.SchemaColumnField)

Field	Type	Description
name	string	none
native_type	string	none
oneof _description.description	optional string	none
ordinal_position	int32	none
is_struct	bool	none
is_repeated	bool	none
fields	repeated SchemaColumnField	none

​

SqlDefinition

(synq.ingest.dwh.v1.SqlDefinition)

Field	Type	Description
fqn	Fqn	none
sql	string	none

​

Tag

(synq.ingest.dwh.v1.Tag)

Field	Type	Description
tag_name	string	none
tag_value	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
errors	repeated Error	Optional errors indicating why some data wasn’t loaded

​

IngestMetadataRequest.Error

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

Field	Type	Description
oneof _path.path	optional string	none
oneof _code.code	optional int64	none
message	string	none

​

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)

​

GitContext

(synq.ingest.git.v1.GitContext)

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

​

Callback

(synq.webhooks.v1.Callback)

Field	Type	Description
url	string	none
action_name	string	none
oneof action.issues_command	IssuesCommand	none

​

Event

(synq.webhooks.v1.Event)

Field	Type	Description
workspace	string	none
event_id	string	none
event_time	Timestamp	none
event_type	EventType	none
oneof data.ping	Ping	none
oneof data.issue_created	IssueCreated	none
oneof data.issue_updated	IssueUpdated	none
oneof data.issue_status_updated	IssueStatusUpdated	none
oneof data.issue_closed	IssueClosed	none
callbacks	repeated Callback	none

​

IssueClosed

(synq.webhooks.v1.IssueClosed)

Field	Type	Description
issue	IssueSummary	none

​

IssueCreated

(synq.webhooks.v1.IssueCreated)

Field	Type	Description
issue	IssueSummary	none

​

IssueStatusUpdated

(synq.webhooks.v1.IssueStatusUpdated)

Field	Type	Description
issue	IssueSummary	none

​

IssueSummary

(synq.webhooks.v1.IssueSummary)

Field	Type	Description
issue_id	string	none
issue_group_id	string	none
issue_url	string	none
title	string	Summary of the issue, what happened and where.
description	string	Detailed description of the issue. In the Markdown format.
description_html	string	Detailed description of the issue. In the HTML format.
trigger_entity	IssueEntity	Entity which triggered the issue.
directly_affected_entities	repeated IssueEntity	Entities directly affected by the issue, not considering downstream ones.
started_at	Timestamp	Time when the issue was triggered.
oneof _ended_at.ended_at	optional Timestamp	Time when the issue was closed.
trigger_run_id	string	none
trigger_name	string	none
trigger_message	string	none
status	IssueStatus	none

​

IssueSummary.IssueEntity

(synq.webhooks.v1.IssueSummary.IssueEntity)

Field	Type	Description
name	string	none
type_name	string	none
identifier	Identifier	none
oneof _folder.folder	optional string	none
entity_url	string	none

​

IssueUpdated

(synq.webhooks.v1.IssueUpdated)

Field	Type	Description
issue	IssueSummary	none

​

Ping

(synq.webhooks.v1.Ping)

Test event sent during a webhook setup.

Field	Type	Description
message	string	none

​

AddDefinitionPartRequest

(synq.dataproducts.v1.AddDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part	Part	none

​

AddDefinitionPartResponse

(synq.dataproducts.v1.AddDefinitionPartResponse)

​

DeleteRequest

(synq.dataproducts.v1.DeleteRequest)

Field	Type	Description
identifier	DataproductIdentifier	none

​

DeleteResponse

(synq.dataproducts.v1.DeleteResponse)

​

GetRequest

(synq.dataproducts.v1.GetRequest)

Field	Type	Description
identifiers	repeated DataproductIdentifier	none

​

GetResponse

(synq.dataproducts.v1.GetResponse)

Field	Type	Description
products	repeated Dataproduct	none

​

ListRequest

(synq.dataproducts.v1.ListRequest)

Field	Type	Description
include_deleted	bool	none

​

ListResponse

(synq.dataproducts.v1.ListResponse)

Field	Type	Description
products	repeated Dataproduct	none

​

RemoveDefinitionPartRequest

(synq.dataproducts.v1.RemoveDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part_id	string	none

​

RemoveDefinitionPartResponse

(synq.dataproducts.v1.RemoveDefinitionPartResponse)

​

SetDefinitionRequest

(synq.dataproducts.v1.SetDefinitionRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
definition	DataproductDefinition	none

​

SetDefinitionResponse

(synq.dataproducts.v1.SetDefinitionResponse)

​

UpsertRequest

(synq.dataproducts.v1.UpsertRequest)

Field	Type	Description
oneof _identifier.identifier	optional DataproductIdentifier	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none

​

UpsertResponse

(synq.dataproducts.v1.UpsertResponse)

Field	Type	Description
identifier	DataproductIdentifier	identifier of the updated or created dataproduct

​

Dataproduct

(synq.dataproducts.v1.Dataproduct)

Field	Type	Description
identifier	DataproductIdentifier	none
definition	DataproductDefinition	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none

​

AssetSelectionQuery

(synq.dataproducts.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

​

AssetSelectionQuery.QueryPart

(synq.dataproducts.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

​

DataproductDefinition

(synq.dataproducts.v1.DataproductDefinition)

Field	Type	Description
parts	repeated Part	none

​

DataproductDefinition.Part

(synq.dataproducts.v1.DataproductDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.query	AssetSelectionQuery	none

​

Enums

​

QueryOperand

(synq.queries.v1.QueryOperand)

Name	Number	Description
QUERY_OPERAND_UNSPECIFIED	0	default to AND behaviour
QUERY_OPERAND_AND	1	none
QUERY_OPERAND_OR	2	none
QUERY_OPERAND_EXCEPT	3	none
QUERY_OPERAND_UPSTREAM	4	none
QUERY_OPERAND_DOWNSTREAM	5	none

​

LogLevel

(synq.agent.dwh.v1.LogLevel)

Name	Number	Description
LOG_LEVEL_UNSPECIFIED	0	none
LOG_LEVEL_INFO	1	none
LOG_LEVEL_WARN	2	none
LOG_LEVEL_ERROR	3	none

​

Config.Agent.LogLevel

(synq.agent.dwh.v1.Config.Agent.LogLevel)

Name	Number	Description
LOG_LEVEL_UNSPECIFIED	0	Defaults to info
LOG_LEVEL_TRACE	1	none
LOG_LEVEL_DEBUG	2	none
LOG_LEVEL_INFO	3	none
LOG_LEVEL_WARN	4	none
LOG_LEVEL_ERROR	5	none

​

Scope

(synq.v1.Scope)

Name	Number	Description
SCOPE_UNSPECIFIED	0	none
SCOPE_ISSUES_EDIT	10	none
SCOPE_ISSUES_READ	11	none
SCOPE_ENTITY_EDIT	30	none
SCOPE_ENTITY_READ	31	none
SCOPE_ENTITY_TYPE_EDIT	32	none
SCOPE_ENTITY_TYPE_READ	33	none
SCOPE_LINEAGE_EDIT	34	none
SCOPE_LINEAGE_READ	35	none
SCOPE_STATUS_READ	40	none
SCOPE_INGEST_DBT	41	none
SCOPE_INGEST_SQLMESH	42	none
SCOPE_INGEST_DWH	43	none
SCOPE_DATACHECKS_SQLTESTS_EDIT	50	none
SCOPE_DATACHECKS_SQLTESTS_READ	51	none
SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ	52	none
SCOPE_EXECUTION_EDIT	60	none
SCOPE_EXECUTION_LOG_EDIT	61	none
SCOPE_EXECUTION_READ	62	none
SCOPE_HOOK	70	none
SCOPE_USER_READ	91	none
SCOPE_USER_ASSIGN	92	none
SCOPE_DATAPRODUCT_EDIT	150	none
SCOPE_DATAPRODUCT_READ	151	none
SCOPE_DOMAIN_EDIT	160	none
SCOPE_DOMAIN_READ	161	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
CODE_TYPE_JSON	3	none

​

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
SQL_DIALECT_DUCKDB	8	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

​

EntityType

(synq.entities.v1.EntityType)

Name	Number	Description
ENTITY_TYPE_UNSPECIFIED	0	none
ENTITY_TYPE_BQ_TABLE	103	none
ENTITY_TYPE_BQ_VIEW	105	none
ENTITY_TYPE_LOOKER_LOOK	201	none
ENTITY_TYPE_LOOKER_EXPLORE	203	none
ENTITY_TYPE_LOOKER_VIEW	207	none
ENTITY_TYPE_LOOKER_DASHBOARD	208	none
ENTITY_TYPE_DBT_MODEL	301	none
ENTITY_TYPE_DBT_TEST	302	none
ENTITY_TYPE_DBT_SOURCE	303	none
ENTITY_TYPE_DBT_PROJECT	306	none
ENTITY_TYPE_DBT_METRIC	307	none
ENTITY_TYPE_DBT_SNAPSHOT	310	none
ENTITY_TYPE_DBT_SEED	311	none
ENTITY_TYPE_DBT_ANALYSIS	312	none
ENTITY_TYPE_DBT_EXPOSURE	313	none
ENTITY_TYPE_DBT_GROUP	314	none
ENTITY_TYPE_DBT_CLOUD_PROJECT	352	none
ENTITY_TYPE_DBT_CLOUD_JOB	353	none
ENTITY_TYPE_SNOWFLAKE_TABLE	503	none
ENTITY_TYPE_SNOWFLAKE_VIEW	508	none
ENTITY_TYPE_REDSHIFT_TABLE	803	none
ENTITY_TYPE_REDSHIFT_VIEW	805	none
ENTITY_TYPE_TABLEAU_EMBEDDED	1101	none
ENTITY_TYPE_TABLEAU_PUBLISHED	1102	none
ENTITY_TYPE_TABLEAU_CUSTOM_SQL	1103	none
ENTITY_TYPE_TABLEAU_TABLE	1104	none
ENTITY_TYPE_TABLEAU_SHEET	1105	none
ENTITY_TYPE_TABLEAU_DASHBOARD	1106	none
ENTITY_TYPE_AIRFLOW_DAG	1201	none
ENTITY_TYPE_AIRFLOW_TASK	1202	none
ENTITY_TYPE_CLICKHOUSE_TABLE	1303	none
ENTITY_TYPE_CLICKHOUSE_VIEW	1305	none
ENTITY_TYPE_ANOMALY_MONITOR	1403	none
ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT	1404	none
ENTITY_TYPE_SQLTEST_TEST	1421	none
ENTITY_TYPE_POSTGRES_TABLE	1603	none
ENTITY_TYPE_POSTGRES_VIEW	1605	none
ENTITY_TYPE_MYSQL_TABLE	1703	none
ENTITY_TYPE_MYSQL_VIEW	1705	none
ENTITY_TYPE_DATABRICKS_WAREHOUSE	1801	none
ENTITY_TYPE_DATABRICKS_TABLE	1804	none
ENTITY_TYPE_DATABRICKS_VIEW	1805	none
ENTITY_TYPE_DATABRICKS_JOB	1807	none
ENTITY_TYPE_DATABRICKS_NOTEBOOK	1809	none
ENTITY_TYPE_DATABRICKS_QUERY	1810	none
ENTITY_TYPE_DATABRICKS_DASHBOARD	1811	none
ENTITY_TYPE_SQLMESH_PROJECT	1901	none
ENTITY_TYPE_SQLMESH_SQL_MODEL	1902	none
ENTITY_TYPE_SQLMESH_PYTHON_MODEL	1903	none
ENTITY_TYPE_SQLMESH_EXTERNAL	1904	none
ENTITY_TYPE_SQLMESH_SEED	1905	none
ENTITY_TYPE_SQLMESH_AUDIT	1906	none
ENTITY_TYPE_SQLMESH_UNIT_TEST	1907	none
ENTITY_TYPE_SQLMESH_ENVIRONMENT	1908	none
ENTITY_TYPE_SQLMESH_SNAPSHOT	1909	none
ENTITY_TYPE_DUCKDB_TABLE	2003	none
ENTITY_TYPE_DUCKDB_VIEW	2005	none
ENTITY_TYPE_CUSTOM_ENTITY_GENERIC	50000	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN	50001	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX	59999	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

​

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

​

Event.EventType

(synq.webhooks.v1.Event.EventType)

Name	Number	Description
EVENT_TYPE_UNSPECIFIED	0	none
EVENT_TYPE_PING	10	none
EVENT_TYPE_ISSUE_CREATED	11	none
EVENT_TYPE_ISSUE_UPDATED	12	none
EVENT_TYPE_ISSUE_STATUS_UPDATED	13	none
EVENT_TYPE_ISSUE_CLOSED	14	none

​

IssueSummary.IssueStatus

(synq.webhooks.v1.IssueSummary.IssueStatus)

Name	Number	Description
ISSUE_STATUS_UNSPECIFIED	0	none
ISSUE_STATUS_INVESTIGATING	1	none
ISSUE_STATUS_EXPECTED	2	none
ISSUE_STATUS_FIXED	3	none
ISSUE_STATUS_NO_ACTION_NEEDED	4	none

​

Dataproduct.Priority

(synq.dataproducts.v1.Dataproduct.Priority)

Name	Number	Description
PRIORITY_UNSPECIFIED	0	none
PRIORITY_P3	3	none
PRIORITY_P2	4	none
PRIORITY_P1	5	none