- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- CompilationResultAction
- Relation
- RelationDescriptor
- ColumnDescriptor
- RelationType
- IncrementalTableConfig
- Operations
- Assertion
- Declaration
- Notebook
Returns CompilationResultActions in a given CompilationResult.
HTTP request
GET https://dataform.googleapis.com/v1beta1/{name=projects/*/locations/*/repositories/*/compilationResults/*}:query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The compilation result's name. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
pageToken |
Optional. Page token received from a previous When paginating, all other parameters provided to |
filter |
Optional. Optional filter for the returned list. Filtering is only currently supported on the |
Request body
The request body must be empty.
Response body
compilationResults.query
response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"compilationResultActions": [
{
object ( |
Fields | |
---|---|
compilationResultActions[] |
List of compilation result actions. |
nextPageToken |
A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
dataform.compilationResults.query
For more information, see the IAM documentation.
CompilationResultAction
Represents a single Dataform action in a compilation result.
JSON representation |
---|
{ "target": { object ( |
Fields | |
---|---|
target |
This action's identifier. Unique within the compilation result. |
canonicalTarget |
The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. |
filePath |
The full path including filename in which this action is located, relative to the workspace root. |
Union field
|
|
relation |
The database relation created/updated by this action. |
operations |
The database operations executed by this action. |
assertion |
The assertion executed by this action. |
declaration |
The declaration declared by this action. |
notebook |
The notebook executed by this action. |
Relation
Represents a database relation.
JSON representation |
---|
{ "dependencyTargets": [ { object ( |
Fields | |
---|---|
dependencyTargets[] |
A list of actions that this action depends on. |
disabled |
Whether this action is disabled (i.e. should not be run). |
tags[] |
Arbitrary, user-defined tags on this action. |
relationDescriptor |
Descriptor for the relation and its columns. |
relationType |
The type of this relation. |
selectQuery |
The SELECT query which returns rows which this relation should contain. |
preOperations[] |
SQL statements to be executed before creating the relation. |
postOperations[] |
SQL statements to be executed after creating the relation. |
incrementalTableConfig |
Configures |
partitionExpression |
The SQL expression used to partition the relation. |
clusterExpressions[] |
A list of columns or SQL expressions used to cluster the table. |
partitionExpirationDays |
Sets the partition expiration in days. |
requirePartitionFilter |
Specifies whether queries on this table must include a predicate filter that filters on the partitioning column. |
additionalOptions |
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. An object containing a list of |
RelationDescriptor
Describes a relation and its columns.
JSON representation |
---|
{
"description": string,
"columns": [
{
object ( |
Fields | |
---|---|
description |
A text description of the relation. |
columns[] |
A list of descriptions of columns within the relation. |
bigqueryLabels |
A set of BigQuery labels that should be applied to the relation. An object containing a list of |
ColumnDescriptor
Describes a column.
JSON representation |
---|
{ "path": [ string ], "description": string, "bigqueryPolicyTags": [ string ] } |
Fields | |
---|---|
path[] |
The identifier for the column. Each entry in |
description |
A textual description of the column. |
bigqueryPolicyTags[] |
A list of BigQuery policy tags that will be applied to the column. |
RelationType
Indicates the type of this relation.
Enums | |
---|---|
RELATION_TYPE_UNSPECIFIED |
Default value. This value is unused. |
TABLE |
The relation is a table. |
VIEW |
The relation is a view. |
INCREMENTAL_TABLE |
The relation is an incrementalized table. |
MATERIALIZED_VIEW |
The relation is a materialized view. |
IncrementalTableConfig
Contains settings for relations of type INCREMENTAL_TABLE
.
JSON representation |
---|
{ "incrementalSelectQuery": string, "refreshDisabled": boolean, "uniqueKeyParts": [ string ], "updatePartitionFilter": string, "incrementalPreOperations": [ string ], "incrementalPostOperations": [ string ] } |
Fields | |
---|---|
incrementalSelectQuery |
The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed. |
refreshDisabled |
Whether this table should be protected from being refreshed. |
uniqueKeyParts[] |
A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by |
updatePartitionFilter |
A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see |
incrementalPreOperations[] |
SQL statements to be executed before inserting new rows into the relation. |
incrementalPostOperations[] |
SQL statements to be executed after inserting new rows into the relation. |
Operations
Represents a list of arbitrary database operations.
JSON representation |
---|
{ "dependencyTargets": [ { object ( |
Fields | |
---|---|
dependencyTargets[] |
A list of actions that this action depends on. |
disabled |
Whether this action is disabled (i.e. should not be run). |
tags[] |
Arbitrary, user-defined tags on this action. |
relationDescriptor |
Descriptor for any output relation and its columns. Only set if |
queries[] |
A list of arbitrary SQL statements that will be executed without alteration. |
hasOutput |
Whether these operations produce an output relation. |
Assertion
Represents an assertion upon a SQL query which is required return zero rows.
JSON representation |
---|
{ "dependencyTargets": [ { object ( |
Fields | |
---|---|
dependencyTargets[] |
A list of actions that this action depends on. |
parentAction |
The parent action of this assertion. Only set if this assertion was automatically generated. |
disabled |
Whether this action is disabled (i.e. should not be run). |
tags[] |
Arbitrary, user-defined tags on this action. |
selectQuery |
The SELECT query which must return zero rows in order for this assertion to succeed. |
relationDescriptor |
Descriptor for the assertion's automatically-generated view and its columns. |
Declaration
Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.
JSON representation |
---|
{
"relationDescriptor": {
object ( |
Fields | |
---|---|
relationDescriptor |
Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata. |
Notebook
JSON representation |
---|
{
"dependencyTargets": [
{
object ( |
Fields | |
---|---|
dependencyTargets[] |
A list of actions that this action depends on. |
disabled |
Whether this action is disabled (i.e. should not be run). |
contents |
The contents of the notebook. |
tags[] |
Arbitrary, user-defined tags on this action. |