Google Cloud Dataform V1beta1 Client - Class Relation (0.3.0)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class Relation.

Represents a database relation.

Generated from protobuf message google.cloud.dataform.v1beta1.CompilationResultAction.Relation

Namespace

Google \ Cloud \ Dataform \ V1beta1 \ CompilationResultAction

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dependency_targets array<Google\Cloud\Dataform\V1beta1\Target>

A list of actions that this action depends on.

↳ disabled bool

Whether this action is disabled (i.e. should not be run).

↳ tags array

Arbitrary, user-defined tags on this action.

↳ relation_descriptor Google\Cloud\Dataform\V1beta1\RelationDescriptor

Descriptor for the relation and its columns.

↳ relation_type int

The type of this relation.

↳ select_query string

The SELECT query which returns rows which this relation should contain.

↳ pre_operations array

SQL statements to be executed before creating the relation.

↳ post_operations array

SQL statements to be executed after creating the relation.

↳ incremental_table_config Google\Cloud\Dataform\V1beta1\CompilationResultAction\Relation\IncrementalTableConfig

Configures INCREMENTAL_TABLE settings for this relation. Only set if relation_type is INCREMENTAL_TABLE.

↳ partition_expression string

The SQL expression used to partition the relation.

↳ cluster_expressions array

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 array|Google\Protobuf\Internal\MapField

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.

getDependencyTargets

A list of actions that this action depends on.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDependencyTargets

A list of actions that this action depends on.

Parameter
NameDescription
var array<Google\Cloud\Dataform\V1beta1\Target>
Returns
TypeDescription
$this

getDisabled

Whether this action is disabled (i.e. should not be run).

Returns
TypeDescription
bool

setDisabled

Whether this action is disabled (i.e. should not be run).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getTags

Arbitrary, user-defined tags on this action.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTags

Arbitrary, user-defined tags on this action.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getRelationDescriptor

Descriptor for the relation and its columns.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\RelationDescriptor|null

hasRelationDescriptor

clearRelationDescriptor

setRelationDescriptor

Descriptor for the relation and its columns.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\RelationDescriptor
Returns
TypeDescription
$this

getRelationType

The type of this relation.

Returns
TypeDescription
int

setRelationType

The type of this relation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSelectQuery

The SELECT query which returns rows which this relation should contain.

Returns
TypeDescription
string

setSelectQuery

The SELECT query which returns rows which this relation should contain.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPreOperations

SQL statements to be executed before creating the relation.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPreOperations

SQL statements to be executed before creating the relation.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getPostOperations

SQL statements to be executed after creating the relation.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPostOperations

SQL statements to be executed after creating the relation.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getIncrementalTableConfig

Configures INCREMENTAL_TABLE settings for this relation. Only set if relation_type is INCREMENTAL_TABLE.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\CompilationResultAction\Relation\IncrementalTableConfig|null

hasIncrementalTableConfig

clearIncrementalTableConfig

setIncrementalTableConfig

Configures INCREMENTAL_TABLE settings for this relation. Only set if relation_type is INCREMENTAL_TABLE.

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\CompilationResultAction\Relation\IncrementalTableConfig
Returns
TypeDescription
$this

getPartitionExpression

The SQL expression used to partition the relation.

Returns
TypeDescription
string

setPartitionExpression

The SQL expression used to partition the relation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClusterExpressions

A list of columns or SQL expressions used to cluster the table.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setClusterExpressions

A list of columns or SQL expressions used to cluster the table.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getPartitionExpirationDays

Sets the partition expiration in days.

Returns
TypeDescription
int

setPartitionExpirationDays

Sets the partition expiration in days.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRequirePartitionFilter

Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.

Returns
TypeDescription
bool

setRequirePartitionFilter

Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAdditionalOptions

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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAdditionalOptions

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this