> ## Documentation Index > Fetch the complete documentation index at: https://docs.synq.io/llms.txt > Use this file to discover all available pages before exploring further. # UpsertEntityFeature > 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. ## OpenAPI ````yaml /api-reference/openapi.yaml post /api/entities/custom/v1/features openapi: 3.1.0 info: version: '1.0' title: SYNQ servers: - url: https://developer.synq.io - url: https://api.us.synq.io security: - bearerAuth: [] tags: - name: synq.issues.issues.v1.IssuesService description: IssuesService is a service for managing Issues. - name: synq.issues.v2.IssuesService description: IssuesService is a service for managing Issues. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. - name: synq.alerts.services.v1.AlertsService description: AlertsService provides operations for managing alert configurations. - name: synq.agent.recon.v1.YamlService description: >- YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML. - name: synq.agent.recon.v1.SuiteDeploymentService description: |- SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace's behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn. - name: synq.agent.sre.v1.TriageService description: >- Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process. - name: synq.agent.sre.v1.LlmService description: Service for evaluating LLM requests and producing structured output. - name: synq.agent.sre.v1.FeatureRequestService description: >- FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user's request. - name: synq.integrations.v1.IntegrationsService description: |- IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque `etag`. Read it from `GetIntegration` / `ListIntegrations`, then pass it back on `UpdateIntegration` / `DeleteIntegration` to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is `optional`). - name: synq.auth.iam.v1.IamService - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.monitors.history.v1.HistoryService - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - name: synq.entities.executions.v2.EntityExecutionsService description: >- EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases: - Retrieve execution history for specific entities - Filter executions by time range, status, or execution type - Get aggregated summaries of execution activity - Track execution trends and patterns - name: synq.datachecks.sqltests.v1.SqlTestsService description: SqlTestsService is a service for managing SqlTests. - name: synq.datachecks.v1.TriggerService description: TriggerService provides synchronous execution of datachecks on entities. - name: synq.datachecks.testsuggestions.v1.TestSuggestionsService - name: synq.extensions.atlan.provider.v1.AtlanProviderService - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - name: synq.savedviews.v1.SavedViewsService description: >- SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace. - name: synq.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - name: synq.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.entities.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.status.v1.EntityIncidentsService description: EntityIncidentsService is the service which retrieves entity status. - name: synq.entities.status.v1.EntityIssuesService description: EntityIssuesService is the service which retrieves entity issues status. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies. - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.entities.checks.v1.ChecksCategoriesService description: |- ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace's categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload. - name: synq.entities.sql_insights.v1.SqlInsightsService description: >- SqlInsightsService exposes analytical information about the SQL used across a workspace's entities. It answers questions such as "which SQL constructs are used in my warehouse, and how often" and "what SQL constructs does this specific entity use", without requiring the caller to re-parse any SQL. - name: synq.entities.custom.v1.RelationshipsService description: >- RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.). - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.GroupsService description: >- 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. - name: synq.entities.custom.v1.EntityExecutionsService - name: synq.entities.custom.v1.EntitiesService description: >- 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 Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted. - name: synq.entities.custom.v1.FeaturesService - name: synq.entities.impact.v1.ImpactService - name: synq.entities.schemas.v1.SchemaMismatchesService description: >- SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models). - name: synq.entities.schemas.v1.SchemasService description: EntitiesService is a service for retriving any entity. - name: synq.entities.constraints.v1.TableConstraintsService description: >- TableConstraintsService provides access to table constraint and index information. - name: synq.entities.changes.v1.ChangesService description: >- ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity: - Git commits: Changes to code files (dbt models, SQL files) tracked in version control - Schema changes: Database schema modifications (columns added/removed/changed) - SQL definition changes: View/materialized view definition updates detected by Coalesce Quality Changes are returned with structured metadata including: - For git commits: structured statistics (directories, file types, top changes) - For schema changes: detailed column-level diffs - For SQL changes: before/after SQL definitions Use cases: - "What changed in the last week for table X?" → Returns git commits, schema changes, SQL changes - "Show me all commits affecting this dbt model" → Returns git commits with lineage context - "What schema changes happened to this table?" → Returns schema changes detected by Coalesce Quality - name: synq.entities.lineage.v1.LineageService description: |- 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. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.annotations.v1.AnnotationsService description: >- AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering. - name: synq.entities.code.v1.CodeService description: >- CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.openlineage.v1.OpenlineageService - name: synq.ingest.dwh.v1.DwhService - name: synq.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - name: synq.git.commits.v1.CommitsService paths: /api/entities/custom/v1/features: post: tags: - synq.entities.custom.v1.FeaturesService summary: UpsertEntityFeature description: >- 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. operationId: synq.entities.custom.v1.FeaturesService.UpsertEntityFeature requestBody: content: application/json: schema: $ref: >- #/components/schemas/synq.entities.custom.v1.UpsertEntityFeatureRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.entities.custom.v1.UpsertEntityFeatureResponse components: schemas: synq.entities.custom.v1.UpsertEntityFeatureRequest: type: object properties: feature: $ref: '#/components/schemas/synq.entities.custom.v1.Feature' description: The feature to create or update. title: UpsertEntityFeatureRequest required: - feature additionalProperties: false synq.entities.custom.v1.UpsertEntityFeatureResponse: type: object title: UpsertEntityFeatureResponse additionalProperties: false synq.entities.custom.v1.Feature: type: object allOf: - properties: workspace: type: string title: workspace description: Immutable workspace identifier that this entity belongs to. entityId: $ref: '#/components/schemas/synq.entities.v1.Identifier' title: entity_id description: The identifier of the entity to create or update feature for. featureId: type: string title: feature_id maxLength: 255 description: >- 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. createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: Timestamp when the entity was created. updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at description: Timestamp when the entity was last updated. deletedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: deleted_at description: >- Timestamp when the entity was deleted. If this is set, the entity is considered deleted. - oneOf: - properties: checkCategory: $ref: >- #/components/schemas/synq.entities.custom.features.v1.CheckCategory title: check_category description: Only one feature per entity. title: check_category required: - checkCategory - properties: code: $ref: '#/components/schemas/synq.entities.custom.features.v1.Code' title: code description: Multiple features per entity. title: code required: - code - properties: gitFileReference: $ref: >- #/components/schemas/synq.entities.custom.features.v1.GitFileReference title: git_file_reference description: Multiple features per entity. title: git_file_reference required: - gitFileReference - properties: schema: $ref: '#/components/schemas/synq.entities.custom.features.v1.Schema' title: schema description: Only one feature per entity. title: schema required: - schema - properties: sqlDefinition: $ref: >- #/components/schemas/synq.entities.custom.features.v1.SqlDefinition title: sql_definition description: Only one feature per entity. title: sql_definition required: - sqlDefinition title: Feature required: - entityId additionalProperties: false synq.entities.v1.Identifier: type: object oneOf: - properties: airflowDag: $ref: '#/components/schemas/synq.entities.v1.AirflowDagIdentifier' title: airflow_dag description: Airflow DAG identifier title: airflow_dag required: - airflowDag - properties: airflowTask: $ref: '#/components/schemas/synq.entities.v1.AirflowTaskIdentifier' title: airflow_task description: Airflow task identifier within a given DAG title: airflow_task required: - airflowTask - properties: athenaTable: $ref: '#/components/schemas/synq.entities.v1.AthenaTableIdentifier' title: athena_table description: Amazon Athena (Glue) table identifier title: athena_table required: - athenaTable - properties: bigqueryTable: $ref: '#/components/schemas/synq.entities.v1.BigqueryTableIdentifier' title: bigquery_table description: BigQuery table identifier title: bigquery_table required: - bigqueryTable - properties: clickhouseTable: $ref: '#/components/schemas/synq.entities.v1.ClickhouseTableIdentifier' title: clickhouse_table description: Clickhouse table identifier title: clickhouse_table required: - clickhouseTable - properties: custom: $ref: '#/components/schemas/synq.entities.v1.CustomIdentifier' title: custom description: Custom identifier to be used with all custom created entities title: custom required: - custom - properties: databricksTable: $ref: '#/components/schemas/synq.entities.v1.DatabricksTableIdentifier' title: databricks_table description: Databricks table identifier title: databricks_table required: - databricksTable - properties: dataproduct: $ref: '#/components/schemas/synq.entities.v1.DataproductIdentifier' title: dataproduct description: Dataproduct identifier title: dataproduct required: - dataproduct - properties: dbtCloudNode: $ref: '#/components/schemas/synq.entities.v1.DbtCloudNodeIdentifier' title: dbt_cloud_node description: >- Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project title: dbt_cloud_node required: - dbtCloudNode - properties: dbtCoreNode: $ref: '#/components/schemas/synq.entities.v1.DbtCoreNodeIdentifier' title: dbt_core_node description: >- Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project title: dbt_core_node required: - dbtCoreNode - properties: monitor: $ref: '#/components/schemas/synq.entities.v1.MonitorIdentifier' title: monitor description: Monitor identifier title: monitor required: - monitor - properties: mssqlTable: $ref: '#/components/schemas/synq.entities.v1.MssqlTableIdentifier' title: mssql_table description: SQL Server table identifier title: mssql_table required: - mssqlTable - properties: mysqlTable: $ref: '#/components/schemas/synq.entities.v1.MysqlTableIdentifier' title: mysql_table description: Mysql table identifier title: mysql_table required: - mysqlTable - properties: oracleTable: $ref: '#/components/schemas/synq.entities.v1.OracleTableIdentifier' title: oracle_table description: Oracle table identifier title: oracle_table required: - oracleTable - properties: postgresTable: $ref: '#/components/schemas/synq.entities.v1.PostgresTableIdentifier' title: postgres_table description: Postgres table identifier title: postgres_table required: - postgresTable - properties: redshiftTable: $ref: '#/components/schemas/synq.entities.v1.RedshiftTableIdentifier' title: redshift_table description: Redshift table identifier title: redshift_table required: - redshiftTable - properties: savedView: $ref: '#/components/schemas/synq.entities.v1.SavedViewIdentifier' title: saved_view description: Saved view identifier title: saved_view required: - savedView - properties: snowflakeTable: $ref: '#/components/schemas/synq.entities.v1.SnowflakeTableIdentifier' title: snowflake_table description: Snowflake table identifier title: snowflake_table required: - snowflakeTable - properties: sqlMeshAudit: $ref: '#/components/schemas/synq.entities.v1.SqlMeshAuditIdentifier' title: sql_mesh_audit description: SQLMesh Audit identifier title: sql_mesh_audit required: - sqlMeshAudit - properties: sqlMeshModel: $ref: '#/components/schemas/synq.entities.v1.SqlMeshModelIdentifier' title: sql_mesh_model description: SQLMesh Model identifier title: sql_mesh_model required: - sqlMeshModel - properties: synqPath: $ref: '#/components/schemas/synq.entities.v1.SynqPathIdentifier' title: synq_path description: SynqPath identifier title: synq_path required: - synqPath - properties: trinoTable: $ref: '#/components/schemas/synq.entities.v1.TrinoTableIdentifier' title: trino_table description: Trino table identifier title: trino_table required: - trinoTable additionalProperties: false description: >- Identifier is a unique reference to an entity in Coalesce Quality 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. google.protobuf.Timestamp: type: string examples: - '2023-01-15T01:30:15.01Z' - '2024-12-25T12:00:00Z' format: date-time description: >- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. synq.entities.custom.features.v1.CheckCategory: type: object properties: package: type: string maxLength: 50 description: Grouping of check kinds. e.g. "gcs", "sql", "queue" kind: type: string maxLength: 50 description: >- Kind of the check. e.g "not_null", "unique", "foreign_key", "row_count". category: type: string maxLength: 50 description: >- Explicit name of the Check category. If it is not defined categorisation rules are applied based on package + kind. nullable: true title: CheckCategory required: - kind additionalProperties: false description: >- 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. synq.entities.custom.features.v1.Code: type: object properties: name: type: string maxLength: 50 description: Might be e.g. name of the file or a function. codeType: $ref: '#/components/schemas/synq.entities.v1.CodeType' description: Type of the code. content: type: string maxLength: 100000 description: Content of the code. Displayed in the UI. title: Code additionalProperties: false description: |- Code feature represents a code snippet associated with the entity. If support for code parsing and dependency extraction is needed use [SqlDefinition](sql_definition.proto). synq.entities.custom.features.v1.GitFileReference: type: object properties: repositoryUrl: type: string maxLength: 255 minLength: 1 description: URL of the git repository. Preferably SSH clone URL. branchName: type: string description: | Name of the branch in the git repository. string.max_bytes = 244 filePath: type: string maxLength: 255 minLength: 1 description: Path to the file in the git repository. title: GitFileReference required: - repositoryUrl - branchName - filePath additionalProperties: false description: GitFileReference represents a reference to a file in a git repository. synq.entities.custom.features.v1.Schema: type: object properties: stateAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the schema was defined, will default to `now` if not set. columns: type: array items: $ref: '#/components/schemas/synq.entities.v1.SchemaColumn' maxItems: 1000 description: |- 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. title: Schema additionalProperties: false description: Schema represents a schema of a table like entity synq.entities.custom.features.v1.SqlDefinition: type: object properties: stateAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the sql was defined, will default to `now` if not set. dialect: $ref: '#/components/schemas/synq.entities.v1.SqlDialect' description: SQL dialect used in the SQL. sql: type: string maxLength: 1000000 description: >- Final form of the SQL as executed in the database/data warehouse. Must be a valid SQL in the selected dialect. databaseContext: $ref: '#/components/schemas/synq.entities.coordinates.v1.DatabaseContext' description: >- Optional database context for resolving unqualified table references in the SQL. When provided, helps CLL resolve schema-qualified references (e.g. `PROD.TABLE_NAME`) to the correct database instance and catalog. nullable: true title: SqlDefinition additionalProperties: false description: >- 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`. synq.entities.v1.AirflowDagIdentifier: type: object properties: integrationId: type: string description: Coalesce Quality integration_id that identifies the Airflow instance dagId: type: string description: Airflow dag_id that identifies the DAG title: AirflowDagIdentifier required: - integrationId - dagId additionalProperties: false synq.entities.v1.AirflowTaskIdentifier: type: object properties: integrationId: type: string description: Coalesce Quality integration_id that identifies the Airflow instance dagId: type: string description: Airflow dag_id that identifies the DAG taskId: type: string description: Airflow task_id that identifies the task within the DAG title: AirflowTaskIdentifier required: - integrationId - dagId - taskId additionalProperties: false synq.entities.v1.AthenaTableIdentifier: type: object properties: instance: type: string description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. catalog: type: string description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. database: type: string description: Glue database (the namespace users typically filter on). table: type: string description: Glue table or view name. title: AthenaTableIdentifier required: - instance - catalog - database - table additionalProperties: false synq.entities.v1.BigqueryTableIdentifier: type: object properties: project: type: string description: BigQuery project dataset: type: string description: BigQuery dataset id table: type: string description: BigQuery table name title: BigqueryTableIdentifier required: - project - dataset - table additionalProperties: false synq.entities.v1.ClickhouseTableIdentifier: type: object properties: host: type: string description: Clickhouse hostname without port schema: type: string description: Clickhouse database table: type: string description: Clickhouse table title: ClickhouseTableIdentifier required: - host - schema - table additionalProperties: false synq.entities.v1.CustomIdentifier: type: object properties: id: type: string description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. title: CustomIdentifier required: - id additionalProperties: false synq.entities.v1.DatabricksTableIdentifier: type: object properties: workspace: type: string description: URL of Databricks workspace catalog: type: string description: Databricks catalog schema: type: string description: Databricks schema table: type: string description: Databricks table or view title: DatabricksTableIdentifier required: - workspace - catalog - schema - table additionalProperties: false synq.entities.v1.DataproductIdentifier: type: object properties: id: type: string format: uuid description: Dataproduct id that identifies the Dataproduct title: DataproductIdentifier required: - id additionalProperties: false synq.entities.v1.DbtCloudNodeIdentifier: type: object properties: projectId: type: string description: Your dbt Cloud project id accountId: type: string description: Your dbt Cloud account id nodeId: type: string description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) title: DbtCloudNodeIdentifier required: - projectId - nodeId additionalProperties: false synq.entities.v1.DbtCoreNodeIdentifier: type: object properties: integrationId: type: string format: uuid description: Coalesce Quality integration_id that identifies the dbt Core project nodeId: type: string description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) title: DbtCoreNodeIdentifier required: - integrationId - nodeId additionalProperties: false synq.entities.v1.MonitorIdentifier: type: object properties: monitoredId: $ref: '#/components/schemas/synq.entities.v1.Identifier' description: Identifier of the monitored entity monitorId: type: string description: Identifier of the monitor segment: type: string description: Optional monitor segmentation identifier nullable: true integrationId: type: string description: Coalesce Quality integration_id of the monitored identifier nullable: true deprecated: true title: MonitorIdentifier required: - monitoredId - monitorId additionalProperties: false synq.entities.v1.MssqlTableIdentifier: type: object properties: host: type: string description: Hostname of the SQL Server instance database: type: string description: SQL Server database schema: type: string description: SQL Server schema (e.g. "dbo") table: type: string description: SQL Server table or view title: MssqlTableIdentifier required: - host - database - schema - table additionalProperties: false synq.entities.v1.MysqlTableIdentifier: type: object properties: host: type: string description: Mysql hostname without port schema: type: string description: Mysql database table: type: string description: Mysql table title: MysqlTableIdentifier required: - host - schema - table additionalProperties: false synq.entities.v1.OracleTableIdentifier: type: object properties: host: type: string description: Hostname of the Oracle instance serviceName: type: string description: Oracle service name (PDB) schema: type: string description: Oracle schema (= owning user) table: type: string description: Oracle table or view title: OracleTableIdentifier required: - host - serviceName - schema - table additionalProperties: false synq.entities.v1.PostgresTableIdentifier: type: object properties: host: type: string description: Postgres hostname without port database: type: string description: Postgres database schema: type: string description: Postgres schema table: type: string description: Postgres table title: PostgresTableIdentifier required: - host - database - schema - table additionalProperties: false synq.entities.v1.RedshiftTableIdentifier: type: object properties: cluster: type: string description: Redshift cluster database: type: string description: Redshift database schema: type: string description: Redshift schema table: type: string description: Redshift table title: RedshiftTableIdentifier required: - database - schema - table additionalProperties: false synq.entities.v1.SavedViewIdentifier: type: object properties: id: type: string format: uuid description: Saved view id (client-supplied UUID) that identifies the saved view title: SavedViewIdentifier required: - id additionalProperties: false synq.entities.v1.SnowflakeTableIdentifier: type: object properties: account: type: string description: Snowflake account database: type: string description: Snowflake database schema: type: string description: Snowflake schema table: type: string description: Snowflake table title: SnowflakeTableIdentifier required: - account - database - schema - table additionalProperties: false synq.entities.v1.SqlMeshAuditIdentifier: type: object properties: integrationId: type: string format: uuid description: Coalesce Quality integration_id that identifies the dbt Core project fqn: type: string description: SQLMesh model fully qualified name auditId: type: string description: Identifier of the audit title: SqlMeshAuditIdentifier required: - integrationId - fqn - auditId additionalProperties: false synq.entities.v1.SqlMeshModelIdentifier: type: object properties: integrationId: type: string format: uuid description: Coalesce Quality integration_id that identifies the dbt Core project fqn: type: string description: SQLMesh model fully qualified name title: SqlMeshModelIdentifier required: - integrationId - fqn additionalProperties: false synq.entities.v1.SynqPathIdentifier: type: object properties: path: type: string description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths title: SynqPathIdentifier required: - path additionalProperties: false synq.entities.v1.TrinoTableIdentifier: type: object properties: host: type: string description: Hostname of the Trino instance catalog: type: string description: Trino catalog schema: type: string description: Trino schema table: type: string description: Trino table or view title: TrinoTableIdentifier required: - host - catalog - schema - table additionalProperties: false synq.entities.v1.CodeType: type: string title: CodeType enum: - CODE_TYPE_UNSPECIFIED - CODE_TYPE_SQL - CODE_TYPE_PYTHON - CODE_TYPE_JSON - CODE_TYPE_YAML - CODE_TYPE_DBT - CODE_TYPE_SQLMESH - CODE_TYPE_LOOKML description: >- CodeType enum represents different types of code that can be processed in the Coalesce Quality platform synq.entities.v1.SchemaColumn: type: object properties: name: type: string maxLength: 255 minLength: 1 description: >- Human readable name of the column as present in dbt or data warehouse. nativeType: type: string maxLength: 255 description: Native data type of the column as present in data warehouse. description: type: string maxLength: 1000 description: Description of the column ordinalPosition: type: integer maximum: 1001 minimum: 0 format: int32 description: Ordinal position of the column in the table, starting from 1 isStruct: type: boolean description: >- Indicates that the column type could be used as a struct/json in a data warehouse isRepeated: type: boolean description: >- Indicates that the column is a repeated field in a data warehouse (e.g. array) fields: type: array items: $ref: '#/components/schemas/synq.entities.v1.SchemaColumnField' maxItems: 100 description: Fields inside of the struct/record like column title: SchemaColumn required: - name additionalProperties: false synq.entities.v1.SqlDialect: type: string title: SqlDialect enum: - SQL_DIALECT_UNSPECIFIED - SQL_DIALECT_BIGQUERY - SQL_DIALECT_CLICKHOUSE - SQL_DIALECT_DATABRICKS - SQL_DIALECT_MYSQL - SQL_DIALECT_POSTGRESQL - SQL_DIALECT_REDSHIFT - SQL_DIALECT_SNOWFLAKE - SQL_DIALECT_DUCKDB - SQL_DIALECT_TRINO - SQL_DIALECT_MSSQL - SQL_DIALECT_ORACLE - SQL_DIALECT_ATHENA synq.entities.coordinates.v1.DatabaseContext: type: object properties: instanceName: type: string description: >- Instance identifier (e.g. Snowflake account, Databricks workspace URL, BigQuery project) databaseName: type: string description: Database or catalog name schemaName: type: string description: Schema name objectName: type: string description: >- Object name (e.g. table or view name) that the SQL writes to or creates. Only set when the SQL defines or materializes an object, e.g. `CREATE TABLE AS SELECT ...`. Leave empty for read-only SQL such as dashboard queries or SELECT statements. title: DatabaseContext additionalProperties: false description: |- DatabaseContext provides the default database execution context for resolving unqualified references (e.g. table names in SQL). synq.entities.v1.SchemaColumnField: type: object properties: name: type: string maxLength: 255 minLength: 1 description: >- Human readable name of the column as present in dbt or data warehouse. nativeType: type: string maxLength: 255 description: Native data type of the column as present in data warehouse. description: type: string maxLength: 1000 description: Description of the column ordinalPosition: type: integer maximum: 1001 minimum: 0 format: int32 description: Ordinal position of the column in the struct, starting from 1 isStruct: type: boolean description: >- Indicates that the field type could be used as a struct/json in a data warehouse isRepeated: type: boolean description: >- Indicates that the field is a repeated field in a data warehouse (e.g. array) fields: type: array items: $ref: '#/components/schemas/synq.entities.v1.SchemaColumnField' maxItems: 100 description: Fields inside of the struct/record like field title: SchemaColumnField required: - name additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer ````