Blame - docs/dyn/bigquery_v2.tables.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

84

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None)</a></code></p>

85

<p class="firstline">Gets the access control policy for a resource.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#insert">insert(projectId, datasetId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Creates a new, empty table in the dataset.</p>

89

90

<code><a href="#list">list(projectId, datasetId, pageToken=None, maxResults=None)</a></code></p>

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

91

<p class="firstline">Lists all tables in the specified dataset. Requires the READER dataset role.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#patch">patch(projectId, datasetId, tableId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

97

<p class="firstline">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.</p>

98

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

99

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None)</a></code></p>

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

101

102

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None)</a></code></p>

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#update">update(projectId, datasetId, tableId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

106

<p class="firstline">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.</p>

107

<h3>Method Details</h3>

108

109

<code class="details" id="delete">delete(projectId, datasetId, tableId)</code>

110

<pre>Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

111

112

Args:

113

projectId: string, Project ID of the table to delete (required)

114

datasetId: string, Dataset ID of the table to delete (required)

115

tableId: string, Table ID of the table to delete (required)

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

<code class="details" id="get">get(projectId, datasetId, tableId, selectedFields=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

121

<pre>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.

122

123

Args:

124

projectId: string, Project ID of the requested table (required)

125

datasetId: string, Dataset ID of the requested table (required)

126

tableId: string, Table ID of the requested table (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

128

129

Returns:

130

An object of the form:

131

132

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

133

"view": { # [Optional] The view definition.

134

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

135

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

136

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

137

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

138

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

139

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

144

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

145

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

146

"kmsKeyName": "A String", # [Optional] 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.

147

},

148

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

149

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

150

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

151

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

152

},

153

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

154

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

155

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

156

"requirePartitionFilter": True or False,

157

"field": "A String", # [Beta] [Optional] 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.

158

"expirationMs": "A String", # [Optional] 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.

159

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

160

},

161

"friendlyName": "A String", # [Optional] A descriptive name for this table.

162

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

163

"a_key": "A String",

164

},

165

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

166

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

167

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

168

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

169

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

170

"A String",

171

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

172

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

173

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

174

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

175

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

176

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

177

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

178

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

179

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

180

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

181

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

182

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

183

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

184

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

185

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

186

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

187

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

188

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

189

"qualifierString": "A String",

190

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

191

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

192

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

193

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

194

},

195

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

196

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

197

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

198

},

199

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

201

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

202

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

203

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

204

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

205

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

206

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

207

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

208

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

209

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

210

],

211

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

212

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

213

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

214

"policyTags": {

215

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

216

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

217

],

218

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

219

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

220

# Object with schema name: TableFieldSchema

221

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

222

},

223

],

224

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

225

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

226

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

227

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

228

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

229

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

230

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

231

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

232

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

233

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

234

},

235

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

236

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

237

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

238

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

239

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

240

"lossType": "A String",

241

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

242

"labels": [

243

"A String",

244

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

},

246

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

247

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

248

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

249

{

250

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

251

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

252

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

253

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

254

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

255

},

256

],

257

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

258

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

259

"l1Reg": 3.14,

260

"maxIteration": "A String",

261

"learnRate": 3.14,

262

"minRelProgress": 3.14,

263

"l2Reg": 3.14,

264

"warmStart": True or False,

265

"learnRateStrategy": "A String",

266

"lineSearchInitLearnRate": 3.14,

267

"earlyStop": True or False,

268

},

269

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

270

},

271

],

272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

273

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

274

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

275

"kind": "bigquery#table", # [Output-only] The type of the resource.

276

"description": "A String", # [Optional] A user-friendly description of this table.

277

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

278

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

279

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

280

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

281

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

282

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

283

},

284

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

285

},

286

"schema": { # [Optional] Describes the schema of this table.

287

"fields": [ # Describes the fields in a table.

288

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

289

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

290

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

291

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

292

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

297

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

298

"policyTags": {

299

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

300

"A String",

301

],

302

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

303

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

304

# Object with schema name: TableFieldSchema

305

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

310

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

311

"materializedView": { # [Optional] Materialized view definition.

312

"query": "A String", # [Required] A query whose result is persisted.

313

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

314

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

315

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

316

},

317

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

318

"projectId": "A String", # [Required] The ID of the project containing this table.

319

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

320

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

321

},

322

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

323

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

324

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

325

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

326

"A String",

327

],

328

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

329

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

334

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None)</code>

335

<pre>Gets the access control policy for a resource.

336

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

341

See the operation documentation for the appropriate value for this field. (required)

342

body: object, The request body.

343

The object takes the form of:

344

345

{ # Request message for `GetIamPolicy` method.

346

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

347

# `GetIamPolicy`.

348

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

349

#

350

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

351

# rejected.

352

#

353

# Requests for policies with any conditional bindings must specify version 3.

354

# Policies without any conditional bindings may specify any valid value or

355

# leave the field unset.

356

#

357

# To learn which resources support conditions in their IAM policies, see the

358

# [IAM

359

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

},

}

Returns:

An object of the form:

366

367

