spec: get table under namespace

Author: yanghua

java/lance-catalog-apache-client/.openapi-generator/FILES

@@ -5,6 +5,7 @@ docs/CreateNamespaceRequest.md
 docs/CreateNamespaceResponse.md
 docs/ErrorModel.md
 docs/GetNamespaceResponse.md
+docs/GetTableResult.md
 docs/ListNamespacesResponse.md
 docs/NamespaceApi.md
 pom.xml
@@ -28,4 +29,5 @@ src/main/java/com/lancedb/lance/catalog/client/apache/model/CreateNamespaceReque
 src/main/java/com/lancedb/lance/catalog/client/apache/model/CreateNamespaceResponse.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/ErrorModel.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/GetNamespaceResponse.java
+src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResult.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/ListNamespacesResponse.java

java/lance-catalog-apache-client/README.md

@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
 *NamespaceApi* | [**createNamespace**](docs/NamespaceApi.md#createNamespace) | **POST** /v1/namespaces | Create a new namespace. A catalog can manage one or more namespaces. A namespace is used to manage one or more tables. There are three modes when trying to create a namespace:   * CREATE: Create the namespace if it does not exist. If a namespace of the same name already exists, the operation fails with 400.   * EXIST_OK: Create the namespace if it does not exist. If a namespace of the same name already exists, the operation succeeds and the existing namespace is kept.   * OVERWRITE: Create the namespace if it does not exist. If a namespace of the same name already exists, the existing namespace is dropped and a new namespace with this name with no table is created. 
 *NamespaceApi* | [**dropNamespace**](docs/NamespaceApi.md#dropNamespace) | **DELETE** /v1/namespaces/{ns} | Drop a namespace from the catalog. Namespace must be empty.
 *NamespaceApi* | [**getNamespace**](docs/NamespaceApi.md#getNamespace) | **GET** /v1/namespaces/{ns} | Get information about a namespace
+*NamespaceApi* | [**getTable**](docs/NamespaceApi.md#getTable) | **GET** /v1/namespaces/{ns}/tables/{table} | Get a table from the catalog
 *NamespaceApi* | [**listNamespaces**](docs/NamespaceApi.md#listNamespaces) | **GET** /v1/namespaces | List all namespaces in the catalog. 
 *NamespaceApi* | [**namespaceExists**](docs/NamespaceApi.md#namespaceExists) | **HEAD** /v1/namespaces/{ns} | Check if a namespace exists
 
@@ -127,6 +128,7 @@ Class | Method | HTTP request | Description
  - [CreateNamespaceResponse](docs/CreateNamespaceResponse.md)
  - [ErrorModel](docs/ErrorModel.md)
  - [GetNamespaceResponse](docs/GetNamespaceResponse.md)
+ - [GetTableResult](docs/GetTableResult.md)
  - [ListNamespacesResponse](docs/ListNamespacesResponse.md)
 
 

java/lance-catalog-apache-client/api/openapi.yaml

@@ -161,6 +161,35 @@ paths:
       - application/json
     parameters:
     - $ref: '#/components/parameters/namespace'
+  /v1/namespaces/{ns}/tables/{table}:
+    get:
+      description: Get a table's detailed properties under a specified namespace from
+        the catalog.".
+      operationId: GetTable
+      parameters:
+      - $ref: '#/components/parameters/namespace'
+      - $ref: '#/components/parameters/table'
+      responses:
+        "200":
+          $ref: '#/components/responses/GetTableResponse'
+        "400":
+          $ref: '#/components/responses/BadRequestErrorResponse'
+        "403":
+          $ref: '#/components/responses/ForbiddenResponse'
+        "404":
+          $ref: '#/components/responses/NotFoundResponse'
+        "503":
+          $ref: '#/components/responses/ServiceUnavailableResponse'
+        "5XX":
+          $ref: '#/components/responses/ServerErrorResponse'
+      summary: Get a table from the catalog
+      tags:
+      - Namespace
+      x-accepts:
+      - application/json
+    parameters:
+    - $ref: '#/components/parameters/namespace'
+    - $ref: '#/components/parameters/table'
 components:
   examples:
     ListNamespacesEmptyExample:
@@ -183,6 +212,15 @@ components:
       schema:
         type: string
       style: simple
+    table:
+      description: A table name.
+      explode: false
+      in: path
+      name: table
+      required: true
+      schema:
+        type: string
+      style: simple
   responses:
     CreateNamespaceResponse:
       content:
@@ -216,6 +254,12 @@ components:
             $ref: '#/components/schemas/GetNamespaceResponse'
       description: "Returns a namespace, as well as any properties stored on the namespace\
         \ if namespace properties are supported by the server."
+    GetTableResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/GetTableResult'
+      description: Table properties result when loading a table
     BadRequestErrorResponse:
       content:
         application/json:
@@ -406,4 +450,14 @@ components:
           nullable: true
       required:
       - namespace
+    GetTableResult:
+      description: |
+        Result used when a table is successfully loaded.
+      example:
+        properties:
+          key: properties
+      properties:
+        properties:
+          additionalProperties:
+            type: string
 

java/lance-catalog-apache-client/docs/GetTableResult.md

@@ -0,0 +1,14 @@
+
+
+# GetTableResult
+
+Result used when a table is successfully loaded. 
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**properties** | **Map<String, String>** |  |  [optional] |
+
+
+

java/lance-catalog-apache-client/docs/NamespaceApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:2333*
 | [**createNamespace**](NamespaceApi.md#createNamespace) | **POST** /v1/namespaces | Create a new namespace. A catalog can manage one or more namespaces. A namespace is used to manage one or more tables. There are three modes when trying to create a namespace:   * CREATE: Create the namespace if it does not exist. If a namespace of the same name already exists, the operation fails with 400.   * EXIST_OK: Create the namespace if it does not exist. If a namespace of the same name already exists, the operation succeeds and the existing namespace is kept.   * OVERWRITE: Create the namespace if it does not exist. If a namespace of the same name already exists, the existing namespace is dropped and a new namespace with this name with no table is created.  |
 | [**dropNamespace**](NamespaceApi.md#dropNamespace) | **DELETE** /v1/namespaces/{ns} | Drop a namespace from the catalog. Namespace must be empty. |
 | [**getNamespace**](NamespaceApi.md#getNamespace) | **GET** /v1/namespaces/{ns} | Get information about a namespace |
+| [**getTable**](NamespaceApi.md#getTable) | **GET** /v1/namespaces/{ns}/tables/{table} | Get a table from the catalog |
 | [**listNamespaces**](NamespaceApi.md#listNamespaces) | **GET** /v1/namespaces | List all namespaces in the catalog.  |
 | [**namespaceExists**](NamespaceApi.md#namespaceExists) | **HEAD** /v1/namespaces/{ns} | Check if a namespace exists |
 
@@ -220,6 +221,79 @@ No authorization required
 | **5XX** | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. |  -  |
 
 
+## getTable
+
+> GetTableResult getTable(ns, table)
+
+Get a table from the catalog
+
+Get a table's detailed properties under a specified namespace from the catalog.\".
+
+### Example
+
+```java
+// Import classes:
+import com.lancedb.lance.catalog.client.apache.ApiClient;
+import com.lancedb.lance.catalog.client.apache.ApiException;
+import com.lancedb.lance.catalog.client.apache.Configuration;
+import com.lancedb.lance.catalog.client.apache.models.*;
+import com.lancedb.lance.catalog.client.apache.api.NamespaceApi;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("http://localhost:2333");
+
+        NamespaceApi apiInstance = new NamespaceApi(defaultClient);
+        String ns = "ns_example"; // String | The name of the namespace.
+        String table = "table_example"; // String | A table name.
+        try {
+            GetTableResult result = apiInstance.getTable(ns, table);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NamespaceApi#getTable");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ns** | **String**| The name of the namespace. | |
+| **table** | **String**| A table name. | |
+
+### Return type
+
+[**GetTableResult**](GetTableResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Table properties result when loading a table |  -  |
+| **400** | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. |  -  |
+| **403** | Forbidden. Authenticated user does not have the necessary permissions. |  -  |
+| **404** | A server-side problem that means can not find the specified resource. |  -  |
+| **503** | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. |  -  |
+| **5XX** | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. |  -  |
+
+
 ## listNamespaces
 
 > ListNamespacesResponse listNamespaces()

java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/api/NamespaceApi.java

@@ -21,6 +21,7 @@
 import com.lancedb.lance.catalog.client.apache.model.CreateNamespaceRequest;
 import com.lancedb.lance.catalog.client.apache.model.CreateNamespaceResponse;
 import com.lancedb.lance.catalog.client.apache.model.GetNamespaceResponse;
+import com.lancedb.lance.catalog.client.apache.model.GetTableResult;
 import com.lancedb.lance.catalog.client.apache.model.ListNamespacesResponse;
 
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -267,6 +268,88 @@ public GetNamespaceResponse getNamespace(String ns, Map<String, String> addition
         localVarReturnType);
   }
 
+  /**
+   * Get a table from the catalog Get a table&#39;s detailed properties under a specified namespace
+   * from the catalog.\&quot;.
+   *
+   * @param ns The name of the namespace. (required)
+   * @param table A table name. (required)
+   * @return GetTableResult
+   * @throws ApiException if fails to make API call
+   */
+  public GetTableResult getTable(String ns, String table) throws ApiException {
+    return this.getTable(ns, table, Collections.emptyMap());
+  }
+
+  /**
+   * Get a table from the catalog Get a table&#39;s detailed properties under a specified namespace
+   * from the catalog.\&quot;.
+   *
+   * @param ns The name of the namespace. (required)
+   * @param table A table name. (required)
+   * @param additionalHeaders additionalHeaders for this call
+   * @return GetTableResult
+   * @throws ApiException if fails to make API call
+   */
+  public GetTableResult getTable(String ns, String table, Map<String, String> additionalHeaders)
+      throws ApiException {
+    Object localVarPostBody = null;
+
+    // verify the required parameter 'ns' is set
+    if (ns == null) {
+      throw new ApiException(400, "Missing the required parameter 'ns' when calling getTable");
+    }
+
+    // verify the required parameter 'table' is set
+    if (table == null) {
+      throw new ApiException(400, "Missing the required parameter 'table' when calling getTable");
+    }
+
+    // create path and map variables
+    String localVarPath =
+        "/v1/namespaces/{ns}/tables/{table}"
+            .replaceAll(
+                "\\{" + "ns" + "\\}", apiClient.escapeString(apiClient.parameterToString(ns)))
+            .replaceAll(
+                "\\{" + "table" + "\\}",
+                apiClient.escapeString(apiClient.parameterToString(table)));
+
+    StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
+    String localVarQueryParameterBaseName;
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
+    List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+    Map<String, String> localVarCookieParams = new HashMap<String, String>();
+    Map<String, Object> localVarFormParams = new HashMap<String, Object>();
+
+    localVarHeaderParams.putAll(additionalHeaders);
+
+    final String[] localVarAccepts = {"application/json"};
+    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
+
+    final String[] localVarContentTypes = {};
+
+    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
+
+    String[] localVarAuthNames = new String[] {};
+
+    TypeReference<GetTableResult> localVarReturnType = new TypeReference<GetTableResult>() {};
+    return apiClient.invokeAPI(
+        localVarPath,
+        "GET",
+        localVarQueryParams,
+        localVarCollectionQueryParams,
+        localVarQueryStringJoiner.toString(),
+        localVarPostBody,
+        localVarHeaderParams,
+        localVarCookieParams,
+        localVarFormParams,
+        localVarAccept,
+        localVarContentType,
+        localVarAuthNames,
+        localVarReturnType);
+  }
+
   /**
    * List all namespaces in the catalog.
    *