feat: add tag field to DescribeTableRequest

docs/src/namespace/operations/models/DescribeTableRequest.md

@@ -11,6 +11,7 @@
 |**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.  REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.  |  [optional] |
 |**id** | **List<String>** |  |  [optional] |
 |**version** | **Long** | Version of the table to describe. If not specified, server should resolve it to the latest version.  |  [optional] |
+|**tag** | **String** | Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`.  |  [optional] |
 |**branch** | **String** | Branch to target. When not specified, the main branch is used.  |  [optional] |
 |**withTableUri** | **Boolean** | Whether to include the table URI in the response. Default is false.  |  [optional] |
 |**loadDetailedMetadata** | **Boolean** | Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as `version`, `schema`, and `stats` which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.  |  [optional] |

docs/src/spec.yaml

@@ -2735,6 +2735,12 @@ components:
           type: integer
           format: int64
           minimum: 0
+        tag:
+          description: |
+            Tag name to describe the table at.
+            If specified, the server should resolve the tag to a version number and describe that version.
+            Cannot be used together with `version` or `branch`.
+          type: string
         branch:
           type: string
           description: |

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

@@ -3799,6 +3799,7 @@ components:
         id:
         - id
         - id
+        tag: tag
         version: 0
         branch: branch
         with_table_uri: false
@@ -3829,6 +3830,12 @@ components:
           format: int64
           minimum: 0
           type: integer
+        tag:
+          description: |
+            Tag name to describe the table at.
+            If specified, the server should resolve the tag to a version number and describe that version.
+            Cannot be used together with `version` or `branch`.
+          type: string
         branch:
           description: |
             Branch to target. When not specified, the main branch is used.

java/lance-namespace-apache-client/docs/DescribeTableRequest.md

@@ -11,6 +11,7 @@
 |**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.  REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.  |  [optional] |
 |**id** | **List<String>** |  |  [optional] |
 |**version** | **Long** | Version of the table to describe. If not specified, server should resolve it to the latest version.  |  [optional] |
+|**tag** | **String** | Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`.  |  [optional] |
 |**branch** | **String** | Branch to target. When not specified, the main branch is used.  |  [optional] |
 |**withTableUri** | **Boolean** | Whether to include the table URI in the response. Default is false.  |  [optional] |
 |**loadDetailedMetadata** | **Boolean** | Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as `version`, `schema`, and `stats` which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.  |  [optional] |

java/lance-namespace-apache-client/src/main/java/org/lance/namespace/model/DescribeTableRequest.java

@@ -32,6 +32,7 @@
   DescribeTableRequest.JSON_PROPERTY_CONTEXT,
   DescribeTableRequest.JSON_PROPERTY_ID,
   DescribeTableRequest.JSON_PROPERTY_VERSION,
+  DescribeTableRequest.JSON_PROPERTY_TAG,
   DescribeTableRequest.JSON_PROPERTY_BRANCH,
   DescribeTableRequest.JSON_PROPERTY_WITH_TABLE_URI,
   DescribeTableRequest.JSON_PROPERTY_LOAD_DETAILED_METADATA,