{ # An Identity and Access Management (IAM) policy, which specifies access

368

# controls for Google Cloud resources.

369

#

370

#

371

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

372

# `members` to a single `role`. Members can be user accounts, service accounts,

373

# Google groups, and domains (such as G Suite). A `role` is a named list of

374

# permissions; each `role` can be an IAM predefined role or a user-created

375

# custom role.

376

#

377

# For some types of Google Cloud resources, a `binding` can also specify a

378

# `condition`, which is a logical expression that allows access to a resource

379

# only if the expression evaluates to `true`. A condition can add constraints

380

# based on attributes of the request, the resource, or both. To learn which

381

# resources support conditions in their IAM policies, see the

382

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

390

# "members": [

391

# "user:mike@example.com",

392

# "group:admins@example.com",

393

# "domain:google.com",

394

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

399

# "members": [

400

# "user:eve@example.com"

401

# ],

402

# "condition": {

403

# "title": "expirable access",

404

# "description": "Does not grant access after Sep 2020",

405

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

418

# - group:admins@example.com

419

# - domain:google.com

420

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

421

# role: roles/resourcemanager.organizationAdmin

422

# - members:

423

# - user:eve@example.com

424

# role: roles/resourcemanager.organizationViewer

425

# condition:

426

# title: expirable access

427

# description: Does not grant access after Sep 2020

428

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

429

# - etag: BwWWja0YfJA=

430

# - version: 3

431

#

432

# For a description of IAM and its features, see the

433

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

434

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

435

# prevent simultaneous updates of a policy from overwriting each other.

436

# It is strongly suggested that systems make use of the `etag` in the

437

# read-modify-write cycle to perform policy updates in order to avoid race

438

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

439

# systems are expected to put that etag in the request to `setIamPolicy` to

440

# ensure that their change will be applied to the same version of the policy.

441

#

442

# **Important:** If you use IAM Conditions, you must include the `etag` field

443

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

444

# you to overwrite a version `3` policy with a version `1` policy, and all of

445

# the conditions in the version `3` policy are lost.

446

"version": 42, # Specifies the format of the policy.

447

#

448

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

449

# are rejected.

450

#

451

# Any operation that affects conditional role bindings must specify version

452

# `3`. This requirement applies to the following operations:

453

#

454

# * Getting a policy that includes a conditional role binding

455

# * Adding a conditional role binding to a policy

456

# * Changing a conditional role binding in a policy

457

# * Removing any role binding, with or without a condition, from a policy

458

# that includes conditions

459

#

460

# **Important:** If you use IAM Conditions, you must include the `etag` field

461

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

462

# you to overwrite a version `3` policy with a version `1` policy, and all of

463

# the conditions in the version `3` policy are lost.

464

#

465

# If a policy does not include any conditions, operations on that policy may

466

# specify any valid version or leave the field unset.

467

#

468

# To learn which resources support conditions in their IAM policies, see the

469

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

470

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

471

{ # Specifies the audit configuration for a service.

472

# The configuration determines which permission types are logged, and what

473

# identities, if any, are exempted from logging.

474

# An AuditConfig must have one or more AuditLogConfigs.

475

#

476

# If there are AuditConfigs for both `allServices` and a specific service,

477

# the union of the two AuditConfigs is used for that service: the log_types

478

# specified in each AuditConfig are enabled, and the exempted_members in each

479

# AuditLogConfig are exempted.

480

#

481

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

487

# "audit_log_configs": [

488

# {

489

# "log_type": "DATA_READ",

490

# "exempted_members": [

491

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

496

# },

497

# {

498

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

504

# "audit_log_configs": [

505

# {

506

# "log_type": "DATA_READ",

507

# },

508

# {

509

# "log_type": "DATA_WRITE",

510

# "exempted_members": [

511

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

520

# logging. It also exempts jose@example.com from DATA_READ logging, and

521

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

522

"service": "A String", # Specifies a service that will be enabled for audit logging.

523

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

524

# `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

525

"auditLogConfigs": [ # The configuration for logging of each type of permission.

526

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

531

# {

532

# "log_type": "DATA_READ",

533

# "exempted_members": [

534

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

544

# jose@example.com from DATA_READ logging.

545

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

546

# permission.

547

# Follows the same format of Binding.members.

548

"A String",

549

],

550

"logType": "A String", # The log type that this config enables.

551

},

552

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

553

},

554

],

555

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

556

# `condition` that determines how and when the `bindings` are applied. Each

557

# of the `bindings` must contain at least one member.

558

{ # Associates `members` with a `role`.

559

"role": "A String", # Role that is assigned to `members`.

560

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

561

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

562

#

563

# If the condition evaluates to `true`, then this binding applies to the

564

# current request.

565

#

566

# If the condition evaluates to `false`, then this binding does not apply to

567

# the current request. However, a different role binding might grant the same

568

# role to one or more of the members in this binding.

569

#

570

# To learn which resources support conditions in their IAM policies, see the

571

# [IAM

572

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

573

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

574

# are documented at https://github.com/google/cel-spec.

575

#

576

# Example (Comparison):

577

#

578

# title: "Summary size limit"

579

# description: "Determines if a summary is less than 100 chars"

580

# expression: "document.summary.size() < 100"

581

#

582

# Example (Equality):

583

#

584

# title: "Requestor is owner"

585

# description: "Determines if requestor is the document owner"

586

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

591

# description: "Determine whether the document should be publicly visible"

592

# expression: "document.type != 'private' && document.type != 'internal'"

593

#

594

# Example (Data Manipulation):

595

#

596

# title: "Notification string"

597

# description: "Create a notification string with a timestamp."

598

# expression: "'New message received at ' + string(document.create_time)"

599

#

600

# The exact variables and functions that may be referenced within an expression

601

# are determined by the service that evaluates it. See the service

602

# documentation for additional information.

603

"description": "A String", # Optional. Description of the expression. This is a longer text which

604

# describes the expression, e.g. when hovered over it in a UI.

605

"expression": "A String", # Textual representation of an expression in Common Expression Language

606

# syntax.

607

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

608

# its purpose. This can be used e.g. in UIs which allow to enter the

609

# expression.

610

"location": "A String", # Optional. String indicating the location of the expression for error

611

# reporting, e.g. a file name and a position in the file.

612

},

613

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

614

# `members` can have the following values:

615

#

616

# * `allUsers`: A special identifier that represents anyone who is

617

# on the internet; with or without a Google account.

618

#

619

# * `allAuthenticatedUsers`: A special identifier that represents anyone

620

# who is authenticated with a Google account or a service account.

621

#

622

# * `user:{emailid}`: An email address that represents a specific Google

623

# account. For example, `alice@example.com` .

624

#

625

#

626

# * `serviceAccount:{emailid}`: An email address that represents a service

627

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

628

#

629

# * `group:{emailid}`: An email address that represents a Google group.

630

# For example, `admins@example.com`.

631

#

632

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

633

# identifier) representing a user that has been recently deleted. For

634

# example, `alice@example.com?uid=123456789012345678901`. If the user is

635

# recovered, this value reverts to `user:{emailid}` and the recovered user

636

# retains the role in the binding.

637

#

638

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

639

# unique identifier) representing a service account that has been recently

640

# deleted. For example,

641

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

642

# If the service account is undeleted, this value reverts to

643

# `serviceAccount:{emailid}` and the undeleted service account retains the

644

# role in the binding.

645

#

646

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

647

# identifier) representing a Google group that has been recently

648

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

649

# the group is recovered, this value reverts to `group:{emailid}` and the

650

# recovered group retains the role in the binding.

651

#

652

#

653

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

654

# users of that domain. For example, `google.com` or `example.com`.

655

#

656

"A String",

657

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

664

<code class="details" id="insert">insert(projectId, datasetId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

665

<pre>Creates a new, empty table in the dataset.

666

667

Args:

668

projectId: string, Project ID of the new table (required)

669

datasetId: string, Dataset ID of the new table (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

670

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

671

The object takes the form of:

672

673

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

674

"view": { # [Optional] The view definition.

675

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

676

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

677

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

678

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

679

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

680

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

685

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

686

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

687

"kmsKeyName": "A String", # [Optional] 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.

688

},

689

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

690

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

691

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

692

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

693

},

694

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

695

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

696

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

697

"requirePartitionFilter": True or False,

698

"field": "A String", # [Beta] [Optional] 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.

699

"expirationMs": "A String", # [Optional] 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.

700

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

701

},

