Google BigQuery

Frends.GoogleBigQuery.PatchResource / 2.0.0

Summary

Changes only the fields you supply on an existing BigQuery object and leaves the rest untouched.

Typical use — the safe way to adjust one attribute such as a description or a label; the update Task replaces the whole definition instead

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0

Input parameters.

Name Type Default Example Description
Resource Resources Dataset Resources.Dataset

Resource type.

Possible values:

  • Dataset: The dataset resource.
  • Table: The table resource.
Description String – Example description.

Resource description. (Optional)

FriendlyName String – Example name

Friendly name for Dataset or Table resource. (Optional)

Location String EU europe-north1

The geographic location where the resource should reside. See details at https://cloud.google.com/bigquery/docs/locations

Label LabelParameters[] – [ {foo, bar }, { bar, foo } ]

Label(s) for Dataset or Table resource. (Optional) Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key.

SetEncryptionConfiguration Boolean False false

Set Dataset or Table encryption configuration.

KmsKeyName String – projects/your-project/locations/global/keyRings/your-key-ring/cryptoKeys/your-key

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

StorageBillingModel String LOGICAL LOGICAL

Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL.

IsCaseInsensitive Boolean False false

Indicates if table names are case insensitive in the dataset.

MaxTimeTravelHours Int64 0 0

Number of hours for the max time travel for all tables in the dataset. Unlimited if 0.

Access AccessParameters[] – [ { READER, foo@bar.com }, { WRITER, bar@bar.com } ]

An array of objects that define dataset access for one or more entities. (Optional) You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

Tag TagParameters[] – [ { foo, bar }, { foo2, bar2 } ]

The tags associated with this dataset. (Optional) Tag keys are globally unique.

RequirePartitionFilter Boolean False false

If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

TableSchema TableSchemaParameters[] – [ { Name = "Name", Type = "STRING" }, { Name = "AGE", Type = "INTEGER" }, { Name = "BDAY", Type = "DATE" } ]

Describes the schema of this table.

Partition TablePartitionOptions None TablePartitionOptions.RangePartitioning

Partition option.

Possible values:

  • None: Hide options from UI.

  • RangePartitioning: Range partitioning specification for this table.

  • TimePartitioning: Time-based partitioning specification for this table.

RangeField String – AGE

The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

RangeStart Int64 – 1

The start of range partitioning, inclusive

RangeEnd Int64 – 2

The end of range partitioning, exclusive.

RangeInterval Int64 – 2

The width of each interval.

TimeField String – TIMESTAMP

If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

Type TimeTypeOptions DAY TimeTypeOptions.DAY

Generate one partition per day, hour, month, or year.

Possible values:

  • DAY: Partition by day.
  • HOUR: Partition by hour.
  • MONTH: Partition by month.
  • YEAR: Partition by year.
TimeRequirePartitionFilter Boolean false false

RequirePartitionFilter

ExpirationMs Int64 0 0

Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

An unhandled error has occurred. Reload 🗙