@@ -54,6 +55,9 @@ public class DescribeTableRequest {
   public static final String JSON_PROPERTY_VERSION = "version";
   @javax.annotation.Nullable private Long version;
 
+  public static final String JSON_PROPERTY_TAG = "tag";
+  @javax.annotation.Nullable private String tag;
+
   public static final String JSON_PROPERTY_BRANCH = "branch";
   @javax.annotation.Nullable private String branch;
 
@@ -188,6 +192,32 @@ public void setVersion(@javax.annotation.Nullable Long version) {
     this.version = version;
   }
 
+  public DescribeTableRequest tag(@javax.annotation.Nullable String tag) {
+
+    this.tag = tag;
+    return this;
+  }
+
+  /**
+   * Tag name to describe the table at. If specified, the server should resolve the tag to a version
+   * number and describe that version. Cannot be used together with `version` or
+   * `branch`.
+   *
+   * @return tag
+   */
+  @javax.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_TAG)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public String getTag() {
+    return tag;
+  }
+
+  @JsonProperty(JSON_PROPERTY_TAG)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public void setTag(@javax.annotation.Nullable String tag) {
+    this.tag = tag;
+  }
+
   public DescribeTableRequest branch(@javax.annotation.Nullable String branch) {
 
     this.branch = branch;
@@ -330,6 +360,7 @@ public boolean equals(Object o) {
         && Objects.equals(this.context, describeTableRequest.context)
         && Objects.equals(this.id, describeTableRequest.id)
         && Objects.equals(this.version, describeTableRequest.version)
+        && Objects.equals(this.tag, describeTableRequest.tag)
         && Objects.equals(this.branch, describeTableRequest.branch)
         && Objects.equals(this.withTableUri, describeTableRequest.withTableUri)
         && Objects.equals(this.loadDetailedMetadata, describeTableRequest.loadDetailedMetadata)
@@ -344,6 +375,7 @@ public int hashCode() {
         context,
         id,
         version,
+        tag,
         branch,
         withTableUri,
         loadDetailedMetadata,
@@ -359,6 +391,7 @@ public String toString() {
     sb.append("    context: ").append(toIndentedString(context)).append("\n");
     sb.append("    id: ").append(toIndentedString(id)).append("\n");
     sb.append("    version: ").append(toIndentedString(version)).append("\n");
+    sb.append("    tag: ").append(toIndentedString(tag)).append("\n");
     sb.append("    branch: ").append(toIndentedString(branch)).append("\n");
     sb.append("    withTableUri: ").append(toIndentedString(withTableUri)).append("\n");
     sb.append("    loadDetailedMetadata: ")
@@ -475,6 +508,21 @@ public String toUrlQueryString(String prefix) {
       }
     }
 
+    // add `tag` to the URL query string
+    if (getTag() != null) {
+      try {
+        joiner.add(
+            String.format(
+                "%stag%s=%s",
+                prefix,
+                suffix,
+                URLEncoder.encode(String.valueOf(getTag()), "UTF-8").replaceAll("\\+", "%20")));
+      } catch (UnsupportedEncodingException e) {
+        // Should never happen, UTF-8 is always supported
+        throw new RuntimeException(e);
+      }
+    }
+
     // add `branch` to the URL query string
     if (getBranch() != null) {
       try {

java/lance-namespace-async-client/api/openapi.yaml

@@ -3799,6 +3799,7 @@ components:
         id:
         - id
         - id
+        tag: tag
         version: 0
         branch: branch
         with_table_uri: false
@@ -3829,6 +3830,12 @@ components:
           format: int64
           minimum: 0
           type: integer
+        tag:
+          description: |
+            Tag name to describe the table at.
+            If specified, the server should resolve the tag to a version number and describe that version.
+            Cannot be used together with `version` or `branch`.
+          type: string
         branch:
           description: |
             Branch to target. When not specified, the main branch is used.

java/lance-namespace-async-client/docs/DescribeTableRequest.md

@@ -11,6 +11,7 @@
 |**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.  REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.  |  [optional] |
 |**id** | **List<String>** |  |  [optional] |
 |**version** | **Long** | Version of the table to describe. If not specified, server should resolve it to the latest version.  |  [optional] |
+|**tag** | **String** | Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`.  |  [optional] |
 |**branch** | **String** | Branch to target. When not specified, the main branch is used.  |  [optional] |
 |**withTableUri** | **Boolean** | Whether to include the table URI in the response. Default is false.  |  [optional] |
 |**loadDetailedMetadata** | **Boolean** | Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as `version`, `schema`, and `stats` which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.  |  [optional] |

java/lance-namespace-async-client/src/main/java/org/lance/namespace/model/DescribeTableRequest.java

@@ -32,6 +32,7 @@
   DescribeTableRequest.JSON_PROPERTY_CONTEXT,
   DescribeTableRequest.JSON_PROPERTY_ID,
   DescribeTableRequest.JSON_PROPERTY_VERSION,
+  DescribeTableRequest.JSON_PROPERTY_TAG,
   DescribeTableRequest.JSON_PROPERTY_BRANCH,
   DescribeTableRequest.JSON_PROPERTY_WITH_TABLE_URI,
   DescribeTableRequest.JSON_PROPERTY_LOAD_DETAILED_METADATA,
@@ -54,6 +55,9 @@ public class DescribeTableRequest {
   public static final String JSON_PROPERTY_VERSION = "version";
   @javax.annotation.Nullable private Long version;
 
+  public static final String JSON_PROPERTY_TAG = "tag";
+  @javax.annotation.Nullable private String tag;
+
   public static final String JSON_PROPERTY_BRANCH = "branch";
   @javax.annotation.Nullable private String branch;
 
@@ -184,6 +188,31 @@ public void setVersion(@javax.annotation.Nullable Long version) {
     this.version = version;
   }
 
+  public DescribeTableRequest tag(@javax.annotation.Nullable String tag) {
+    this.tag = tag;
+    return this;
+  }
+
+  /**
+   * Tag name to describe the table at. If specified, the server should resolve the tag to a version
+   * number and describe that version. Cannot be used together with `version` or
+   * `branch`.
+   *
+   * @return tag
+   */
+  @javax.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_TAG)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public String getTag() {
+    return tag;
+  }
+
+  @JsonProperty(JSON_PROPERTY_TAG)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public void setTag(@javax.annotation.Nullable String tag) {
+    this.tag = tag;
+  }
+
   public DescribeTableRequest branch(@javax.annotation.Nullable String branch) {
     this.branch = branch;
     return this;
@@ -322,6 +351,7 @@ public boolean equals(Object o) {
         && Objects.equals(this.context, describeTableRequest.context)
         && Objects.equals(this.id, describeTableRequest.id)
         && Objects.equals(this.version, describeTableRequest.version)
+        && Objects.equals(this.tag, describeTableRequest.tag)
         && Objects.equals(this.branch, describeTableRequest.branch)
         && Objects.equals(this.withTableUri, describeTableRequest.withTableUri)
         && Objects.equals(this.loadDetailedMetadata, describeTableRequest.loadDetailedMetadata)
@@ -336,6 +366,7 @@ public int hashCode() {
         context,
         id,
         version,
+        tag,
         branch,
         withTableUri,
         loadDetailedMetadata,
@@ -351,6 +382,7 @@ public String toString() {
     sb.append("    context: ").append(toIndentedString(context)).append("\n");
     sb.append("    id: ").append(toIndentedString(id)).append("\n");
     sb.append("    version: ").append(toIndentedString(version)).append("\n");
+    sb.append("    tag: ").append(toIndentedString(tag)).append("\n");
     sb.append("    branch: ").append(toIndentedString(branch)).append("\n");
     sb.append("    withTableUri: ").append(toIndentedString(withTableUri)).append("\n");
     sb.append("    loadDetailedMetadata: ")
@@ -448,6 +480,14 @@ public String toUrlQueryString(String prefix) {
               prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getVersion()))));
     }
 
+    // add `tag` to the URL query string
+    if (getTag() != null) {
+      joiner.add(
+          String.format(
+              "%stag%s=%s",
+              prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getTag()))));
+    }
+
     // add `branch` to the URL query string
     if (getBranch() != null) {
       joiner.add(

java/lance-namespace-springboot-server/src/main/java/org/lance/namespace/server/springboot/model/DescribeTableRequest.java

@@ -40,6 +40,8 @@ public class DescribeTableRequest {
 
   private Long version;
 
+  private String tag;
+
   private String branch;
 
   private Boolean withTableUri = false;
@@ -160,6 +162,31 @@ public void setVersion(Long version) {
     this.version = version;
   }
 
+  public DescribeTableRequest tag(String tag) {
+    this.tag = tag;
+    return this;
+  }
+
+  /**
+   * Tag name to describe the table at. If specified, the server should resolve the tag to a version
+   * number and describe that version. Cannot be used together with `version` or `branch`.
+   *
+   * @return tag
+   */
+  @Schema(
+      name = "tag",
+      description =
+          "Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`. ",
+      requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+  @JsonProperty("tag")
+  public String getTag() {
+    return tag;
+  }
+
+  public void setTag(String tag) {
+    this.tag = tag;
+  }
+
   public DescribeTableRequest branch(String branch) {
     this.branch = branch;
     return this;
@@ -299,6 +326,7 @@ public boolean equals(Object o) {
         && Objects.equals(this.context, describeTableRequest.context)
         && Objects.equals(this.id, describeTableRequest.id)
         && Objects.equals(this.version, describeTableRequest.version)
+        && Objects.equals(this.tag, describeTableRequest.tag)
         && Objects.equals(this.branch, describeTableRequest.branch)
         && Objects.equals(this.withTableUri, describeTableRequest.withTableUri)
         && Objects.equals(this.loadDetailedMetadata, describeTableRequest.loadDetailedMetadata)
@@ -313,6 +341,7 @@ public int hashCode() {
         context,
         id,
         version,
+        tag,
         branch,
         withTableUri,
         loadDetailedMetadata,
@@ -328,6 +357,7 @@ public String toString() {
     sb.append("    context: ").append(toIndentedString(context)).append("\n");
     sb.append("    id: ").append(toIndentedString(id)).append("\n");
     sb.append("    version: ").append(toIndentedString(version)).append("\n");
+    sb.append("    tag: ").append(toIndentedString(tag)).append("\n");
     sb.append("    branch: ").append(toIndentedString(branch)).append("\n");
     sb.append("    withTableUri: ").append(toIndentedString(withTableUri)).append("\n");
     sb.append("    loadDetailedMetadata: ")

python/lance_namespace_urllib3_client/docs/DescribeTableRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **context** | **Dict[str, str]** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.  REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.  | [optional] 
 **id** | **List[str]** |  | [optional] 
 **version** | **int** | Version of the table to describe. If not specified, server should resolve it to the latest version.  | [optional] 
+**tag** | **str** | Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`.  | [optional] 
 **branch** | **str** | Branch to target. When not specified, the main branch is used.  | [optional] 
 **with_table_uri** | **bool** | Whether to include the table URI in the response. Default is false.  | [optional] [default to False]
 **load_detailed_metadata** | **bool** | Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as `version`, `schema`, and `stats` which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.  | [optional]