702

"friendlyName": "A String", # [Optional] A descriptive name for this table.

703

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

704

"a_key": "A String",

705

},

706

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

707

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

708

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

709

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

710

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

711

"A String",

712

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

713

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

715

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

716

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

717

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

718

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

719

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

722

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

724

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

725

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

726

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

727

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

728

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

729

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

730

"qualifierString": "A String",

731

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

732

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

733

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

734

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

735

},

736

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

737

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

738

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

739

},

740

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

741

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

742

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

743

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

744

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

745

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

746

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

747

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

748

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

749

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

750

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

751

],

752

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

753

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

754

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

755

"policyTags": {

756

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

757

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

758

],

759

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

760

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

761

# Object with schema name: TableFieldSchema

762

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

763

},

764

],

765

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

766

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

767

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

768

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

769

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

770

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

771

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

772

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

773

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

774

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

775

},

776

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

777

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

778

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

779

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

780

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

781

"lossType": "A String",

782

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

783

"labels": [

784

"A String",

785

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

786

},

787

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

788

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

789

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

790

{

791

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

792

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

793

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

794

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

795

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

796

},

797

],

798

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

799

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

800

"l1Reg": 3.14,

801

"maxIteration": "A String",

802

"learnRate": 3.14,

803

"minRelProgress": 3.14,

804

"l2Reg": 3.14,

805

"warmStart": True or False,

806

"learnRateStrategy": "A String",

807

"lineSearchInitLearnRate": 3.14,

808

"earlyStop": True or False,

809

},

810

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

811

},

812

],

813

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

814

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

815

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

816

"kind": "bigquery#table", # [Output-only] The type of the resource.

817

"description": "A String", # [Optional] A user-friendly description of this table.

818

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

819

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

820

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

821

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

822

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

823

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

824

},

825

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

826

},

827

"schema": { # [Optional] Describes the schema of this table.

828

"fields": [ # Describes the fields in a table.

829

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

830

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

831

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

832

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

833

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

838

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

839

"policyTags": {

840

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

841

"A String",

842

],

843

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

844

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

845

# Object with schema name: TableFieldSchema

846

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

851

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

852

"materializedView": { # [Optional] Materialized view definition.

853

"query": "A String", # [Required] A query whose result is persisted.

854

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

855

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

856

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

857

},

858

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

"projectId": "A String", # [Required] The ID of the project containing this table.

860

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

861

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

862

},

863

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

864

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

865

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

866

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

867

"A String",

868

],

869

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

870

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

876

877

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

878

"view": { # [Optional] The view definition.

879

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

880

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

881

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

882

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

883

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

884

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

889

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

890

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

891

"kmsKeyName": "A String", # [Optional] 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.

892

},

893

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

894

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

895

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

896

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

897

},

898

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

899

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

900

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

901

"requirePartitionFilter": True or False,

902

"field": "A String", # [Beta] [Optional] 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.

903

"expirationMs": "A String", # [Optional] 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.

904

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

905

},

906

"friendlyName": "A String", # [Optional] A descriptive name for this table.

907

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

908

"a_key": "A String",

909

},

910

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

911

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

912

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

913

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

914

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

915

"A String",

916

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

917

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

918

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

919

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

920

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

921

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

922

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

923

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

924

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

925

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

926

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

927

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

928

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

929

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

930

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

931

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

932

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

933

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

934

"qualifierString": "A String",

935

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

936

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

937

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

938

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

939

},

940

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

941

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

942

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

943

},

944

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

945

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

946

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

947

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

948

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

949

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

950

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

951

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

952

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

953

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

954

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

955

],

956

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

957

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

958

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

959

"policyTags": {

960

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

961

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

962

],

963

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

964

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

965

# Object with schema name: TableFieldSchema

966

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

967

},

968

],

969

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

970

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

971

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

972

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

973

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

974

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

975

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

976

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

977

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

978

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

979

},

980

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

981

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

982

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

983

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

984

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

985

"lossType": "A String",

986

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

987

"labels": [

988

"A String",

989

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

990

},

991

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

992

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

993

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

994

{

995

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

996

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

997

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

998

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

999

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

1000

},

1001

],

1002

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1003

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

1004

"l1Reg": 3.14,

1005

"maxIteration": "A String",

1006

"learnRate": 3.14,

1007

"minRelProgress": 3.14,

1008

"l2Reg": 3.14,

1009

"warmStart": True or False,

1010

"learnRateStrategy": "A String",

1011

"lineSearchInitLearnRate": 3.14,

1012

"earlyStop": True or False,

1013

},

1014

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1015

},

1016

],

1017

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1018

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1019

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

1020

"kind": "bigquery#table", # [Output-only] The type of the resource.

1021

"description": "A String", # [Optional] A user-friendly description of this table.

1022

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

1023

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1024

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1025

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1026

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1027

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1028

},

1029

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

1030

},

1031

"schema": { # [Optional] Describes the schema of this table.

1032

"fields": [ # Describes the fields in a table.

1033

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1034

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1035

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1036

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1037

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1042

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1043

"policyTags": {

1044

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1045

"A String",

1046

],

1047

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1048

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1049

# Object with schema name: TableFieldSchema

1050

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1055

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1056

"materializedView": { # [Optional] Materialized view definition.

1057

"query": "A String", # [Required] A query whose result is persisted.

1058

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1059

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1060

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1061

},

1062

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1063

"projectId": "A String", # [Required] The ID of the project containing this table.

1064

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1065

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1066

},

1067

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1068

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1069

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1070

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

1071

"A String",

1072

],

1073

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1074

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(projectId, datasetId, pageToken=None, maxResults=None)</code>

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

1080

<pre>Lists all tables in the specified dataset. Requires the READER dataset role.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1081

1082

Args:

1083

projectId: string, Project ID of the tables to list (required)

1084

datasetId: string, Dataset ID of the tables to list (required)

1085

pageToken: string, Page token, returned by a previous call, to request the next page of results

1086

maxResults: integer, Maximum number of results to return

1087

1088

Returns:

1089

An object of the form:

1090

1091

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1092

"nextPageToken": "A String", # A token to request the next page of results.

1093

"totalItems": 42, # The total number of tables in the dataset.

1094

