Skip to content

Commit a918c0c

Browse files
author
Elias Kassell
authored
Remove some outdated configs references, fix generated formatting (#1799)
1 parent e5316d5 commit a918c0c

2 files changed

Lines changed: 19 additions & 68 deletions

File tree

‎docs/configs-reference.md‎

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,8 @@ Action config defines the contents of `actions.yaml` configuration files.
168168
| requirePartitionFilter | [bool](#bool) | | Declares whether the partitioned table requires a WHERE clause predicate filter that filters the partitioning column. |
169169
| updatePartitionFilter | [string](#string) | | SQL-based filter for when incremental updates are applied. |
170170
| clusterBy | [string](#string) | repeated | The keys by which to cluster partitions by. See https://cloud.google.com/dataform/docs/partitions-clusters. |
171-
| labels | [ActionConfig.IncrementalTableConfig.LabelsEntry](#dataform-ActionConfig-IncrementalTableConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. If the label name contains special characters, e.g. hyphens, then quote its name, e.g. `labels: { "label-name": "value" }`. |
172-
| additionalOptions | [ActionConfig.IncrementalTableConfig.AdditionalOptionsEntry](#dataform-ActionConfig-IncrementalTableConfig-AdditionalOptionsEntry) | repeated | Key-value pairs of additional options to pass to the BigQuery API.
173-
174-
Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
175-
176-
String values must be encapsulated in double-quotes, for example: additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
177-
178-
If the option name contains special characters, encapsulate the name in quotes, for example: additionalOptions: { "option-name": "value" }. |
171+
| labels | [ActionConfig.IncrementalTableConfig.LabelsEntry](#dataform-ActionConfig-IncrementalTableConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. |
172+
| additionalOptions | [ActionConfig.IncrementalTableConfig.AdditionalOptionsEntry](#dataform-ActionConfig-IncrementalTableConfig-AdditionalOptionsEntry) | repeated | 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. |
179173
| dependOnDependencyAssertions | [bool](#bool) | | When set to true, assertions dependent upon any dependency will be add as dedpendency to this action |
180174
| assertions | [ActionConfig.TableAssertionsConfig](#dataform-ActionConfig-TableAssertionsConfig) | | Assertions to be run on the dataset. If configured, relevant assertions will automatically be created and run as a dependency of this dataset. |
181175
| hermetic | [bool](#bool) | | 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. |
@@ -326,14 +320,8 @@ the column(s) in the unique key(s).
326320
| partitionExpirationDays | [int32](#int32) | | 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. |
327321
| requirePartitionFilter | [bool](#bool) | | Declares whether the partitioned table requires a WHERE clause predicate filter that filters the partitioning column. |
328322
| clusterBy | [string](#string) | repeated | The keys by which to cluster partitions by. See https://cloud.google.com/dataform/docs/partitions-clusters. |
329-
| labels | [ActionConfig.TableConfig.LabelsEntry](#dataform-ActionConfig-TableConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. If the label name contains special characters, e.g. hyphens, then quote its name, e.g. `labels: { "label-name": "value" }`. |
330-
| additionalOptions | [ActionConfig.TableConfig.AdditionalOptionsEntry](#dataform-ActionConfig-TableConfig-AdditionalOptionsEntry) | repeated | Key-value pairs of additional options to pass to the BigQuery API.
331-
332-
Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
333-
334-
String values must be encapsulated in double-quotes, for example: additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
335-
336-
If the option name contains special characters, encapsulate the name in quotes, for example: additionalOptions: { "option-name": "value" }. |
323+
| labels | [ActionConfig.TableConfig.LabelsEntry](#dataform-ActionConfig-TableConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. |
324+
| additionalOptions | [ActionConfig.TableConfig.AdditionalOptionsEntry](#dataform-ActionConfig-TableConfig-AdditionalOptionsEntry) | repeated | 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. |
337325
| dependOnDependencyAssertions | [bool](#bool) | | When set to true, assertions dependent upon any dependency will be add as dedpendency to this action |
338326
| assertions | [ActionConfig.TableAssertionsConfig](#dataform-ActionConfig-TableAssertionsConfig) | | Assertions to be run on the dataset. If configured, relevant assertions will automatically be created and run as a dependency of this dataset. |
339327
| hermetic | [bool](#bool) | | 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. |
@@ -413,14 +401,8 @@ Target represents a unique action identifier.
413401
| materialized | [bool](#bool) | | Applies the materialized view optimization, see https://cloud.google.com/bigquery/docs/materialized-views-intro. |
414402
| description | [string](#string) | | Description of the view. |
415403
| columns | [ActionConfig.ColumnDescriptor](#dataform-ActionConfig-ColumnDescriptor) | repeated | Descriptions of columns within the table. |
416-
| labels | [ActionConfig.ViewConfig.LabelsEntry](#dataform-ActionConfig-ViewConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. If the label name contains special characters, e.g. hyphens, then quote its name, e.g. `labels: { "label-name": "value" }`. |
417-
| additionalOptions | [ActionConfig.ViewConfig.AdditionalOptionsEntry](#dataform-ActionConfig-ViewConfig-AdditionalOptionsEntry) | repeated | Key-value pairs of additional options to pass to the BigQuery API.
418-
419-
Some options, for example, partitionExpirationDays, have dedicated type/validity checked fields. For such options, use the dedicated fields.
420-
421-
String values must be encapsulated in double-quotes, for example: additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
422-
423-
If the option name contains special characters, encapsulate the name in quotes, for example: additionalOptions: { "option-name": "value" }. |
404+
| labels | [ActionConfig.ViewConfig.LabelsEntry](#dataform-ActionConfig-ViewConfig-LabelsEntry) | repeated | Key-value pairs for BigQuery labels. |
405+
| additionalOptions | [ActionConfig.ViewConfig.AdditionalOptionsEntry](#dataform-ActionConfig-ViewConfig-AdditionalOptionsEntry) | repeated | 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. |
424406
| dependOnDependencyAssertions | [bool](#bool) | | When set to true, assertions dependent upon any dependency will be add as dedpendency to this action |
425407
| hermetic | [bool](#bool) | | 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. |
426408
| assertions | [ActionConfig.TableAssertionsConfig](#dataform-ActionConfig-TableAssertionsConfig) | | Assertions to be run on the dataset. If configured, relevant assertions will automatically be created and run as a dependency of this dataset. |
@@ -506,7 +488,7 @@ configuration file.
506488
| defaultDataset | [string](#string) | | Required. The default dataset (schema). |
507489
| defaultLocation | [string](#string) | | Required. The default BigQuery location to use. For more information on BigQuery locations, see https://cloud.google.com/bigquery/docs/locations. |
508490
| defaultAssertionDataset | [string](#string) | | Required. The default dataset (schema) for assertions. |
509-
| vars | [WorkflowSettings.VarsEntry](#dataform-WorkflowSettings-VarsEntry) | repeated | Optional. User-defined variables that are made available to project code during compilation. An object containing a list of "key": value pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
491+
| vars | [WorkflowSettings.VarsEntry](#dataform-WorkflowSettings-VarsEntry) | repeated | Optional. User-defined variables that are made available to project code during compilation. An object containing a list of "key": value pairs. |
510492
| projectSuffix | [string](#string) | | Optional. The suffix to append to all Google Cloud project references. |
511493
| datasetSuffix | [string](#string) | | Optional. The suffix to append to all dataset references. |
512494
| namePrefix | [string](#string) | | Optional. The prefix to append to all action names. |

‎protos/configs.proto‎

Lines changed: 12 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ message WorkflowSettings {
2929

3030
// Optional. User-defined variables that are made available to project code
3131
// during compilation. An object containing a list of "key": value pairs.
32-
// Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
3332
map<string, string> vars = 6;
3433

3534
// Optional. The suffix to append to all Google Cloud project references.
@@ -167,22 +166,12 @@ message ActionConfig {
167166
// https://cloud.google.com/dataform/docs/partitions-clusters.
168167
repeated string cluster_by = 15;
169168

170-
// Key-value pairs for BigQuery labels. If the label name contains special
171-
// characters, e.g. hyphens, then quote its name, e.g. `labels: {
172-
// "label-name": "value" }`.
169+
// Key-value pairs for BigQuery labels.
173170
map<string, string> labels = 16;
174171

175-
// Key-value pairs of additional options to pass to the BigQuery API.
176-
//
177-
// Some options, for example, partitionExpirationDays, have dedicated
178-
// type/validity checked fields. For such options, use the dedicated
179-
// fields.
180-
//
181-
// String values must be encapsulated in double-quotes, for example:
182-
// additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
183-
//
184-
// If the option name contains special characters, encapsulate the name in
185-
// quotes, for example: additionalOptions: { "option-name": "value" }.
172+
// Key-value pairs of additional options to pass to the BigQuery API. Some
173+
// options, for example, partitionExpirationDays, have dedicated
174+
// type/validity checked fields. For such options, use the dedicated fields.
186175
map<string, string> additional_options = 17;
187176

188177
// When set to true, assertions dependent upon any dependency will
@@ -242,22 +231,12 @@ message ActionConfig {
242231
// Descriptions of columns within the table.
243232
repeated ColumnDescriptor columns = 12;
244233

245-
// Key-value pairs for BigQuery labels. If the label name contains special
246-
// characters, e.g. hyphens, then quote its name, e.g. `labels: {
247-
// "label-name": "value" }`.
234+
// Key-value pairs for BigQuery labels.
248235
map<string, string> labels = 13;
249236

250-
// Key-value pairs of additional options to pass to the BigQuery API.
251-
//
252-
// Some options, for example, partitionExpirationDays, have dedicated
253-
// type/validity checked fields. For such options, use the dedicated
254-
// fields.
255-
//
256-
// String values must be encapsulated in double-quotes, for example:
257-
// additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
258-
//
259-
// If the option name contains special characters, encapsulate the name in
260-
// quotes, for example: additionalOptions: { "option-name": "value" }.
237+
// Key-value pairs of additional options to pass to the BigQuery API. Some
238+
// options, for example, partitionExpirationDays, have dedicated
239+
// type/validity checked fields. For such options, use the dedicated fields.
261240
map<string, string> additional_options = 14;
262241

263242
// When set to true, assertions dependent upon any dependency will
@@ -345,22 +324,12 @@ message ActionConfig {
345324
// https://cloud.google.com/dataform/docs/partitions-clusters.
346325
repeated string cluster_by = 18;
347326

348-
// Key-value pairs for BigQuery labels. If the label name contains special
349-
// characters, e.g. hyphens, then quote its name, e.g. `labels: {
350-
// "label-name": "value" }`.
327+
// Key-value pairs for BigQuery labels.
351328
map<string, string> labels = 19;
352329

353-
// Key-value pairs of additional options to pass to the BigQuery API.
354-
//
355-
// Some options, for example, partitionExpirationDays, have dedicated
356-
// type/validity checked fields. For such options, use the dedicated
357-
// fields.
358-
//
359-
// String values must be encapsulated in double-quotes, for example:
360-
// additionalOptions: {numeric_option: "5", string_option: '"string-value"'}
361-
//
362-
// If the option name contains special characters, encapsulate the name in
363-
// quotes, for example: additionalOptions: { "option-name": "value" }.
330+
// Key-value pairs of additional options to pass to the BigQuery API. Some
331+
// options, for example, partitionExpirationDays, have dedicated
332+
// type/validity checked fields. For such options, use the dedicated fields.
364333
map<string, string> additional_options = 20;
365334

366335
// When set to true, assertions dependent upon any dependency will

0 commit comments

Comments
 (0)