1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="biglake_v1.html">BigLake API</a> . <a href="biglake_v1.projects.html">projects</a> . <a href="biglake_v1.projects.locations.html">locations</a> . <a href="biglake_v1.projects.locations.catalogs.html">catalogs</a> . <a href="biglake_v1.projects.locations.catalogs.databases.html">databases</a> . <a href="biglake_v1.projects.locations.catalogs.databases.tables.html">tables</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, tableId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new table.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing table specified by the table ID.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the table specified by the resource name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all tables in a specified database.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing table specified by the table ID.</p>
<p class="toc_element">
<code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Renames an existing table specified by the table ID.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, tableId=None, x__xgafv=None)</code>
<pre>Creates a new table.
Args:
parent: string, Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}
tableId: string, Required. The ID to use for the table, which will become the final component of the table's resource name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an existing table specified by the table ID.
Args:
name: string, Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the table specified by the resource name.
Args:
name: string, Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>List all tables in a specified database.
Args:
parent: string, Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required)
pageSize: integer, The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.
view: string, The view for the returned tables.
Allowed values
TABLE_VIEW_UNSPECIFIED - Default value. The API will default to the BASIC view.
BASIC - Include only table names. This is the default value.
FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListTables method.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"tables": [ # The tables from the specified database.
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing table specified by the table ID.
Args:
name: string, Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}
updateMask: string, The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}</pre>
</div>
<div class="method">
<code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code>
<pre>Renames an existing table specified by the table ID.
Args:
name: string, Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the RenameTable method in MetastoreService
"newName": "A String", # Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a table.
"createTime": "A String", # Output only. The creation time of the table.
"deleteTime": "A String", # Output only. The deletion time of the table. Only set after the table is deleted.
"etag": "A String", # The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.
"expireTime": "A String", # Output only. The time when this table is considered expired. Only set after the table is deleted.
"hiveOptions": { # Options of a Hive table. # Options of a Hive table.
"parameters": { # Stores user supplied Hive table parameters.
"a_key": "A String",
},
"storageDescriptor": { # Stores physical storage information of the data. # Stores physical storage information of the data.
"inputFormat": "A String", # The fully qualified Java class name of the input format.
"locationUri": "A String", # Cloud Storage folder URI where the table data is stored, starting with "gs://".
"outputFormat": "A String", # The fully qualified Java class name of the output format.
"serdeInfo": { # Serializer and deserializer information. # Serializer and deserializer information.
"serializationLib": "A String", # The fully qualified Java class name of the serialization library.
},
},
"tableType": "A String", # Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
},
"name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
"type": "A String", # The table type.
"updateTime": "A String", # Output only. The last modification time of the table.
}</pre>
</div>
</body></html>
|