"kind": "bigquery#tableList", # The type of list.

1095

"tables": [ # Tables in the requested dataset.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1096

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1097

"kind": "bigquery#table", # The resource type.

1098

"view": { # Additional details for a view.

1099

"useLegacySql": True or False, # True if view is defined in legacy SQL dialect, false if in standard SQL.

1100

},

1101

"creationTime": "A String", # The time when this table was created, in milliseconds since the epoch.

1102

"rangePartitioning": { # The range partitioning specification for this table, if configured.

1103

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1104

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1105

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1106

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1107

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1108

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1109

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1110

"id": "A String", # An opaque ID of the table

1111

"tableReference": { # A reference uniquely identifying the table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1112

"projectId": "A String", # [Required] The ID of the project containing this table.

1113

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1114

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1115

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1116

"timePartitioning": { # The time-based partitioning specification for this table, if configured.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1117

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1118

"field": "A String", # [Beta] [Optional] 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.

1119

"expirationMs": "A String", # [Optional] 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.

1120

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1121

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1122

"friendlyName": "A String", # The user-friendly name for this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1123

"labels": { # The labels associated with this table. You can use these to organize and group your tables.

1124

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1125

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1126

"type": "A String", # The type of table. Possible values are: TABLE, VIEW.

1127

"clustering": { # [Beta] Clustering specification for this table, if configured.

1128

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1133

},

1134

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1135

"etag": "A String", # A hash of this page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1141

<pre>Retrieves the next page of results.

1142

1143

Args:

1144

previous_request: The request for the previous page. (required)

1145

previous_response: The response from the request for the previous page. (required)

1146

1147

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1148

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1149

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1154

<code class="details" id="patch">patch(projectId, datasetId, tableId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1155

<pre>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.

1156

1157

Args:

1158

projectId: string, Project ID of the table to update (required)

1159

datasetId: string, Dataset ID of the table to update (required)

1160

tableId: string, Table ID of the table to update (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1161

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1162

The object takes the form of:

1163

1164

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1165

"view": { # [Optional] The view definition.

1166

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

1167

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1168

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1169

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

1170

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

1171

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1176

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

1177

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1178

"kmsKeyName": "A String", # [Optional] 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.

1179

},

1180

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

1181

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1182

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1183

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

1184

},

1185

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

1186

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1187

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1188

"requirePartitionFilter": True or False,

1189

"field": "A String", # [Beta] [Optional] 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.

1190

"expirationMs": "A String", # [Optional] 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.

1191

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1192

},

1193

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1194

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

1195

"a_key": "A String",

1196

},

1197

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1198

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1199

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1200

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1201

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

1202

"A String",

1203

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1204

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1205

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

1206

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1207

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

1208

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1209

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

1210

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1211

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1213

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1214

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1215

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1216

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

1217

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

1218

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1219

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1220

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

1221

"qualifierString": "A String",

1222

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1223

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1224

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

1225

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1226

},

1227

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1228

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

1229

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1230

},

1231

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1232

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1233

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1234

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

1235

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1236

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1237

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1238

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1239

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1240

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

1241

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1242

],

1243

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1244

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1245

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1246

"policyTags": {

1247

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1248

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1249

],

1250

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1251

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1252

# Object with schema name: TableFieldSchema

1253

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1254

},

1255

],

1256

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1257

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1258

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1259

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

1260

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

1261

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1262

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1263

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1264

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

1265

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1266

},

1267

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

1268

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1269

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1270

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

1271

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1272

"lossType": "A String",

1273

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

"labels": [

1275

"A String",

1276

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1277

},

1278

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1279

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1281

{

1282

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1283

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

1284

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

1285

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1286

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

1287

},

1288

],

1289

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1290

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

1291

"l1Reg": 3.14,

1292

"maxIteration": "A String",

1293

"learnRate": 3.14,

1294

"minRelProgress": 3.14,

1295

"l2Reg": 3.14,

1296

"warmStart": True or False,

1297

"learnRateStrategy": "A String",

1298

"lineSearchInitLearnRate": 3.14,

1299

"earlyStop": True or False,

1300

},

1301

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1302

},

1303

],

1304

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1305

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1306

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

1307

"kind": "bigquery#table", # [Output-only] The type of the resource.

1308

"description": "A String", # [Optional] A user-friendly description of this table.

1309

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

1310

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1311

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1312

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1313

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1314

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1315

},

1316

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

1317

},

1318

"schema": { # [Optional] Describes the schema of this table.

1319

"fields": [ # Describes the fields in a table.

1320

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1321

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1322

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1323

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1324

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1329

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1330

"policyTags": {

1331

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1332

"A String",

1333

],

1334

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1335

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1336

# Object with schema name: TableFieldSchema

1337

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1342

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1343

"materializedView": { # [Optional] Materialized view definition.

1344

"query": "A String", # [Required] A query whose result is persisted.

1345

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1346

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1347

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1348

},

1349

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1350

"projectId": "A String", # [Required] The ID of the project containing this table.

1351

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1352

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1353

},

1354

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1355

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1357

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

1358

"A String",

1359

],

1360

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1361

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

1367

1368

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1369

"view": { # [Optional] The view definition.

1370

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

1371

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1372

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1373

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

1374

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

1375

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1380

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

1381

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1382

"kmsKeyName": "A String", # [Optional] 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.

1383

},

1384

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

1385

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1386

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1387

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

1388

},

1389

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

1390

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1391

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1392

"requirePartitionFilter": True or False,

1393

"field": "A String", # [Beta] [Optional] 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.

1394

"expirationMs": "A String", # [Optional] 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.

1395

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1396

},

1397

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1398

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

1399

"a_key": "A String",

1400

},

1401

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1402

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1403

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1404

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1405

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

1406

"A String",

1407

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1408

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1409

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

1410

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1411

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

1412

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1413

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

1414

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1416

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1417

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1419

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1420

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

1421

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

1422

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1423

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1424

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

1425

"qualifierString": "A String",

1426

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1427

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1428

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

1429

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1430

},

1431

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1432

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

1433

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1434

},

1435

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1436

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1437

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1438

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

1439

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1440

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1441

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1442

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1443

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1444

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

1445

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1446

],

1447

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1448

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1449

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1450

"policyTags": {

1451

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1452

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1453

],

1454

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1455

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1456

# Object with schema name: TableFieldSchema

1457

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1458

},

1459

],

1460

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1461

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1462

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1463

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

1464

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

1465

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1466

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1467

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1468

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

1469

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1470

},

1471

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

1472

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1473

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1474

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

1475

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1476

"lossType": "A String",

1477

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1478

