feat: add partition spec to rest.yaml (#297)

Author: wojiaodoubao

docs/src/rest.yaml

@@ -4152,6 +4152,69 @@ components:
           type: string
           description: Optional transaction identifier
 
+    PartitionTransform:
+      type: object
+      description: Well-known partition transform
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          description: Transform type (identity, year, month, day, hour, bucket, multi_bucket, truncate)
+        num_buckets:
+          type: integer
+          description: Number of buckets for bucket transforms
+        width:
+          type: integer
+          description: Truncation width for truncate transforms
+
+    PartitionField:
+      type: object
+      description: Partition field definition
+      required:
+        - field_id
+        - source_ids
+        - result_type
+      properties:
+        field_id:
+          type: string
+          description: Unique identifier for this partition field (must not be renamed)
+          example: "event_year"
+        source_ids:
+          type: array
+          items:
+            type: integer
+          description: Field IDs of the source columns in the schema
+          example: [1]
+        transform:
+          $ref: '#/components/schemas/PartitionTransform'
+          description: Well-known partition transform. Exactly one of transform or expression must be specified.
+        expression:
+          type: string
+          description: DataFusion SQL expression using col0, col1, ... as column references. Exactly one of transform or expression must be specified.
+          example: "date_part('year', col0)"
+        result_type:
+          $ref: '#/components/schemas/JsonArrowDataType'
+          description: The output type of the partition value (JsonArrowDataType format)
+          example: {"type": "int32"}
+
+    PartitionSpec:
+      type: object
+      description: Partition spec definition
+      required:
+        - id
+        - fields
+      properties:
+        id:
+          type: integer
+          description: The spec version ID
+          example: 1
+        fields:
+          type: array
+          items:
+            $ref: '#/components/schemas/PartitionField'
+          description: Array of partition field definitions
+
   responses:
     ListNamespacesResponse:
       description: A list of namespaces

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

@@ -319,6 +319,9 @@ Class | Method | HTTP request | Description
  - [MultiMatchQuery](docs/MultiMatchQuery.md)
  - [NamespaceExistsRequest](docs/NamespaceExistsRequest.md)
  - [NewColumnTransform](docs/NewColumnTransform.md)
+ - [PartitionField](docs/PartitionField.md)
+ - [PartitionSpec](docs/PartitionSpec.md)
+ - [PartitionTransform](docs/PartitionTransform.md)
  - [PhraseQuery](docs/PhraseQuery.md)
  - [QueryTableRequest](docs/QueryTableRequest.md)
  - [QueryTableRequestColumns](docs/QueryTableRequestColumns.md)

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

@@ -6169,6 +6169,63 @@ components:
         transaction_id:
           description: Optional transaction identifier
           type: string
+    PartitionTransform:
+      description: Well-known partition transform
+      properties:
+        type:
+          description: "Transform type (identity, year, month, day, hour, bucket,\
+            \ multi_bucket, truncate)"
+          type: string
+        num_buckets:
+          description: Number of buckets for bucket transforms
+          type: integer
+        width:
+          description: Truncation width for truncate transforms
+          type: integer
+      required:
+      - type
+    PartitionField:
+      description: Partition field definition
+      properties:
+        field_id:
+          description: Unique identifier for this partition field (must not be renamed)
+          example: event_year
+          type: string
+        source_ids:
+          description: Field IDs of the source columns in the schema
+          example:
+          - 1
+          items:
+            type: integer
+          type: array
+        transform:
+          $ref: '#/components/schemas/PartitionTransform'
+        expression:
+          description: "DataFusion SQL expression using col0, col1, ... as column\
+            \ references. Exactly one of transform or expression must be specified."
+          example: "date_part('year', col0)"
+          type: string
+        result_type:
+          $ref: '#/components/schemas/JsonArrowDataType'
+      required:
+      - field_id
+      - result_type
+      - source_ids
+    PartitionSpec:
+      description: Partition spec definition
+      properties:
+        id:
+          description: The spec version ID
+          example: 1
+          type: integer
+        fields:
+          description: Array of partition field definitions
+          items:
+            $ref: '#/components/schemas/PartitionField'
+          type: array
+      required:
+      - fields
+      - id
     QueryTableRequest_columns:
       description: |
         Optional columns to return. Provide either column_names or column_aliases, not both.

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

@@ -0,0 +1,18 @@
+
+
+# PartitionField
+
+Partition field definition
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldId** | **String** | Unique identifier for this partition field (must not be renamed) |  |
+|**sourceIds** | **List<Integer>** | Field IDs of the source columns in the schema |  |
+|**transform** | [**PartitionTransform**](PartitionTransform.md) | Well-known partition transform. Exactly one of transform or expression must be specified. |  [optional] |
+|**expression** | **String** | DataFusion SQL expression using col0, col1, ... as column references. Exactly one of transform or expression must be specified. |  [optional] |
+|**resultType** | [**JsonArrowDataType**](JsonArrowDataType.md) | The output type of the partition value (JsonArrowDataType format) |  |
+
+
+

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

@@ -0,0 +1,15 @@
+
+
+# PartitionSpec
+
+Partition spec definition
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **Integer** | The spec version ID |  |
+|**fields** | [**List<PartitionField>**](PartitionField.md) | Array of partition field definitions |  |
+
+
+

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

@@ -0,0 +1,16 @@
+
+
+# PartitionTransform
+
+Well-known partition transform
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **String** | Transform type (identity, year, month, day, hour, bucket, multi_bucket, truncate) |  |
+|**numBuckets** | **Integer** | Number of buckets for bucket transforms |  [optional] |
+|**width** | **Integer** | Truncation width for truncate transforms |  [optional] |
+
+
+