Method: googleapis.bigquery.v2.tables.patch

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.

Arguments

Parameters
datasetId

string

Required. Dataset ID of the table to update

projectId

string

Required. Project ID of the table to update

tableId

string

Required. Table ID of the table to update

autodetect_schema

boolean

When true will autodetect schema, else will keep original schema

body

object (Table)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Table.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.bigquery.v2.tables.patch
    args:
        datasetId: ...
        projectId: ...
        tableId: ...
        autodetect_schema: ...
        body:
            clustering:
                fields: ...
            description: ...
            encryptionConfiguration:
                kmsKeyName: ...
            expirationTime: ...
            externalDataConfiguration:
                autodetect: ...
                avroOptions:
                    useAvroLogicalTypes: ...
                bigtableOptions:
                    columnFamilies: ...
                    ignoreUnspecifiedColumnFamilies: ...
                    readRowkeyAsString: ...
                compression: ...
                connectionId: ...
                csvOptions:
                    allowJaggedRows: ...
                    allowQuotedNewlines: ...
                    encoding: ...
                    fieldDelimiter: ...
                    null_marker: ...
                    preserveAsciiControlCharacters: ...
                    quote: ...
                    skipLeadingRows: ...
                decimalTargetTypes: ...
                googleSheetsOptions:
                    range: ...
                    skipLeadingRows: ...
                hivePartitioningOptions:
                    mode: ...
                    requirePartitionFilter: ...
                    sourceUriPrefix: ...
                ignoreUnknownValues: ...
                maxBadRecords: ...
                parquetOptions:
                    enableListInference: ...
                    enumAsString: ...
                referenceFileSchemaUri: ...
                schema:
                    fields: ...
                sourceFormat: ...
                sourceUris: ...
            friendlyName: ...
            labels: ...
            materializedView:
                enableRefresh: ...
                maxStaleness: ...
                query: ...
                refreshIntervalMs: ...
            maxStaleness: ...
            rangePartitioning:
                field: ...
                range:
                    end: ...
                    interval: ...
                    start: ...
            requirePartitionFilter: ...
            schema: ...
            tableReference: ...
            timePartitioning:
                expirationMs: ...
                field: ...
                requirePartitionFilter: ...
                type: ...
            view:
                query: ...
                useExplicitColumnNames: ...
                useLegacySql: ...
                userDefinedFunctionResources: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.bigquery.v2.tables.patch",
      "args": {
        "datasetId": "...",
        "projectId": "...",
        "tableId": "...",
        "autodetect_schema": "...",
        "body": {
          "clustering": {
            "fields": "..."
          },
          "description": "...",
          "encryptionConfiguration": {
            "kmsKeyName": "..."
          },
          "expirationTime": "...",
          "externalDataConfiguration": {
            "autodetect": "...",
            "avroOptions": {
              "useAvroLogicalTypes": "..."
            },
            "bigtableOptions": {
              "columnFamilies": "...",
              "ignoreUnspecifiedColumnFamilies": "...",
              "readRowkeyAsString": "..."
            },
            "compression": "...",
            "connectionId": "...",
            "csvOptions": {
              "allowJaggedRows": "...",
              "allowQuotedNewlines": "...",
              "encoding": "...",
              "fieldDelimiter": "...",
              "null_marker": "...",
              "preserveAsciiControlCharacters": "...",
              "quote": "...",
              "skipLeadingRows": "..."
            },
            "decimalTargetTypes": "...",
            "googleSheetsOptions": {
              "range": "...",
              "skipLeadingRows": "..."
            },
            "hivePartitioningOptions": {
              "mode": "...",
              "requirePartitionFilter": "...",
              "sourceUriPrefix": "..."
            },
            "ignoreUnknownValues": "...",
            "maxBadRecords": "...",
            "parquetOptions": {
              "enableListInference": "...",
              "enumAsString": "..."
            },
            "referenceFileSchemaUri": "...",
            "schema": {
              "fields": "..."
            },
            "sourceFormat": "...",
            "sourceUris": "..."
          },
          "friendlyName": "...",
          "labels": "...",
          "materializedView": {
            "enableRefresh": "...",
            "maxStaleness": "...",
            "query": "...",
            "refreshIntervalMs": "..."
          },
          "maxStaleness": "...",
          "rangePartitioning": {
            "field": "...",
            "range": {
              "end": "...",
              "interval": "...",
              "start": "..."
            }
          },
          "requirePartitionFilter": "...",
          "schema": "...",
          "tableReference": "...",
          "timePartitioning": {
            "expirationMs": "...",
            "field": "...",
            "requirePartitionFilter": "...",
            "type": "..."
          },
          "view": {
            "query": "...",
            "useExplicitColumnNames": "...",
            "useLegacySql": "...",
            "userDefinedFunctionResources": "..."
          }
        }
      },
      "result": "patchResult"
    }
  }
]