You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If true, this indicates that the action only depends on data from explicitly-declared dependencies. Otherwise if false, it indicates that the action depends on data from a source which has not been declared as a dependency.
Optional. Key-value pairs for BigQuery job labels applied to the query job(s) executed for this assertion. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. See defaultJobLabels for the allowed keys and values.
Optional. Key-value pairs for BigQuery job labels applied to the BigQuery job(s) executed for this data preparation. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. See defaultJobLabels for the allowed keys and values.
If set, unique key represents a set of names of columns that will act as a the unique key. To enforce this, when updating the incremental table, Dataform merges rows with uniqueKey instead of appending them.
The number of days for which BigQuery stores data in each partition. The setting applies to all partitions in a table, but is calculated independently for each partition based on the partition time.
Key-value pairs of additional options to pass to the BigQuery API. Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
If true, this indicates that the action only depends on data from explicitly-declared dependencies. Otherwise if false, it indicates that the action depends on data from a source which has not been declared as a dependency.
Optional. Key-value pairs for BigQuery job labels applied to the query job(s) executed for this incremental table and its built-in assertions. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. When the table has any job labels, including defaults, the Dataform CLI doesn't also apply its labels to its jobs. See defaultJobLabels for the allowed keys and values.
If true, this indicates that the action only depends on data from explicitly-declared dependencies. Otherwise if false, it indicates that the action depends on data from a source which has not been declared as a dependency.
Optional. Key-value pairs for BigQuery job labels applied to the query job(s) executed for this operation. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. See defaultJobLabels for the allowed keys and values.
Column(s) which constitute the dataset's unique key index. If set, the resulting assertion will fail if there is more than one row in the dataset with the same values for all of these column(s).
General condition(s) which should hold true for all rows in the dataset. If set, the resulting assertion will fail if any row violates any of these condition(s).
ActionConfig.TableAssertionsConfig.UniqueKey
Combinations of column(s), each of which should constitute a unique key
index for the dataset. If set, the resulting assertion(s) will fail if
there is more than one row in the dataset with the same values for all of
the column(s) in the unique key(s).
The number of days for which BigQuery stores data in each partition. The setting applies to all partitions in a table, but is calculated independently for each partition based on the partition time.
Key-value pairs of additional options to pass to the BigQuery API. Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
If true, this indicates that the action only depends on data from explicitly-declared dependencies. Otherwise if false, it indicates that the action depends on data from a source which has not been declared as a dependency.
Optional. Key-value pairs for BigQuery job labels applied to the query job(s) executed for this table and its built-in assertions. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. When the table has any job labels, including defaults, the Dataform CLI doesn't also apply its labels to its jobs. See defaultJobLabels for the allowed keys and values.
Key-value pairs of additional options to pass to the BigQuery API. Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
If true, this indicates that the action only depends on data from explicitly-declared dependencies. Otherwise if false, it indicates that the action depends on data from a source which has not been declared as a dependency.
Optional. Key-value pairs for BigQuery job labels applied to the query job(s) executed for this view and its built-in assertions. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. When the view has any job labels, including defaults, the Dataform CLI doesn't also apply its labels to its jobs. See defaultJobLabels for the allowed keys and values.
@dataform/core version to compile against (for example, 3.1.5). When set, the CLI installs this version into a copy of the project in a temporary directory and compiles the copy, which skips paths matched by .gitignore or .dataformignore outside definitions/ and includes/. For details, see https://dataform-co.github.io/dataform/docs/stateless-install.
Optional. Default BigQuery reservation for query execution (projects/<p>/locations/<l>/reservations/<r> or none). If unset, default BigQuery behavior applies. Dataform CLI only (GCP Dataform support pending).
Optional. Default labels applied to BigQuery jobs executed for actions in the project. Merged key-by-key when overridden via projectConfigOverride. Action-level jobLabels override matching keys; an action can't remove a default key. Built-in assertions use the job labels of their table. When an action has any job labels, including these defaults, the Dataform CLI doesn't also apply the table's labels to its jobs. dataform run --job-labels overrides matching keys. Keys and values can contain only lowercase ASCII letters, numbers, underscores and hyphens, and can be at most 63 characters long. Keys must start with a lowercase letter; values can be empty. An action can have at most 32 job labels, including these defaults. Keys that start with dataform_, dataform-, dataprep-, gcp- or goog- are reserved, as are bigquery-workflow, single-file-asset-type, origin, bq-dea and data-preparation-file-loader. Numbers and booleans are converted to strings, so quote values that must be kept exactly as written, for example "0042".
Defines the configuration schema for BigQuery Property Graph YAML files (definitions/**/graph.yaml), aligned with the Google Semantic Ontology V1 specification (version: 0.2.0.dev0/google). At most one graph.yaml file is allowed per project in V1. Both snake_case (recommended in graph.yaml, e.g. semantic_model, primary_key, from_columns, to_columns, ai_context, custom_extensions, job_labels, depend_on_dependency_assertions, include_dependent_assertions) and camelCase keys are accepted.
DataSourceRef
Reference to another Dataform action as a backing table source (source: { ref: ... }). In graph.yaml, a string shorthand source: { ref: "<action_name>" } is also accepted and normalized to { name: "<action_name>" }.
Optional (include_dependent_assertions in YAML). If true, depends on assertions of the target action.
GraphAiContextConfig
AI context metadata attached to a semantic model, entity, relationship, field, or metric (ai_context in graph.yaml). On entities and relationships, DEFAULT LABEL OPTIONS(...) is emitted before PROPERTIES (...), PROPERTIES ALL COLUMNS, or NO PROPERTIES. On entities, relationships, fields, and metrics, synonyms map to OPTIONS(synonyms=[...]), while non-empty instructions and JSON-serialized examples map to OPTIONS(extensions=[("instructions", "..."), ("examples", "[...]")]). Model-level ai_context populates PropertyGraph.description only.
Optional. Example values or questions emitted as a JSON-serialized array in OPTIONS(extensions=[("examples", "[...]")]) on labels, fields, and metrics (and folded into PropertyGraph.description on semantic_model).
Optional. Free-form AI instructions emitted as OPTIONS(extensions=[("instructions", "...")]) on labels, fields, and metrics (and folded into PropertyGraph.description on semantic_model).
Optional. Opaque mapping of custom AI context member names to arbitrary JSON/YAML values (preserving nested snake_case keys verbatim). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
GraphCustomExtensionConfig
Vendor-scoped custom extension metadata block attached to a semantic model, entity, relationship, field, or metric (custom_extensions in graph.yaml). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
Required (vendor_name in YAML). Non-empty third-party vendor identifier ("GOOGLE" in any casing is rejected in 0.2.0.dev0/google documents, where Google extensions are declared as native keys).
Required. Opaque vendor-specific extension payload. In graph.yaml, either an opaque string (typically JSON, preserved verbatim) or a plain mapping object (normalized to a JSON string with nested keys preserved verbatim) is accepted.
GraphDeploymentConfig
Deployment target mapping for a semantic model (deployments in graph.yaml). At most one deployment is supported in V1; when omitted, the property graph is deployed to the project's default database and default schema with the semantic_model.name.
Required. Target BigQuery property graph resource URI (bigquery.googleapis.com/projects/<project>/datasets/<dataset>/propertyGraphs/<graph>). Leading // is rejected. Sets the base project, dataset, and graph name on the Dataform action target; Dataform session overrides (databaseSuffix, schemaSuffix, namePrefix) still apply when resolving the final target.
GraphDimensionConfig
Dimension metadata for a property field on an entity (dimension in graph.yaml). In graph.yaml, a boolean shorthand dimension: true is also accepted and normalized to { is_time: true }.
Backing table reference when source in graph.yaml is a string (bigquery:<project>.<dataset>.<table>, <project>.<dataset>.<table>, or bigquery.googleapis.com/projects/<project>/datasets/<dataset>/tables/<table>; leading // is rejected). Mutually exclusive with sourceRef.
Required (primary_key in YAML; accepts a single string or list of strings). Physical primary key column name(s) identifying rows of this entity, emitted in KEY (...).
Secondary unique key column lists (unique_keys in YAML). Not supported in V1 because BigQuery CREATE PROPERTY GRAPH DDL supports only a single KEY(...) clause.
Optional. Properties exposed on the entity node table (PROPERTIES (...)). In graph.yaml, each item may be a bare column name string "col" or a GraphFieldConfig object. When omitted (and no metrics target the entity), PROPERTIES ALL COLUMNS is emitted. Required when one or more metrics target the entity.
Optional (custom_extensions in YAML). Vendor-scoped custom extension metadata blocks (vendor_name must not be "GOOGLE" in 0.2.0.dev0/google documents). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
GraphFieldConfig
A property field definition on an entity (fields in graph.yaml). In graph.yaml, a bare string "col" is shorthand for { name: "col", expression: "col" }.
Optional. SQL expression computing the property value; defaults to name. Passed through as-is into BigQuery DDL (<expression> AS <name> when distinct from name).
Optional (custom_extensions in YAML). Vendor-scoped custom extension metadata blocks (vendor_name must not be "GOOGLE" in 0.2.0.dev0/google documents). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
GraphMetricConfig
A top-level aggregate metric definition (metrics in graph.yaml), compiled as a MEASURE(<expression>) AS <name> property inside the target entity's PROPERTIES (...) list.
Required. Unique metric name within the semantic model (must be a valid identifier and must not collide case-insensitively with any declared field on the target entity).
Required. SQL aggregate or derived measure expression passed through as-is into MEASURE(<expression>) AS <name> (supporting SUM, AVG, COUNT(<property>), MIN, MAX, DISTINCT, CASE WHEN, scalar arithmetic, and derived sibling measures via AGG(<sibling_metric>)). COUNT(*) and literal-only counts such as COUNT(1) are rejected at compile time because BigQuery requires every measure to aggregate at least one graph property.
Optional (custom_extensions in YAML). Vendor-scoped custom extension metadata blocks (vendor_name must not be "GOOGLE" in 0.2.0.dev0/google documents). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
GraphRelationshipConfig
An edge relationship definition connecting two entities in the semantic model (relationships in graph.yaml). Each relationship is a 1:N foreign-key edge from from to to, backed by the from entity's table and primary_key, and compiles to a BigQuery EDGE TABLES entry with NO PROPERTIES in V1.
Required (from_columns in YAML; accepts a single string or list of strings). Physical foreign-key column name(s) on the from entity table emitted in DESTINATION KEY (<from_columns>) REFERENCES <to> (<to_columns>).
Required (to_columns in YAML; accepts a single string or list of strings). Referenced key column(s) on the to entity table (must match <to>.primary_key).
Optional (custom_extensions in YAML). Vendor-scoped custom extension metadata blocks (vendor_name must not be "GOOGLE" in 0.2.0.dev0/google documents). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.
GraphUniqueKeyList
Wrapper for a single composite unique key column list on an entity (unique_keys in graph.yaml). Accepted by the parser so V1 validation can report an explicit unsupported error.
Top-level configuration for a Dataform BigQuery Property Graph YAML file (definitions/**/graph.yaml), aligned with the Google Semantic Ontology V1 specification (version: 0.2.0.dev0/google).
Optional (depend_on_dependency_assertions in YAML). If true, assertions dependent upon any of the graph's referenced dependencies are added as dependencies of this property graph action.
Optional (job_labels in YAML). Key-value pairs for BigQuery job labels applied to the query job(s) executed for this property graph. Overrides matching keys from defaultJobLabels in workflow_settings.yaml. See defaultJobLabels for the allowed keys and values.
Optional. Human-readable description of the semantic model. Populates Dataform's action metadata (PropertyGraph.description) only and has no effect on the generated BigQuery DDL (BigQuery CREATE PROPERTY GRAPH does not support graph-level OPTIONS).
Optional (ai_context in YAML). AI context metadata for the model. instructions and examples are folded into Dataform's action metadata (PropertyGraph.description) only; model-level ai_context has no effect on the generated BigQuery DDL.
Optional (custom_extensions in YAML). Vendor-scoped custom extension metadata blocks (vendor_name must not be "GOOGLE" in 0.2.0.dev0/google documents). Accepted for Knowledge Catalog compatibility and omitted from generated BigQuery DDL.