spec: get table under namespace (#42)

close #41

Author: yanghua

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

@@ -119,6 +119,7 @@ Class | Method | HTTP request | Description
 *NamespaceApi* | [**getNamespace**](docs/NamespaceApi.md#getNamespace) | **GET** /v1/namespaces/{ns} | Get information about a namespace
 *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
+*TableApi* | [**getTable**](docs/TableApi.md#getTable) | **GET** /v1/namespaces/{ns}/tables/{table} | Get a table from the catalog
 *TableApi* | [**registerTable**](docs/TableApi.md#registerTable) | **POST** /v1/namespaces/{ns}/register | Register a new table in the given namespace. A table represents a lance dataset.  In Lance catalog, a table must be hosted in a namespace. 
 
 

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

@@ -207,6 +207,37 @@ paths:
       x-content-type: application/json
       x-accepts:
       - application/json
+  /v1/namespaces/{ns}/tables/{table}:
+    get:
+      description: Get a table's detailed information 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'
+        "401":
+          $ref: '#/components/responses/UnauthorizedResponse'
+        "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:
+      - Table
+      x-accepts:
+      - application/json
+    parameters:
+    - $ref: '#/components/parameters/namespace'
+    - $ref: '#/components/parameters/table'
 components:
   examples:
     ListNamespacesEmptyExample:
@@ -249,6 +280,15 @@ components:
         minimum: 1
         type: integer
       style: form
+    table:
+      description: A table name.
+      explode: false
+      in: path
+      name: table
+      required: true
+      schema:
+        type: string
+      style: simple
   responses:
     CreateNamespaceResponse:
       content:

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

@@ -4,10 +4,85 @@ All URIs are relative to *http://localhost:2333*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**getTable**](TableApi.md#getTable) | **GET** /v1/namespaces/{ns}/tables/{table} | Get a table from the catalog |
 | [**registerTable**](TableApi.md#registerTable) | **POST** /v1/namespaces/{ns}/register | Register a new table in the given namespace. A table represents a lance dataset.  In Lance catalog, a table must be hosted in a namespace.  |
 
 
 
+## getTable
+
+> GetTableResponse getTable(ns, table)
+
+Get a table from the catalog
+
+Get a table's detailed information 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.TableApi;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("http://localhost:2333");
+
+        TableApi apiInstance = new TableApi(defaultClient);
+        String ns = "ns_example"; // String | The name of the namespace.
+        String table = "table_example"; // String | A table name.
+        try {
+            GetTableResponse result = apiInstance.getTable(ns, table);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TableApi#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
+
+[**GetTableResponse**](GetTableResponse.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. |  -  |
+| **401** | Unauthorized. The request lacks valid authentication credentials for the operation. |  -  |
+| **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. |  -  |
+
+
 ## registerTable
 
 > GetTableResponse registerTable(ns, registerTableRequest)

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

@@ -43,6 +43,88 @@ public TableApi(ApiClient apiClient) {
     super(apiClient);
   }
 
+  /**
+   * Get a table from the catalog Get a table's detailed information under a specified namespace
+   * from the catalog.
+   *
+   * @param ns The name of the namespace. (required)
+   * @param table A table name. (required)
+   * @return GetTableResponse
+   * @throws ApiException if fails to make API call
+   */
+  public GetTableResponse getTable(String ns, String table) throws ApiException {
+    return this.getTable(ns, table, Collections.emptyMap());
+  }
+
+  /**
+   * Get a table from the catalog Get a table's detailed information under a specified namespace
+   * from the catalog.
+   *
+   * @param ns The name of the namespace. (required)
+   * @param table A table name. (required)
+   * @param additionalHeaders additionalHeaders for this call
+   * @return GetTableResponse
+   * @throws ApiException if fails to make API call
+   */
+  public GetTableResponse 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<GetTableResponse> localVarReturnType = new TypeReference<GetTableResponse>() {};
+    return apiClient.invokeAPI(
+        localVarPath,
+        "GET",
+        localVarQueryParams,
+        localVarCollectionQueryParams,
+        localVarQueryStringJoiner.toString(),
+        localVarPostBody,
+        localVarHeaderParams,
+        localVarCookieParams,
+        localVarFormParams,
+        localVarAccept,
+        localVarContentType,
+        localVarAuthNames,
+        localVarReturnType);
+  }
+
   /**
    * Register a new table in the given namespace. A table represents a lance dataset. In Lance
    * catalog, a table must be hosted in a namespace.