Class Relation (0.10.0)

Relation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a database relation.

Attributes

Name Description
dependency_targets MutableSequence[google.cloud.dataform_v1.types.Target]
A list of actions that this action depends on.
disabled bool
Whether this action is disabled (i.e. should not be run).
tags MutableSequence[str]
Arbitrary, user-defined tags on this action.
relation_descriptor google.cloud.dataform_v1.types.RelationDescriptor
Descriptor for the relation and its columns.
relation_type google.cloud.dataform_v1.types.CompilationResultAction.Relation.RelationType
The type of this relation.
select_query str
The SELECT query which returns rows which this relation should contain.
pre_operations MutableSequence[str]
SQL statements to be executed before creating the relation.
post_operations MutableSequence[str]
SQL statements to be executed after creating the relation.
incremental_table_config google.cloud.dataform_v1.types.CompilationResultAction.Relation.IncrementalTableConfig
Configures INCREMENTAL_TABLE settings for this relation. Only set if relation_type is INCREMENTAL_TABLE.
partition_expression str
The SQL expression used to partition the relation.
cluster_expressions MutableSequence[str]
A list of columns or SQL expressions used to cluster the table.
partition_expiration_days int
Sets the partition expiration in days.
require_partition_filter bool
Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.
additional_options MutableMapping[str, str]
Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.
connection str
Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form {project}.{location}.{connection_id} or projects/{project}/locations/{location}/connections/{connection_id}, or be set to DEFAULT.
table_format google.cloud.dataform_v1.types.CompilationResultAction.Relation.TableFormat
Optional. The table format for the BigQuery table.
file_format google.cloud.dataform_v1.types.CompilationResultAction.Relation.FileFormat
Optional. The file format for the BigQuery table.
storage_uri str
Optional. The fully qualified location prefix of the external folder where table data is stored. The URI should be in the format gs://bucket/path_to_table/.

Classes

AdditionalOptionsEntry

AdditionalOptionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

FileFormat

FileFormat(value)

Supported file formats for BigQuery tables.

IncrementalTableConfig

IncrementalTableConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Contains settings for relations of type INCREMENTAL_TABLE.

RelationType

RelationType(value)

Indicates the type of this relation.

TableFormat

TableFormat(value)

Supported table formats for BigQuery tables.