Skip to content

Latest commit

 

History

History
123 lines (75 loc) · 3.69 KB

TablesApi.md

File metadata and controls

123 lines (75 loc) · 3.69 KB

TablesApi

All URIs are relative to http://localhost:8080/api/2.1/unity-catalog

Method HTTP request Description
createTable POST /tables Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions.
deleteTable DELETE /tables/{full_name} Delete a table
getTable GET /tables/{full_name} Get a table
listTables GET /tables List tables

createTable

TableInfo createTable(CreateTable)

Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions.

Creates a new external table instance. WARNING: This API is experimental and will change in future versions. 

Parameters

Name Type Description Notes
CreateTable CreateTable [optional]

Return type

TableInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteTable

oas_any_type_not_mapped deleteTable(full_name)

Delete a table

Deletes a table from the specified parent catalog and schema. 

Parameters

Name Type Description Notes
full_name String Full name of the table. [default to null]

Return type

oas_any_type_not_mapped

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTable

TableInfo getTable(full_name)

Get a table

Gets a table for a specific catalog and schema. 

Parameters

Name Type Description Notes
full_name String Full name of the table. [default to null]

Return type

TableInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listTables

ListTablesResponse listTables(catalog_name, schema_name, max_results, page_token)

List tables

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. 

Parameters

Name Type Description Notes
catalog_name String Name of parent catalog for tables of interest. [default to null]
schema_name String Parent schema of tables. [default to null]
max_results Integer 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; [optional] [default to null]
page_token String Opaque token to send for the next page of results (pagination). [optional] [default to null]

Return type

ListTablesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json