"labels": [

1479

"A String",

1480

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1481

},

1482

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1483

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1485

{

1486

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1487

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

1488

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

1489

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1490

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

1491

},

1492

],

1493

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1494

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

1495

"l1Reg": 3.14,

1496

"maxIteration": "A String",

1497

"learnRate": 3.14,

1498

"minRelProgress": 3.14,

1499

"l2Reg": 3.14,

1500

"warmStart": True or False,

1501

"learnRateStrategy": "A String",

1502

"lineSearchInitLearnRate": 3.14,

1503

"earlyStop": True or False,

1504

},

1505

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1506

},

1507

],

1508

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1509

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1510

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

1511

"kind": "bigquery#table", # [Output-only] The type of the resource.

1512

"description": "A String", # [Optional] A user-friendly description of this table.

1513

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

1514

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1515

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1516

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1517

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1518

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1519

},

1520

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

1521

},

1522

"schema": { # [Optional] Describes the schema of this table.

1523

"fields": [ # Describes the fields in a table.

1524

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1525

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1526

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1527

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1528

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1533

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1534

"policyTags": {

1535

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1536

"A String",

1537

],

1538

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1539

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1540

# Object with schema name: TableFieldSchema

1541

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1546

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1547

"materializedView": { # [Optional] Materialized view definition.

1548

"query": "A String", # [Required] A query whose result is persisted.

1549

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1550

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1551

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1552

},

1553

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1554

"projectId": "A String", # [Required] The ID of the project containing this table.

1555

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1556

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

},

1558

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1559

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1561

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

1562

"A String",

1563

],

1564

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1565

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1570

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None)</code>

1571

<pre>Sets the access control policy on the specified resource. Replaces any

1572

existing policy.

1573

1574

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

1575

1576

Args:

1577

resource: string, REQUIRED: The resource for which the policy is being specified.

1578

See the operation documentation for the appropriate value for this field. (required)

1579

body: object, The request body.

1580

The object takes the form of:

1581

1582

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1583

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

1584

# the fields in the mask will be modified. If no mask is provided, the

1585

# following default mask is used:

1586

#

1587

# `paths: "bindings, etag"`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1588

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

1589

# the policy is limited to a few 10s of KB. An empty policy is a

1590

# valid policy but certain Cloud Platform services (such as Projects)

1591

# might reject them.

1592

# controls for Google Cloud resources.

1593

#

1594

#

1595

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1596

# `members` to a single `role`. Members can be user accounts, service accounts,

1597

# Google groups, and domains (such as G Suite). A `role` is a named list of

1598

# permissions; each `role` can be an IAM predefined role or a user-created

1599

# custom role.

1600

#

1601

# For some types of Google Cloud resources, a `binding` can also specify a

1602

# `condition`, which is a logical expression that allows access to a resource

1603

# only if the expression evaluates to `true`. A condition can add constraints

1604

# based on attributes of the request, the resource, or both. To learn which

1605

# resources support conditions in their IAM policies, see the

1606

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1614

# "members": [

1615

# "user:mike@example.com",

1616

# "group:admins@example.com",

1617

# "domain:google.com",

1618

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1623

# "members": [

1624

# "user:eve@example.com"

1625

# ],

1626

# "condition": {

1627

# "title": "expirable access",

1628

# "description": "Does not grant access after Sep 2020",

1629

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1642

# - group:admins@example.com

1643

# - domain:google.com

1644

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1645

# role: roles/resourcemanager.organizationAdmin

1646

# - members:

1647

# - user:eve@example.com

1648

# role: roles/resourcemanager.organizationViewer

1649

# condition:

1650

# title: expirable access

1651

# description: Does not grant access after Sep 2020

1652

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1653

# - etag: BwWWja0YfJA=

1654

# - version: 3

1655

#

1656

# For a description of IAM and its features, see the

1657

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1658

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1659

# prevent simultaneous updates of a policy from overwriting each other.

1660

# It is strongly suggested that systems make use of the `etag` in the

1661

# read-modify-write cycle to perform policy updates in order to avoid race

1662

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1663

# systems are expected to put that etag in the request to `setIamPolicy` to

1664

# ensure that their change will be applied to the same version of the policy.

1665

#

1666

# **Important:** If you use IAM Conditions, you must include the `etag` field

1667

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1668

# you to overwrite a version `3` policy with a version `1` policy, and all of

1669

# the conditions in the version `3` policy are lost.

1670

"version": 42, # Specifies the format of the policy.

1671

#

1672

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1673

# are rejected.

1674

#

1675

# Any operation that affects conditional role bindings must specify version

1676

# `3`. This requirement applies to the following operations:

1677

#

1678

# * Getting a policy that includes a conditional role binding

1679

# * Adding a conditional role binding to a policy

1680

# * Changing a conditional role binding in a policy

1681

# * Removing any role binding, with or without a condition, from a policy

1682

# that includes conditions

1683

#

1684

# **Important:** If you use IAM Conditions, you must include the `etag` field

1685

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1686

# you to overwrite a version `3` policy with a version `1` policy, and all of

1687

# the conditions in the version `3` policy are lost.

1688

#

1689

# If a policy does not include any conditions, operations on that policy may

1690

# specify any valid version or leave the field unset.

1691

#

1692

# To learn which resources support conditions in their IAM policies, see the

1693

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1694

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1695

{ # Specifies the audit configuration for a service.

1696

# The configuration determines which permission types are logged, and what

1697

# identities, if any, are exempted from logging.

1698

# An AuditConfig must have one or more AuditLogConfigs.

1699

#

1700

# If there are AuditConfigs for both `allServices` and a specific service,

1701

# the union of the two AuditConfigs is used for that service: the log_types

1702

# specified in each AuditConfig are enabled, and the exempted_members in each

1703

# AuditLogConfig are exempted.

1704

#

1705

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1711

# "audit_log_configs": [

1712

# {

1713

# "log_type": "DATA_READ",

1714

# "exempted_members": [

1715

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1720

# },

1721

# {

1722

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

1728

# "audit_log_configs": [

1729

# {

1730

# "log_type": "DATA_READ",

1731

# },

1732

# {

1733

# "log_type": "DATA_WRITE",

1734

# "exempted_members": [

1735

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1744

# logging. It also exempts jose@example.com from DATA_READ logging, and

1745

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1746

"service": "A String", # Specifies a service that will be enabled for audit logging.

1747

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1748

# `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1750

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1755

# {

1756

# "log_type": "DATA_READ",

1757

# "exempted_members": [

1758

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1768

# jose@example.com from DATA_READ logging.

1769

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1770

# permission.

1771

# Follows the same format of Binding.members.

1772

"A String",

1773

],

1774

"logType": "A String", # The log type that this config enables.

1775

},

1776

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1777

},

1778

],

1779

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1780

# `condition` that determines how and when the `bindings` are applied. Each

1781

# of the `bindings` must contain at least one member.

1782

{ # Associates `members` with a `role`.

1783

"role": "A String", # Role that is assigned to `members`.

1784

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1785

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1786

#

1787

# If the condition evaluates to `true`, then this binding applies to the

1788

# current request.

1789

#

1790

# If the condition evaluates to `false`, then this binding does not apply to

1791

# the current request. However, a different role binding might grant the same

1792

# role to one or more of the members in this binding.

1793

#

1794

# To learn which resources support conditions in their IAM policies, see the

1795

# [IAM

1796

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1797

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1798

# are documented at https://github.com/google/cel-spec.

1799

#

1800

# Example (Comparison):

1801

#

1802

# title: "Summary size limit"

1803

# description: "Determines if a summary is less than 100 chars"

1804

# expression: "document.summary.size() < 100"

1805

#

1806

# Example (Equality):

1807

#

1808

# title: "Requestor is owner"

1809

# description: "Determines if requestor is the document owner"

1810

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1815

# description: "Determine whether the document should be publicly visible"

1816

# expression: "document.type != 'private' && document.type != 'internal'"

1817

#

1818

# Example (Data Manipulation):

1819

#

1820

# title: "Notification string"

1821

# description: "Create a notification string with a timestamp."

1822

# expression: "'New message received at ' + string(document.create_time)"

1823

#

1824

# The exact variables and functions that may be referenced within an expression

1825

# are determined by the service that evaluates it. See the service

1826

# documentation for additional information.

1827

"description": "A String", # Optional. Description of the expression. This is a longer text which

1828

# describes the expression, e.g. when hovered over it in a UI.

1829

"expression": "A String", # Textual representation of an expression in Common Expression Language

1830

# syntax.

1831

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1832

# its purpose. This can be used e.g. in UIs which allow to enter the

1833

# expression.

1834

"location": "A String", # Optional. String indicating the location of the expression for error

1835

# reporting, e.g. a file name and a position in the file.

1836

},

1837

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1838

# `members` can have the following values:

1839

#

1840

# * `allUsers`: A special identifier that represents anyone who is

1841

# on the internet; with or without a Google account.

1842

#

1843

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1844

# who is authenticated with a Google account or a service account.

1845

#

1846

# * `user:{emailid}`: An email address that represents a specific Google

1847

# account. For example, `alice@example.com` .

1848

#

1849

#

1850

# * `serviceAccount:{emailid}`: An email address that represents a service

1851

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1852

#

1853

# * `group:{emailid}`: An email address that represents a Google group.

1854

# For example, `admins@example.com`.

1855

#

1856

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1857

# identifier) representing a user that has been recently deleted. For

1858

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1859

# recovered, this value reverts to `user:{emailid}` and the recovered user

1860

# retains the role in the binding.

1861

#

1862

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1863

# unique identifier) representing a service account that has been recently

1864

# deleted. For example,

1865

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1866

# If the service account is undeleted, this value reverts to

1867

# `serviceAccount:{emailid}` and the undeleted service account retains the

1868

# role in the binding.

1869

#

1870

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1871

# identifier) representing a Google group that has been recently

1872

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1873

# the group is recovered, this value reverts to `group:{emailid}` and the

1874

# recovered group retains the role in the binding.

1875

#

1876

#

1877

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1878

# users of that domain. For example, `google.com` or `example.com`.

1879

#

1880

"A String",

1881

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

},

1883

],

1884

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}

Returns:

An object of the form:

1890

1891

{ # An Identity and Access Management (IAM) policy, which specifies access

1892

# controls for Google Cloud resources.

1893

#

1894

#

1895

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1896

# `members` to a single `role`. Members can be user accounts, service accounts,

1897

# Google groups, and domains (such as G Suite). A `role` is a named list of

1898

# permissions; each `role` can be an IAM predefined role or a user-created

1899

# custom role.

1900

#

1901

# For some types of Google Cloud resources, a `binding` can also specify a

1902

# `condition`, which is a logical expression that allows access to a resource

1903

# only if the expression evaluates to `true`. A condition can add constraints

1904

# based on attributes of the request, the resource, or both. To learn which

1905

# resources support conditions in their IAM policies, see the

1906

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1914

# "members": [

1915

# "user:mike@example.com",

1916

# "group:admins@example.com",

1917

# "domain:google.com",

1918

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1923

# "members": [

1924

# "user:eve@example.com"

1925

# ],

1926

# "condition": {

1927

# "title": "expirable access",

1928

# "description": "Does not grant access after Sep 2020",

1929

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1942

# - group:admins@example.com

1943

# - domain:google.com

1944

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1945

# role: roles/resourcemanager.organizationAdmin

1946

# - members:

1947

# - user:eve@example.com

1948

# role: roles/resourcemanager.organizationViewer

1949

# condition:

1950

# title: expirable access

1951

# description: Does not grant access after Sep 2020

1952

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1953

# - etag: BwWWja0YfJA=

1954

# - version: 3

1955

#

1956

# For a description of IAM and its features, see the

1957

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1958

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1959

# prevent simultaneous updates of a policy from overwriting each other.

1960

# It is strongly suggested that systems make use of the `etag` in the

1961

# read-modify-write cycle to perform policy updates in order to avoid race

1962

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1963

# systems are expected to put that etag in the request to `setIamPolicy` to

1964

# ensure that their change will be applied to the same version of the policy.

1965

#

1966

# **Important:** If you use IAM Conditions, you must include the `etag` field

1967

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1968

# you to overwrite a version `3` policy with a version `1` policy, and all of

1969

# the conditions in the version `3` policy are lost.

1970

"version": 42, # Specifies the format of the policy.

1971

#

1972

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1973

# are rejected.

1974

#

1975

# Any operation that affects conditional role bindings must specify version

1976

# `3`. This requirement applies to the following operations:

1977

#

1978

# * Getting a policy that includes a conditional role binding

1979

# * Adding a conditional role binding to a policy

1980

# * Changing a conditional role binding in a policy

1981

# * Removing any role binding, with or without a condition, from a policy

1982

# that includes conditions

1983

#

1984

# **Important:** If you use IAM Conditions, you must include the `etag` field

1985

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1986

# you to overwrite a version `3` policy with a version `1` policy, and all of

1987

# the conditions in the version `3` policy are lost.

1988

#

1989

# If a policy does not include any conditions, operations on that policy may

1990

# specify any valid version or leave the field unset.

1991

#

1992

# To learn which resources support conditions in their IAM policies, see the

1993

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1994

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1995

{ # Specifies the audit configuration for a service.

1996

# The configuration determines which permission types are logged, and what

1997

# identities, if any, are exempted from logging.

1998

# An AuditConfig must have one or more AuditLogConfigs.

1999

#

2000

# If there are AuditConfigs for both `allServices` and a specific service,

2001

# the union of the two AuditConfigs is used for that service: the log_types

2002

# specified in each AuditConfig are enabled, and the exempted_members in each

2003

# AuditLogConfig are exempted.

2004

#

2005

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

2011

# "audit_log_configs": [

2012

# {

2013

# "log_type": "DATA_READ",

2014

# "exempted_members": [

2015

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

2020

# },

2021

# {

2022

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

2028

# "audit_log_configs": [

2029

# {

2030

# "log_type": "DATA_READ",

2031

# },

2032

# {

2033

# "log_type": "DATA_WRITE",

2034

# "exempted_members": [

2035

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

2044

# logging. It also exempts jose@example.com from DATA_READ logging, and

2045

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2046

"service": "A String", # Specifies a service that will be enabled for audit logging.

2047

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

2048

# `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2049

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2050

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

2055

# {

2056

# "log_type": "DATA_READ",

2057

# "exempted_members": [

2058

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

2068

# jose@example.com from DATA_READ logging.

2069

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

2070

# permission.

2071

# Follows the same format of Binding.members.

2072

"A String",

2073

],

2074

"logType": "A String", # The log type that this config enables.

2075

},

