Send feedback
Method: googleapis.bigquery.v2.tables.patch
Stay organized with collections
Save and categorize content based on your preferences.
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
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf 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"
}
}
]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Method: googleapis.bigquery.v2.tables.patch\n\nUpdates information in an existing table. The update method replaces the\nentire table resource, whereas the patch method only replaces fields\nthat are provided in the submitted table resource. This method supports\npatch semantics.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`Table`](/workflows/docs/reference/googleapis/bigquery/v2/Overview#Table).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/patch). \n\n### YAML\n\n```yaml\n- patch:\n call: googleapis.bigquery.v2.tables.patch\n args:\n datasetId: ...\n projectId: ...\n tableId: ...\n autodetect_schema: ...\n body:\n clustering:\n fields: ...\n description: ...\n encryptionConfiguration:\n kmsKeyName: ...\n expirationTime: ...\n externalDataConfiguration:\n autodetect: ...\n avroOptions:\n useAvroLogicalTypes: ...\n bigtableOptions:\n columnFamilies: ...\n ignoreUnspecifiedColumnFamilies: ...\n readRowkeyAsString: ...\n compression: ...\n connectionId: ...\n csvOptions:\n allowJaggedRows: ...\n allowQuotedNewlines: ...\n encoding: ...\n fieldDelimiter: ...\n null_marker: ...\n preserveAsciiControlCharacters: ...\n quote: ...\n skipLeadingRows: ...\n decimalTargetTypes: ...\n googleSheetsOptions:\n range: ...\n skipLeadingRows: ...\n hivePartitioningOptions:\n mode: ...\n requirePartitionFilter: ...\n sourceUriPrefix: ...\n ignoreUnknownValues: ...\n maxBadRecords: ...\n parquetOptions:\n enableListInference: ...\n enumAsString: ...\n referenceFileSchemaUri: ...\n schema:\n fields: ...\n sourceFormat: ...\n sourceUris: ...\n friendlyName: ...\n labels: ...\n materializedView:\n enableRefresh: ...\n maxStaleness: ...\n query: ...\n refreshIntervalMs: ...\n maxStaleness: ...\n rangePartitioning:\n field: ...\n range:\n end: ...\n interval: ...\n start: ...\n requirePartitionFilter: ...\n schema: ...\n tableReference: ...\n timePartitioning:\n expirationMs: ...\n field: ...\n requirePartitionFilter: ...\n type: ...\n view:\n query: ...\n useExplicitColumnNames: ...\n useLegacySql: ...\n userDefinedFunctionResources: ...\n result: patchResult\n```\n\n### JSON\n\n```json\n[\n {\n \"patch\": {\n \"call\": \"googleapis.bigquery.v2.tables.patch\",\n \"args\": {\n \"datasetId\": \"...\",\n \"projectId\": \"...\",\n \"tableId\": \"...\",\n \"autodetect_schema\": \"...\",\n \"body\": {\n \"clustering\": {\n \"fields\": \"...\"\n },\n \"description\": \"...\",\n \"encryptionConfiguration\": {\n \"kmsKeyName\": \"...\"\n },\n \"expirationTime\": \"...\",\n \"externalDataConfiguration\": {\n \"autodetect\": \"...\",\n \"avroOptions\": {\n \"useAvroLogicalTypes\": \"...\"\n },\n \"bigtableOptions\": {\n \"columnFamilies\": \"...\",\n \"ignoreUnspecifiedColumnFamilies\": \"...\",\n \"readRowkeyAsString\": \"...\"\n },\n \"compression\": \"...\",\n \"connectionId\": \"...\",\n \"csvOptions\": {\n \"allowJaggedRows\": \"...\",\n \"allowQuotedNewlines\": \"...\",\n \"encoding\": \"...\",\n \"fieldDelimiter\": \"...\",\n \"null_marker\": \"...\",\n \"preserveAsciiControlCharacters\": \"...\",\n \"quote\": \"...\",\n \"skipLeadingRows\": \"...\"\n },\n \"decimalTargetTypes\": \"...\",\n \"googleSheetsOptions\": {\n \"range\": \"...\",\n \"skipLeadingRows\": \"...\"\n },\n \"hivePartitioningOptions\": {\n \"mode\": \"...\",\n \"requirePartitionFilter\": \"...\",\n \"sourceUriPrefix\": \"...\"\n },\n \"ignoreUnknownValues\": \"...\",\n \"maxBadRecords\": \"...\",\n \"parquetOptions\": {\n \"enableListInference\": \"...\",\n \"enumAsString\": \"...\"\n },\n \"referenceFileSchemaUri\": \"...\",\n \"schema\": {\n \"fields\": \"...\"\n },\n \"sourceFormat\": \"...\",\n \"sourceUris\": \"...\"\n },\n \"friendlyName\": \"...\",\n \"labels\": \"...\",\n \"materializedView\": {\n \"enableRefresh\": \"...\",\n \"maxStaleness\": \"...\",\n \"query\": \"...\",\n \"refreshIntervalMs\": \"...\"\n },\n \"maxStaleness\": \"...\",\n \"rangePartitioning\": {\n \"field\": \"...\",\n \"range\": {\n \"end\": \"...\",\n \"interval\": \"...\",\n \"start\": \"...\"\n }\n },\n \"requirePartitionFilter\": \"...\",\n \"schema\": \"...\",\n \"tableReference\": \"...\",\n \"timePartitioning\": {\n \"expirationMs\": \"...\",\n \"field\": \"...\",\n \"requirePartitionFilter\": \"...\",\n \"type\": \"...\"\n },\n \"view\": {\n \"query\": \"...\",\n \"useExplicitColumnNames\": \"...\",\n \"useLegacySql\": \"...\",\n \"userDefinedFunctionResources\": \"...\"\n }\n }\n },\n \"result\": \"patchResult\"\n }\n }\n]\n```"]]
