Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Request for creating an empty table. **Deprecated**: Use `DeclareTableRequest`
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the server. | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Response for creating an empty table. **Deprecated**: Use `DeclareTableResponse
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**location** | **String** | | [optional] |
|**storageOptions** | **Map<String, String>** | Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access. | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties. | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +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] |
|**mode** | **String** | There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create: the operation fails with 409. * ExistOk: the operation succeeds and the existing namespace is kept. * Overwrite: the existing namespace is dropped and a new empty namespace with this name is created. | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the namespace, if supported by the implementation. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/CreateTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Request for creating a table, excluding the Arrow IPC stream.
|**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] |
|**mode** | **String** | There are three modes when trying to create a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create: the operation fails with 409. * ExistOk: the operation succeeds and the existing table is kept. * Overwrite: the existing table is dropped and a new table with this name is created. | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the implementation. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/CreateTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
|**location** | **String** | | [optional] |
|**version** | **Long** | | [optional] |
|**storageOptions** | **Map<String, String>** | Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access. | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/DeclareTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Request for declaring a table.
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the server. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/DeclareTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Response for declaring a table.
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**location** | **String** | | [optional] |
|**storageOptions** | **Map<String, String>** | Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access. | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties. | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties. | [optional] |



3 changes: 2 additions & 1 deletion docs/src/client/operations/models/DescribeTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
|**schema** | [**JsonArrowSchema**](JsonArrowSchema.md) | Table schema in JSON Arrow format. Only populated when `load_detailed_metadata` is true. | [optional] |
|**storageOptions** | **Map<String, String>** | Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access. When `vend_credentials` is true, this field may include vended credentials. If the vended credentials are temporary, the `expires_at_millis` key should be included to indicate the millisecond timestamp when the credentials expire. | [optional] |
|**stats** | [**TableBasicStats**](TableBasicStats.md) | Table statistics. Only populated when `load_detailed_metadata` is true. | [optional] |
|**metadata** | **Map<String, String>** | Optional table metadata as key-value pairs. | [optional] |
|**metadata** | **Map<String, String>** | Optional table metadata as key-value pairs. This records the information of the table and requires loading the table. It is only populated when `load_detailed_metadata` is true. | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the server. This records the information managed by the namespace. If the server does not support table properties, it should return null for this field. If table properties are supported, but none are set, it should return an empty object. | [optional] |



2 changes: 1 addition & 1 deletion docs/src/client/operations/models/DropNamespaceResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support namespace properties, it should return null for this field. Otherwise it should return the properties. | [optional] |
|**transactionId** | **List<String>** | If present, indicating the operation is long running and should be tracked using DescribeTransaction | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/src/client/operations/models/DropTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties. | [optional] |



18 changes: 18 additions & 0 deletions docs/src/client/operations/models/PartitionField.md
Original file line number Diff line number Diff line change
@@ -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) | |



15 changes: 15 additions & 0 deletions docs/src/client/operations/models/PartitionSpec.md
Original file line number Diff line number Diff line change
@@ -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 | |



16 changes: 16 additions & 0 deletions docs/src/client/operations/models/PartitionTransform.md
Original file line number Diff line number Diff line change
@@ -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] |



2 changes: 1 addition & 1 deletion docs/src/client/operations/models/RegisterTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
|**id** | **List<String>** | | [optional] |
|**location** | **String** | | |
|**mode** | **String** | There are two modes when trying to register a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create (default): the operation fails with 409. * Overwrite: the existing table registration is replaced with the new registration. | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the implementation. | [optional] |



2 changes: 1 addition & 1 deletion docs/src/client/operations/models/RegisterTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**location** | **String** | | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/UpdateTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Each update consists of a column name and an SQL expression that will be evaluat
|**id** | **List<String>** | | [optional] |
|**predicate** | **String** | Optional SQL predicate to filter rows for update | [optional] |
|**updates** | **List<List<String>>** | List of column updates as [column_name, expression] pairs | |
|**properties** | **Map<String, String>** | Properties stored on the table, if supported by the implementation. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/UpdateTableResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
|**transactionId** | **String** | Optional transaction identifier | [optional] |
|**updatedRows** | **Long** | Number of rows updated | |
|**version** | **Long** | The commit version associated with the operation | |
|**properties** | **Map<String, String>** | If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties. | [optional] |



Loading