forked from unitycatalog/unitycatalog
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathall.yaml
1488 lines (1484 loc) · 49 KB
/
all.yaml
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- url: http://localhost:8080/api/2.1/unity-catalog
description: Localhost reference server
tags:
- name: Catalogs
description: |
A catalog is the first layer of Unity Catalog’s three-level namespace. It’s used to organize your data assets.
- name: Schemas
description: |
A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace. A schema organizes tables, volumes and functions.
- name: Tables
description: |
A table resides in the third layer of Unity Catalog’s three-level namespace. It contains rows of data.
A table can be managed or external.
- name: Volumes
description: |
Volumes are a Unity Catalog capability for accessing, storing, governing, organizing and processing files. Use cases include running machine learning on unstructured data such as image, audio, video, or PDF files, organizing data sets during the data exploration stages in data science, working with libraries that require access to the local file system on cluster machines, storing library and config files of arbitrary formats such as .whl or .txt centrally and providing secure access across workspaces to it, or transforming and querying non-tabular data files in ETL.
- name: Functions
description: |
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
The function implementation can be a SQL expression/query or a python function, and it can be invoked wherever a table reference is allowed in a query.
In Unity Catalog, a function resides at the same level as a table, so it can be referenced with the form __catalog_name__.__schema_name__.__function_name__.
paths:
/catalogs:
post:
tags:
- Catalogs
operationId: createCatalog
summary: Create a catalog
description: |
Creates a new catalog instance.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalog'
responses:
'200':
description: The new catalog was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogInfo'
get:
tags:
- Catalogs
parameters:
- name: page_token
in: query
description: |
Opaque pagination token to go to next page based on previous query.
schema:
type: string
required: false
- name: max_results
in: query
description: |
Maximum number of catalogs to return.
- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
- when set to 0, the page length is set to a server configured value;
- when set to a value less than 0, an invalid parameter error is returned;
schema:
type: integer
format: int32
maximum: 1000
required: false
operationId: listCatalogs
summary: List catalogs
description: |
Lists the available catalogs. There is no guarantee of a specific ordering of the elements in the list.
responses:
'200':
description: The catalog list was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCatalogsResponse'
/catalogs/{name}:
parameters:
- name: name
in: path
description: The name of the catalog.
required: true
schema:
type: string
get:
tags:
- Catalogs
operationId: getCatalog
summary: Get a catalog
description: |
Gets the specified catalog.
responses:
'200':
description: The catalog was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogInfo'
patch:
tags:
- Catalogs
operationId: updateCatalog
summary: Update a catalog
description: |
Updates the catalog that matches the supplied name.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCatalog'
responses:
'200':
description: The catalog was successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogInfo'
delete:
tags:
- Catalogs
operationId: deleteCatalog
summary: Delete a catalog
description: |
Deletes the catalog that matches the supplied name.
parameters:
- name: force
in: query
description: Force deletion even if the catalog is not empty.
required: false
schema:
type: boolean
responses:
'200':
description: The catalog was successfully deleted.
content:
application/json:
schema: {}
/schemas:
post:
tags:
- Schemas
operationId: createSchema
summary: Create a schema
description: |
Creates a new schema in the specified catalog.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSchema'
responses:
'200':
description: The new schema was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaInfo'
get:
tags:
- Schemas
parameters:
- name: catalog_name
in: query
description: Parent catalog for schemas of interest.
required: true
schema:
type: string
- name: max_results
in: query
description: |
Maximum number of schemas to return.
- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
- when set to 0, the page length is set to a server configured value;
- when set to a value less than 0, an invalid parameter error is returned;
schema:
type: integer
format: int32
maximum: 1000
required: false
- name: page_token
in: query
description: |
Opaque pagination token to go to next page based on previous query.
schema:
type: string
required: false
operationId: listSchemas
summary: List schemas
description: |
Gets an array of schemas for a catalog.
There is no guarantee of a specific ordering of the elements in the array.
responses:
'200':
description: The schemas list was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ListSchemasResponse'
/schemas/{full_name}:
parameters:
- name: full_name
in: path
description: Full name of the schema.
required: true
schema:
type: string
get:
tags:
- Schemas
operationId: getSchema
summary: Get a schema
description: |
Gets the specified schema for a catalog.
responses:
'200':
description: The schema was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaInfo'
patch:
tags:
- Schemas
operationId: updateSchema
summary: Update a schema
description: |
Updates the specified schema.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSchema'
responses:
'200':
description: The schema was successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaInfo'
delete:
tags:
- Schemas
operationId: deleteSchema
summary: Delete a schema
description: |
Deletes the specified schema from the parent catalog.
responses:
'200':
description: The schema was successfully deleted.
content:
application/json:
schema: {}
/tables:
post:
operationId: createTable
summary: |
Create a table.
WARNING: This API is experimental and will change in future versions.
tags:
- Tables
description: |
Creates a new table instance.
WARNING: This API is experimental and will change in future versions.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTable'
responses:
'200':
description: The new table was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/TableInfo'
get:
tags:
- Tables
parameters:
- name: catalog_name
in: query
description: Name of parent catalog for tables of interest.
required: true
schema:
type: string
- name: schema_name
in: query
description: Parent schema of tables.
required: true
schema:
type: string
- name: max_results
in: query
description: |
Maximum number of tables to return.
- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
- when set to 0, the page length is set to a server configured value;
- when set to a value less than 0, an invalid parameter error is returned;
required: false
schema:
type: integer
format: int32
maximum: 50
- name: page_token
in: query
description: Opaque token to send for the next page of results (pagination).
required: false
schema:
type: string
operationId: listTables
summary: List tables
description: |
Gets the list of all available tables under the parent catalog and schema.
There is no guarantee of a specific ordering of the elements in the array.
responses:
'200':
description: The tables list was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ListTablesResponse'
/tables/{full_name}:
parameters:
- name: full_name
in: path
description: Full name of the table.
required: true
schema:
type: string
get:
tags:
- Tables
operationId: getTable
summary: Get a table
description: |
Gets a table for a specific catalog and schema.
responses:
'200':
description: The table was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/TableInfo'
delete:
tags:
- Tables
operationId: deleteTable
summary: Delete a table
description: |
Deletes a table from the specified parent catalog and schema.
responses:
'200':
description: The table was successfully deleted.
content:
application/json:
schema: {}
/volumes:
post:
tags:
- Volumes
operationId: createVolume
summary: Create a Volume
description: |
Creates a new volume.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVolumeRequestContent'
examples:
CreateExternalVolumeExample:
summary: Create an External Volume
description: Create an External Volume and point the volume to a folder in the S3 bucket
value:
catalog_name: main
schema_name: default
name: my_volume
volume_type: EXTERNAL
comment: This is my first volume
responses:
'200':
description: Successfully created the volume
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeInfo'
examples:
CreateVolumeExample:
summary: Response of successful creation
description: The properties of the volume will be returned if the operation succeeds
value:
catalog_name: main
schema_name: default
name: my_volume
volume_type: EXTERNAL
created_at: 1666369196203
updated_at: 1666369196203
comment: This is my first volume
get:
tags:
- Volumes
operationId: listVolumes
summary: List Volumes
description: |
Gets an array of available volumes under the parent catalog and schema.
There is no guarantee of a specific ordering of the elements in the array.
parameters:
- name: catalog_name
in: query
description: The identifier of the catalog
schema:
type: string
required: true
examples:
CatalogNameExample:
summary: Specify the target catalog to be `main`
description: Execute the operation against the `main` catalog
value: main
- name: schema_name
in: query
description: The identifier of the schema
schema:
type: string
required: true
examples:
SchemaNameExample:
summary: Specify the target schema to be `default`
description: Execute the operation against the `default` schema
value: default
- name: max_results
in: query
description: |+
Maximum number of volumes to return (page length).
If not set, the page length is set to a server configured value.
- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
- when set to 0, the page length is set to a server configured value;
- when set to a value less than 0, an invalid parameter error is returned;
Note: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page may be smaller than this value, including 0, even if there are more pages.
required: false
schema:
type: integer
format: int32
maximum: 10000
- name: page_token
in: query
description: Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).
required: false
schema:
type: string
responses:
'200':
description: The volume list was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ListVolumesResponseContent'
examples:
ListVolumesExample:
summary: Response of success retrieval of the volumes
description: A list of volume properties will be returned if the operation succeeds
value:
volumes:
- catalog_name: main
schema_name: default
name: my_volume
volume_type: EXTERNAL
created_at: 1666369196203
updated_at: 1666369196203
comment: This is my first volume
- catalog_name: main
schema_name: default
name: my_another_volume
volume_type: EXTERNAL
created_at: 1666369196203
updated_at: 1666369196203
comment: This is my other volume
/volumes/{name}:
parameters:
- name: name
in: path
description: The three-level (fully qualified) name of the volume
schema:
type: string
required: true
examples:
FullNameArgExample:
summary: Execute the operation against the volume named `my_volume` under `main` catalog and `default` schema
value: main.default.my_volume
get:
tags:
- Volumes
operationId: getVolume
summary: Get a Volume
description: |
Gets a volume for a specific catalog and schema.
responses:
'200':
description: Successfully retrieved the properties of the volume
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeInfo'
examples:
GetVolumeExample:
summary: Response of successful retrieval of an existing volume
description: The properties of the volume will be returned if the operation succeeds
value:
catalog_name: main
schema_name: default
name: my_volume
volume_type: EXTERNAL
created_at: 1666369196203
updated_at: 1666369196203
comment: This is my first volume
patch:
tags:
- Volumes
operationId: updateVolume
summary: Update a Volume
description: |
Updates the specified volume under the specified parent catalog and schema.
Currently only the name or the comment of the volume could be updated.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVolumeRequestContent'
examples:
UpdateVolumeName:
summary: Update the name of the volume
description: Update the name of the volume
value:
new_name: my_new_volume
UpdateVolumeComment:
summary: Update the comment of the volume
description: Update the comment of the volume
value:
comment: This is my new volume
responses:
'200':
description: Successfully updated the properties of the volume
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeInfo'
examples:
UpdateVolumeName:
summary: Update the name of the volume
description: The new properties of the volume will be returned if the operation succeeds
value:
catalog_name: main
schema_name: default
name: my_new_volume
volume_type: EXTERNAL
created_at: 1666369196203
updated_at: 1666369207415
comment: This is my new volume
delete:
tags:
- Volumes
operationId: deleteVolume
summary: Delete a Volume
description: |
Deletes a volume from the specified parent catalog and schema.
responses:
'200':
description: Successfully deleted the volume
content:
application/json:
schema: {}
/temporary-table-credentials:
post:
operationId: generateTemporaryTableCredentials
tags:
- TemporaryTableCredentials
summary: Generate temporary table credentials.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTemporaryTableCredential'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTemporaryTableCredentialResponse'
/temporary-volume-credentials:
post:
operationId: generateTemporaryVolumeCredentials
tags:
- TemporaryVolumeCredentials
summary: Generate temporary volume credentials.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTemporaryVolumeCredential'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTemporaryVolumeCredentialResponse'
"/functions":
post:
tags:
- Functions
operationId: createFunction
summary: |
Create a function.
WARNING: This API is experimental and will change in future versions.
description: |
Creates a new function instance.
WARNING: This API is experimental and will change in future versions.
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateFunctionRequest"
responses:
'200':
description: The new function was successfully created.
content:
application/json:
schema:
"$ref": "#/components/schemas/FunctionInfo"
get:
tags:
- Functions
parameters:
- name: catalog_name
in: query
description: Name of parent catalog for functions of interest.
required: true
schema:
type: string
- name: schema_name
in: query
description: Parent schema of functions.
required: true
schema:
type: string
- name: max_results
in: query
description: |
Maximum number of functions to return.
- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
- when set to 0, the page length is set to a server configured value;
- when set to a value less than 0, an invalid parameter error is returned;
schema:
type: integer
format: int32
maximum: 1000
required: false
- name: page_token
in: query
description: 'Opaque pagination token to go to next page based on previous
query.'
schema:
type: string
required: false
operationId: listFunctions
summary: List functions
description: |
List functions within the specified parent catalog and schema.
There is no guarantee of a specific ordering of the elements in the array.
responses:
'200':
description: The function list was successfully retrieved.
content:
application/json:
schema:
"$ref": "#/components/schemas/ListFunctionsResponse"
"/functions/{name}":
parameters:
- name: name
in: path
description: The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).
required: true
schema:
type: string
get:
tags:
- Functions
parameters: []
operationId: getFunction
summary: Get a function
description: 'Gets a function from within a parent catalog and schema.'
responses:
'200':
description: The function was successfully retrieved.
content:
application/json:
schema:
"$ref": "#/components/schemas/FunctionInfo"
delete:
tags:
- Functions
operationId: deleteFunction
summary: Delete a function
description: 'Deletes the function that matches the supplied name.'
responses:
'200':
description: The function was successfully deleted.
content:
application/json:
schema: {}
components:
schemas:
SecurablePropertiesMap:
description: A map of key-value properties attached to the securable.
type: object
additionalProperties:
type: string
VolumeType:
type: string
enum:
- MANAGED
- EXTERNAL
description: The type of the volume
CreateVolumeRequestContent:
type: object
properties:
catalog_name:
type: string
description: The name of the catalog where the schema and the volume are
schema_name:
type: string
description: The name of the schema where the volume is
name:
type: string
description: The name of the volume
"volume_type":
"$ref": "#/components/schemas/VolumeType"
comment:
type: string
maxLength: 65536
minLength: 1
description: The comment attached to the volume
storage_location:
type: string
description: The storage location of the volume
required:
- catalog_name
- schema_name
- name
- volume_type
- storage_location
ListVolumesResponseContent:
type: object
properties:
volumes:
type: array
items:
$ref: '#/components/schemas/VolumeInfo'
next_page_token:
description: |
Opaque token to retrieve the next page of results. Absent if there are no more pages.
__page_token__ should be set to this value for the next request to retrieve the next page of results.
type: string
UpdateVolumeRequestContent:
type: object
properties:
comment:
type: string
maxLength: 65536
minLength: 1
description: The comment attached to the volume
new_name:
description: New name for the volume.
type: string
VolumeInfo:
type: object
properties:
catalog_name:
type: string
description: The name of the catalog where the schema and the volume are
schema_name:
type: string
description: The name of the schema where the volume is
name:
type: string
description: The name of the volume
comment:
type: string
maxLength: 65536
minLength: 1
description: The comment attached to the volume
created_at:
type: integer
format: int64
description: Time at which this volume was created, in epoch milliseconds.
updated_at:
type: integer
format: int64
description: Time at which this volume was last modified, in epoch milliseconds.
volume_id:
type: string
description: Unique identifier for the volume
"volume_type":
"$ref": "#/components/schemas/VolumeType"
storage_location:
type: string
description: The storage location of the volume
full_name:
type: string
description: Full name of volume, in form of __catalog_name__.__schema_name__.__volume_name__.
ColumnTypeName:
description: Name of type (INT, STRUCT, MAP, etc.).
type: string
enum:
- BOOLEAN
- BYTE
- SHORT
- INT
- LONG
- FLOAT
- DOUBLE
- DATE
- TIMESTAMP
- TIMESTAMP_NTZ
- STRING
- BINARY
- DECIMAL
- INTERVAL
- ARRAY
- STRUCT
- MAP
- CHAR
- 'NULL'
- USER_DEFINED_TYPE
- TABLE_TYPE
ColumnInfo:
type: object
properties:
name:
description: Name of Column.
type: string
type_text:
description: Full data type specification as SQL/catalogString text.
type: string
type_json:
description: Full data type specification, JSON-serialized.
type: string
type_name:
$ref: '#/components/schemas/ColumnTypeName'
type_precision:
description: Digits of precision; required for DecimalTypes.
type: integer
format: int32
type_scale:
description: Digits to right of decimal; Required for DecimalTypes.
type: integer
format: int32
type_interval_type:
description: Format of IntervalType.
type: string
position:
description: Ordinal position of column (starting at position 0).
type: integer
format: int32
comment:
description: User-provided free-form text description.
type: string
nullable:
description: Whether field may be Null.
type: boolean
default: 'true'
partition_index:
description: Partition index for column.
type: integer
format: int32
TableType:
type: string
enum:
- MANAGED
- EXTERNAL
DataSourceFormat:
description: Data source format
type: string
enum:
- DELTA
- CSV
- JSON
- AVRO
- PARQUET
- ORC
- TEXT
TableInfo:
type: object
properties:
name:
description: Name of table, relative to parent schema.
type: string
catalog_name:
description: Name of parent catalog.
type: string
schema_name:
description: Name of parent schema relative to its parent catalog.
type: string
table_type:
$ref: '#/components/schemas/TableType'
data_source_format:
$ref: '#/components/schemas/DataSourceFormat'
columns:
description: The array of __ColumnInfo__ definitions of the table's columns.
type: array
items:
$ref: '#/components/schemas/ColumnInfo'
storage_location:
description: Storage root URL for table (for **MANAGED**, **EXTERNAL** tables)
type: string
comment:
description: User-provided free-form text description.
type: string
properties:
$ref: '#/components/schemas/SecurablePropertiesMap'
created_at:
description: Time at which this table was created, in epoch milliseconds.
type: integer
format: int64
updated_at:
description: Time at which this table was last modified, in epoch milliseconds.
type: integer
format: int64
table_id:
description: Unique identifier for the table.
type: string
CreateTable:
type: object
properties:
name:
description: Name of table, relative to parent schema.
type: string
catalog_name:
description: Name of parent catalog.
type: string
schema_name:
description: Name of parent schema relative to its parent catalog.
type: string
table_type:
$ref: '#/components/schemas/TableType'
data_source_format:
$ref: '#/components/schemas/DataSourceFormat'
columns:
description: The array of __ColumnInfo__ definitions of the table's columns.
type: array
items:
$ref: '#/components/schemas/ColumnInfo'
storage_location:
description: Storage root URL for table (for **MANAGED**, **EXTERNAL** tables)
type: string
comment:
description: User-provided free-form text description.
type: string
properties:
$ref: '#/components/schemas/SecurablePropertiesMap'
required:
- name
- catalog_name
- schema_name
- table_type
- data_source_format
- columns
ListTablesResponse:
type: object
properties:
tables:
description: An array of table information objects.
type: array
items:
$ref: '#/components/schemas/TableInfo'
next_page_token:
description: |
Opaque token to retrieve the next page of results. Absent if there are no more pages.
__page_token__ should be set to this value for the next request (for the next page of results).
type: string
SchemaInfo:
type: object
properties:
name:
description: Name of schema, relative to parent catalog.
type: string
catalog_name:
description: Name of parent catalog.
type: string
comment:
description: User-provided free-form text description.
type: string
properties: