Skip to content

feat: add table properties #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wojiaodoubao wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add table properties #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 86 additions & 0 deletions docs/src/rest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1958,6 +1958,8 @@ components:
* Overwrite: the existing namespace is dropped and a new empty namespace with this name is created.
properties:
type: object
description: |
Properties stored on the namespace, if supported by the implementation.
additionalProperties:
type: string

Expand Down Expand Up @@ -2067,6 +2069,8 @@ components:
properties:
properties:
type: object
description: |
If the implementation does not support namespace properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
transaction_id:
Expand Down Expand Up @@ -2140,6 +2144,8 @@ components:
* Overwrite: the existing table registration is replaced with the new registration.
properties:
type: object
description: |
Properties stored on the table, if supported by the implementation.
additionalProperties:
type: string

Expand All @@ -2153,6 +2159,8 @@ components:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.
additionalProperties:
type: string

Expand Down Expand Up @@ -2287,6 +2295,17 @@ components:
Optional table metadata as key-value pairs.
additionalProperties:
type: string
properties:
type: object
description:
Properties stored on the table, if supported by the server.
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.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

TableBasicStats:
type: object
Expand Down Expand Up @@ -2463,6 +2482,12 @@ components:
items:
type: string
description: List of column updates as [column_name, expression] pairs
properties:
type: object
description: |
Properties stored on the table, if supported by the implementation.
additionalProperties:
type: string

UpdateTableResponse:
type: object
Expand All @@ -2483,6 +2508,12 @@ components:
format: int64
description: The commit version associated with the operation
minimum: 0
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.
additionalProperties:
type: string

DeleteFromTableRequest:
type: object
Expand Down Expand Up @@ -2903,6 +2934,12 @@ components:
* 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.
properties:
type: object
description: |
Properties stored on the table, if supported by the implementation.
additionalProperties:
type: string

CreateTableResponse:
type: object
Expand All @@ -2924,6 +2961,15 @@ components:
passed directly to Lance to initialize storage access.
additionalProperties:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

CreateEmptyTableRequest:
type: object
Expand Down Expand Up @@ -2952,6 +2998,12 @@ components:
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean
properties:
type: object
description: |
Properties stored on the table, if supported by the server.
additionalProperties:
type: string

CreateEmptyTableResponse:
type: object
Expand All @@ -2974,6 +3026,15 @@ components:
passed directly to Lance to initialize storage access.
additionalProperties:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

DeclareTableRequest:
type: object
Expand All @@ -2999,6 +3060,12 @@ components:
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean
properties:
type: object
description: |
Properties stored on the table, if supported by the server.
additionalProperties:
type: string

DeclareTableResponse:
type: object
Expand All @@ -3018,6 +3085,15 @@ components:
passed directly to Lance to initialize storage access.
additionalProperties:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

TableExistsRequest:
type: object
Expand Down Expand Up @@ -3193,8 +3269,13 @@ components:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

DeregisterTableRequest:
type: object
Expand Down Expand Up @@ -3224,8 +3305,13 @@ components:
type: string
properties:
type: object
description: |
If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.
additionalProperties:
type: string
example: { "owner": "Ralph", 'created_at': '1452120468' }
default: { }
nullable: true

StringFtsQuery:
type: object
Expand Down
Loading