2076

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2077

},

2078

],

2079

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

2080

# `condition` that determines how and when the `bindings` are applied. Each

2081

# of the `bindings` must contain at least one member.

2082

{ # Associates `members` with a `role`.

2083

"role": "A String", # Role that is assigned to `members`.

2084

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2085

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

2086

#

2087

# If the condition evaluates to `true`, then this binding applies to the

2088

# current request.

2089

#

2090

# If the condition evaluates to `false`, then this binding does not apply to

2091

# the current request. However, a different role binding might grant the same

2092

# role to one or more of the members in this binding.

2093

#

2094

# To learn which resources support conditions in their IAM policies, see the

2095

# [IAM

2096

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2097

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

2098

# are documented at https://github.com/google/cel-spec.

2099

#

2100

# Example (Comparison):

2101

#

2102

# title: "Summary size limit"

2103

# description: "Determines if a summary is less than 100 chars"

2104

# expression: "document.summary.size() < 100"

2105

#

2106

# Example (Equality):

2107

#

2108

# title: "Requestor is owner"

2109

# description: "Determines if requestor is the document owner"

2110

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

2115

# description: "Determine whether the document should be publicly visible"

2116

# expression: "document.type != 'private' && document.type != 'internal'"

2117

#

2118

# Example (Data Manipulation):

2119

#

2120

# title: "Notification string"

2121

# description: "Create a notification string with a timestamp."

2122

# expression: "'New message received at ' + string(document.create_time)"

2123

#

2124

# The exact variables and functions that may be referenced within an expression

2125

# are determined by the service that evaluates it. See the service

2126

# documentation for additional information.

2127

"description": "A String", # Optional. Description of the expression. This is a longer text which

2128

# describes the expression, e.g. when hovered over it in a UI.

2129

"expression": "A String", # Textual representation of an expression in Common Expression Language

2130

# syntax.

2131

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

2132

# its purpose. This can be used e.g. in UIs which allow to enter the

2133

# expression.

2134

"location": "A String", # Optional. String indicating the location of the expression for error

2135

# reporting, e.g. a file name and a position in the file.

2136

},

2137

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2138

# `members` can have the following values:

2139

#

2140

# * `allUsers`: A special identifier that represents anyone who is

2141

# on the internet; with or without a Google account.

2142

#

2143

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2144

# who is authenticated with a Google account or a service account.

2145

#

2146

# * `user:{emailid}`: An email address that represents a specific Google

2147

# account. For example, `alice@example.com` .

2148

#

2149

#

2150

# * `serviceAccount:{emailid}`: An email address that represents a service

2151

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2152

#

2153

# * `group:{emailid}`: An email address that represents a Google group.

2154

# For example, `admins@example.com`.

2155

#

2156

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

2157

# identifier) representing a user that has been recently deleted. For

2158

# example, `alice@example.com?uid=123456789012345678901`. If the user is

2159

# recovered, this value reverts to `user:{emailid}` and the recovered user

2160

# retains the role in the binding.

2161

#

2162

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

2163

# unique identifier) representing a service account that has been recently

2164

# deleted. For example,

2165

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

2166

# If the service account is undeleted, this value reverts to

2167

# `serviceAccount:{emailid}` and the undeleted service account retains the

2168

# role in the binding.

2169

#

2170

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

2171

# identifier) representing a Google group that has been recently

2172

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

2173

# the group is recovered, this value reverts to `group:{emailid}` and the

2174

# recovered group retains the role in the binding.

2175

#

2176

#

2177

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

2178

# users of that domain. For example, `google.com` or `example.com`.

2179

#

2180

"A String",

2181

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None)</code>

2189

<pre>Returns permissions that a caller has on the specified resource.

2190

If the resource does not exist, this will return an empty set of

2191

permissions, not a `NOT_FOUND` error.

2192

2193

Note: This operation is designed to be used for building permission-aware

2194

UIs and command-line tools, not for authorization checking. This operation

2195

may "fail open" without warning.

2196

2197

Args:

2198

resource: string, REQUIRED: The resource for which the policy detail is being requested.

2199

See the operation documentation for the appropriate value for this field. (required)

2200

body: object, The request body.

2201

The object takes the form of:

2202

2203

