Package io.unitycatalog.client.api

Class TablesApi

java.lang.Object
io.unitycatalog.client.api.TablesApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.9.0") public class TablesApi extends Object

  • Constructor Details

    • TablesApi

      public TablesApi()

    • TablesApi

      public TablesApi(ApiClient apiClient)

  • Method Details

    • getApiException

      protected ApiException getApiException(String operationId, HttpResponse<InputStream> response) throws IOException
      Throws:
      IOException

    • createStagingTable

      public StagingTableInfo createStagingTable(CreateStagingTable createStagingTable) throws ApiException
      Create a staging table Creates a new staging table instance. Staging tables are used during managed table creation. Creating a managed table requires performing two actions – initializing the table data in cloud storage and creating the named table entry in the catalog – and these should appear as an atomic operation to other operations on catalog tables. A staging table is used to allocate storage for the managed table, and the catalog_name.schema_name.name parameters provided in this request are used to initialize any required storage properties and determine the storage URL that should be used for the data contained by this table. Temporary credentials can be obtained as though the staging table were a regular table to get access to the staging table’s storage. After the table’s data is initialized, the staging table is “promoted” to a managed table by creating a managed table with the same location as the staging table. This allows for the atomic creation of a managed table that already has full data written to its storage location. Note: the name provided must match the name used to initialize the staging table originally. WARNING: This API is experimental and may change in future versions.
      Parameters:
      createStagingTable - (optional)
      Returns:
      StagingTableInfo
      Throws:
      ApiException - if fails to make API call

    • createStagingTableWithHttpInfo

      public ApiResponse<StagingTableInfo> createStagingTableWithHttpInfo(CreateStagingTable createStagingTable) throws ApiException
      Create a staging table Creates a new staging table instance. Staging tables are used during managed table creation. Creating a managed table requires performing two actions – initializing the table data in cloud storage and creating the named table entry in the catalog – and these should appear as an atomic operation to other operations on catalog tables. A staging table is used to allocate storage for the managed table, and the catalog_name.schema_name.name parameters provided in this request are used to initialize any required storage properties and determine the storage URL that should be used for the data contained by this table. Temporary credentials can be obtained as though the staging table were a regular table to get access to the staging table’s storage. After the table’s data is initialized, the staging table is “promoted” to a managed table by creating a managed table with the same location as the staging table. This allows for the atomic creation of a managed table that already has full data written to its storage location. Note: the name provided must match the name used to initialize the staging table originally. WARNING: This API is experimental and may change in future versions.
      Parameters:
      createStagingTable - (optional)
      Returns:
      ApiResponse<StagingTableInfo>
      Throws:
      ApiException - if fails to make API call

    • createTable

      public TableInfo createTable(CreateTable createTable) throws ApiException
      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:
      createTable - (optional)
      Returns:
      TableInfo
      Throws:
      ApiException - if fails to make API call

    • createTableWithHttpInfo

      public ApiResponse<TableInfo> createTableWithHttpInfo(CreateTable createTable) throws ApiException
      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:
      createTable - (optional)
      Returns:
      ApiResponse<TableInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteTable

      public Object deleteTable(String fullName) throws ApiException
      Delete a table Deletes a table from the specified parent catalog and schema.
      Parameters:
      fullName - Full name of the table. (required)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • deleteTableWithHttpInfo

      public ApiResponse<Object> deleteTableWithHttpInfo(String fullName) throws ApiException
      Delete a table Deletes a table from the specified parent catalog and schema.
      Parameters:
      fullName - Full name of the table. (required)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - if fails to make API call

    • getTable

      public TableInfo getTable(String fullName, Boolean readStreamingTableAsManaged, Boolean readMaterializedViewAsManaged) throws ApiException
      Get a table Gets a table for a specific catalog and schema.
      Parameters:
      fullName - Full name of the table. (required)
      readStreamingTableAsManaged - Whether to read Streaming Tables as Managed tables. (optional, default to true)
      readMaterializedViewAsManaged - Whether to read Materialized Views as Managed tables. (optional, default to true)
      Returns:
      TableInfo
      Throws:
      ApiException - if fails to make API call

    • getTableWithHttpInfo

      public ApiResponse<TableInfo> getTableWithHttpInfo(String fullName, Boolean readStreamingTableAsManaged, Boolean readMaterializedViewAsManaged) throws ApiException
      Get a table Gets a table for a specific catalog and schema.
      Parameters:
      fullName - Full name of the table. (required)
      readStreamingTableAsManaged - Whether to read Streaming Tables as Managed tables. (optional, default to true)
      readMaterializedViewAsManaged - Whether to read Materialized Views as Managed tables. (optional, default to true)
      Returns:
      ApiResponse<TableInfo>
      Throws:
      ApiException - if fails to make API call

    • listTables

      public ListTablesResponse listTables(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      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:
      catalogName - Name of parent catalog for tables of interest. (required)
      schemaName - Parent schema of tables. (required)
      maxResults - 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)
      pageToken - Opaque token to send for the next page of results (pagination). (optional)
      Returns:
      ListTablesResponse
      Throws:
      ApiException - if fails to make API call

    • listTablesWithHttpInfo

      public ApiResponse<ListTablesResponse> listTablesWithHttpInfo(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      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:
      catalogName - Name of parent catalog for tables of interest. (required)
      schemaName - Parent schema of tables. (required)
      maxResults - 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)
      pageToken - Opaque token to send for the next page of results (pagination). (optional)
      Returns:
      ApiResponse<ListTablesResponse>
      Throws:
      ApiException - if fails to make API call