{ # Request message for `TestIamPermissions` method.

2204

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

2205

# wildcards (such as '*' or 'storage.*') are not allowed. For more

2206

# information see

2207

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

Returns:

An object of the form:

2215

2216

{ # Response message for `TestIamPermissions` method.

2217

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

# allowed.

"A String",

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2225

<code class="details" id="update">update(projectId, datasetId, tableId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2226

<pre>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.

2227

2228

Args:

2229

projectId: string, Project ID of the table to update (required)

2230

datasetId: string, Dataset ID of the table to update (required)

2231

tableId: string, Table ID of the table to update (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2232

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2233

The object takes the form of:

2234

2235

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2236

"view": { # [Optional] The view definition.

2237

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

2238

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

2239

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

2240

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

2241

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

2242

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

2247

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

2248

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2249

"kmsKeyName": "A String", # [Optional] 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.

2250

},

2251

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

2252

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

2253

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

2254

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

2255

},

2256

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

2257

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

2258

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2259

"requirePartitionFilter": True or False,

2260

"field": "A String", # [Beta] [Optional] 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.

2261

"expirationMs": "A String", # [Optional] 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.

2262

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

2263

},

2264

"friendlyName": "A String", # [Optional] A descriptive name for this table.

2265

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

2266

"a_key": "A String",

2267

},

2268

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2269

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2270

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2271

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2272

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

2273

"A String",

2274

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2275

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2276

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

2277

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2278

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

2279

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2280

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

2281

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2282

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2283

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2284

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2285

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2286

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2287

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

2288

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

2289

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2290

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2291

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

2292

"qualifierString": "A String",

2293

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2294

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2295

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

2296

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2297

},

2298

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2299

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

2300

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2301

},

2302

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2303

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2304

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2305

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

2306

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2307

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2308

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2309

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2310

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2311

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2312

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2313

],

2314

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2315

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2316

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2317

"policyTags": {

2318

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2319

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2320

],

2321

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2322

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2323

# Object with schema name: TableFieldSchema

2324

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2325

},

2326

],

2327

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2328

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2329

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2330

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

2331

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

2332

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2333

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2334

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2335

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

2336

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2337

},

2338

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

2339

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2340

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2341

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

2342

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2343

"lossType": "A String",

2344

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

"labels": [

2346

"A String",

2347

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

},

2349

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2350

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2351

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

2352

{

2353

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

2354

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

2355

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

2356

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

2357

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

2358

},

2359

],

2360

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2361

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

2362

"l1Reg": 3.14,

2363

"maxIteration": "A String",

2364

"learnRate": 3.14,

2365

"minRelProgress": 3.14,

2366

"l2Reg": 3.14,

2367

"warmStart": True or False,

2368

"learnRateStrategy": "A String",

2369

"lineSearchInitLearnRate": 3.14,

2370

"earlyStop": True or False,

2371

},

2372

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2373

},

2374

],

2375

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2376

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

2377

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

2378

"kind": "bigquery#table", # [Output-only] The type of the resource.

2379

"description": "A String", # [Optional] A user-friendly description of this table.

2380

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

2381

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2382

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2383

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2384

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2385

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2386

},

2387

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

2388

},

2389

"schema": { # [Optional] Describes the schema of this table.

2390

"fields": [ # Describes the fields in a table.

2391

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2392

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2393

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2394

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2395

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2400

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2401

"policyTags": {

2402

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2403

"A String",

2404

],

2405

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2406

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2407

# Object with schema name: TableFieldSchema

2408

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

2413

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

2414

"materializedView": { # [Optional] Materialized view definition.

2415

"query": "A String", # [Required] A query whose result is persisted.

2416

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

2417

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

2418

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

2419

},

2420

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2421

"projectId": "A String", # [Required] The ID of the project containing this table.

2422

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2423

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2424

},

2425

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2426

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2427

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

2428

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

2429

"A String",

2430

],

2431

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2432

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

2438

2439

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2440

"view": { # [Optional] The view definition.

2441

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

2442

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

2443

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

2444

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

2445

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

2446

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

2451

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

2452

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2453

"kmsKeyName": "A String", # [Optional] 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.

2454

},

2455

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

2456

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

2457

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

2458

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

2459

},

2460

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

2461

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

2462

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2463

"requirePartitionFilter": True or False,

2464

"field": "A String", # [Beta] [Optional] 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.

2465

"expirationMs": "A String", # [Optional] 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.

2466

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

2467

},

2468

"friendlyName": "A String", # [Optional] A descriptive name for this table.

2469

"labels": { # The labels associated with this table. You can use these to organize and group your tables. 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.

2470

"a_key": "A String",

2471

},

2472

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2473

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2474

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2475

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2476

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

2477

"A String",

2478

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2479

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2480

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

2481

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2482

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

2483

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2484

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

2485

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2486

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2487

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2488

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2489

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2490

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2491

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

2492

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

2493

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2494

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2495

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

2496

"qualifierString": "A String",

2497

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2498

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2499

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

2500

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2501

},

2502

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2503

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

2504

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2505

},

2506

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2507

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2508

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2509

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

2510

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2511

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2512

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2513

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2514

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2515

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2516

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2517

],

2518

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2519

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2520

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2521

"policyTags": {

2522

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2523

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2524

],

2525

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2526

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2527

# Object with schema name: TableFieldSchema

2528

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2529

},

2530

],

2531

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2532

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2533

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2534

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

2535

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

2536

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2537

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2538

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2539

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

2540

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2541

},

2542

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

2543

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2544

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2545

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

2546

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2547

"lossType": "A String",

2548

"modelType": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

"labels": [

2550

"A String",

2551

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2552

},

2553

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2554

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2555

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

2556

{

2557

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

2558

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

2559

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

2560

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

2561

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

2562

},

2563

],

2564

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2565

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

2566

"l1Reg": 3.14,

2567

"maxIteration": "A String",

2568

"learnRate": 3.14,

2569

"minRelProgress": 3.14,

2570

"l2Reg": 3.14,

2571

"warmStart": True or False,

2572

"learnRateStrategy": "A String",

2573

"lineSearchInitLearnRate": 3.14,

2574

"earlyStop": True or False,

2575

},

2576

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2577

},

2578

],

2579

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2580

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

2581

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

2582

"kind": "bigquery#table", # [Output-only] The type of the resource.

2583

"description": "A String", # [Optional] A user-friendly description of this table.

2584

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

2585

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2586

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2587

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2588

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2589

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2590

},

2591

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

2592

},

2593

"schema": { # [Optional] Describes the schema of this table.

2594

"fields": [ # Describes the fields in a table.

2595

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2596

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2597

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2598

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2599

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2604

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2605

"policyTags": {

2606

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2607

"A String",

2608

],

2609

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2610

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2611

# Object with schema name: TableFieldSchema

2612

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

2617

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

2618

"materializedView": { # [Optional] Materialized view definition.

2619

"query": "A String", # [Required] A query whose result is persisted.

2620

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

2621

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

2622

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

2623

},

2624

"tableReference": { # [Required] Reference describing the ID of this table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2625

"projectId": "A String", # [Required] The ID of the project containing this table.

2626

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2627

"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2628

},

2629

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2630

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2631

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

2632

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

2633

"A String",

2634

],

2635

},

Bu Sun Kim