Skip to content

Open-API: Refactor TableRequirements #7710

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

Merged
Fokko merged 9 commits into from
Oct 30, 2023
+185 −56
Merged

Open-API: Refactor TableRequirements #7710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
342b3b3
Open-API: Refactor TableRequirements
Fokko May 26, 2023
f4cbf76
Apply suggestions from code review
Fokko Jun 4, 2023
93724ec
WIP
Fokko Jun 4, 2023
b30a0c9
Merge branch 'fd-fix-open-api-requirements' of github.com:Fokko/incub…
Fokko Jun 4, 2023
adda862
Fixed the inheritance
Fokko Jun 4, 2023
e8ed164
Merge branch 'master' of github.com:apache/iceberg into fd-fix-open-a…
Fokko Jun 6, 2023
4d54a30
Merge branch 'master' of github.com:apache/iceberg into fd-fix-open-a…
Fokko Aug 1, 2023
5553dcd
Generate the code
Fokko Aug 1, 2023
9f6323a
Fix order
Fokko Oct 30, 2023
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
99 changes: 70 additions & 29 deletions open-api/rest-catalog-open-api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,38 +293,79 @@ class RemovePropertiesUpdate(BaseUpdate):


class TableRequirement(BaseModel):
type: str


class AssertCreate(TableRequirement):
"""
Assertions from the client that must be valid for the commit to succeed. Assertions are identified by `type` -
- `assert-create` - the table must not already exist; used for create transactions
- `assert-table-uuid` - the table UUID must match the requirement's `uuid`
- `assert-ref-snapshot-id` - the table branch or tag identified by the requirement's `ref` must reference the requirement's `snapshot-id`; if `snapshot-id` is `null` or missing, the ref must not already exist
- `assert-last-assigned-field-id` - the table's last assigned column id must match the requirement's `last-assigned-field-id`
- `assert-current-schema-id` - the table's current schema id must match the requirement's `current-schema-id`
- `assert-last-assigned-partition-id` - the table's last assigned partition id must match the requirement's `last-assigned-partition-id`
- `assert-default-spec-id` - the table's default spec id must match the requirement's `default-spec-id`
- `assert-default-sort-order-id` - the table's default sort order id must match the requirement's `default-sort-order-id`
The table must not already exist; used for create transactions
"""

type: Literal[
'assert-create',
'assert-table-uuid',
'assert-ref-snapshot-id',
'assert-last-assigned-field-id',
'assert-current-schema-id',
'assert-last-assigned-partition-id',
'assert-default-spec-id',
'assert-default-sort-order-id',
]
ref: Optional[str] = None
uuid: Optional[str] = None
snapshot_id: Optional[int] = Field(None, alias='snapshot-id')
last_assigned_field_id: Optional[int] = Field(None, alias='last-assigned-field-id')
current_schema_id: Optional[int] = Field(None, alias='current-schema-id')
last_assigned_partition_id: Optional[int] = Field(
None, alias='last-assigned-partition-id'
)
default_spec_id: Optional[int] = Field(None, alias='default-spec-id')
default_sort_order_id: Optional[int] = Field(None, alias='default-sort-order-id')
type: Literal['assert-create']


class AssertTableUUID(TableRequirement):
"""
The table UUID must match the requirement's `uuid`
"""

type: Literal['assert-table-uuid']
uuid: str


class AssertRefSnapshotId(TableRequirement):
"""
The table branch or tag identified by the requirement's `ref` must reference the requirement's `snapshot-id`; if `snapshot-id` is `null` or missing, the ref must not already exist
"""

type: Literal['assert-ref-snapshot-id']
ref: str
snapshot_id: int = Field(..., alias='snapshot-id')


class AssertLastAssignedFieldId(TableRequirement):
"""
The table's last assigned column id must match the requirement's `last-assigned-field-id`
"""

type: Literal['assert-last-assigned-field-id']
last_assigned_field_id: int = Field(..., alias='last-assigned-field-id')


class AssertCurrentSchemaId(TableRequirement):
"""
The table's current schema id must match the requirement's `current-schema-id`
"""

type: Literal['assert-current-schema-id']
current_schema_id: int = Field(..., alias='current-schema-id')


class AssertLastAssignedPartitionId(TableRequirement):
"""
The table's last assigned partition id must match the requirement's `last-assigned-partition-id`
"""

type: Literal['assert-last-assigned-partition-id']
last_assigned_partition_id: int = Field(..., alias='last-assigned-partition-id')


class AssertDefaultSpecId(TableRequirement):
"""
The table's default spec id must match the requirement's `default-spec-id`
"""

type: Literal['assert-default-spec-id']
default_spec_id: int = Field(..., alias='default-spec-id')


class AssertDefaultSortOrderId(TableRequirement):
"""
The table's default sort order id must match the requirement's `default-sort-order-id`
"""

type: Literal['assert-default-sort-order-id']
default_sort_order_id: int = Field(..., alias='default-sort-order-id')


class RegisterTableRequest(BaseModel):
Expand Down
142 changes: 115 additions & 27 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1825,54 +1825,142 @@ components:
- $ref: '#/components/schemas/RemovePropertiesUpdate'

TableRequirement:
Copy link
Copy Markdown
Contributor

@rdblue rdblue Oct 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Should TableRequirement be defined first?

Copy link
Copy Markdown
Contributor Author

@Fokko Fokko Oct 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I don't recall this isn't the case.

description:
Assertions from the client that must be valid for the commit to succeed. Assertions are identified by `type` -

- `assert-create` - the table must not already exist; used for create transactions

- `assert-table-uuid` - the table UUID must match the requirement's `uuid`

- `assert-ref-snapshot-id` - the table branch or tag identified by the requirement's `ref` must reference the requirement's `snapshot-id`; if `snapshot-id` is `null` or missing, the ref must not already exist

- `assert-last-assigned-field-id` - the table's last assigned column id must match the requirement's `last-assigned-field-id`

- `assert-current-schema-id` - the table's current schema id must match the requirement's `current-schema-id`

- `assert-last-assigned-partition-id` - the table's last assigned partition id must match the requirement's `last-assigned-partition-id`

- `assert-default-spec-id` - the table's default spec id must match the requirement's `default-spec-id`
discriminator:
propertyName: type
mapping:
assert-create: '#/components/schemas/AssertCreate'
assert-table-uuid: '#/components/schemas/AssertTableUUID'
assert-ref-snapshot-id: '#/components/schemas/AssertRefSnapshotId'
assert-last-assigned-field-id: '#/components/schemas/AssertLastAssignedFieldId'
assert-current-schema-id: '#/components/schemas/AssertCurrentSchemaId'
assert-last-assigned-partition-id: '#/components/schemas/AssertLastAssignedPartitionId'
assert-default-spec-id: '#/components/schemas/AssertDefaultSpecId'
assert-default-sort-order-id: '#/components/schemas/AssertDefaultSortOrderId'
type: object
required:
- type
properties:
type:
type: "string"

- `assert-default-sort-order-id` - the table's default sort order id must match the requirement's `default-sort-order-id`
AssertCreate:
allOf:
- $ref: "#/components/schemas/TableRequirement"
type: object
description: The table must not already exist; used for create transactions
required:
- type
properties:
type:
type: string
enum:
- assert-create
- assert-table-uuid
- assert-ref-snapshot-id
- assert-last-assigned-field-id
- assert-current-schema-id
- assert-last-assigned-partition-id
- assert-default-spec-id
- assert-default-sort-order-id
ref:
enum: ["assert-create"]

AssertTableUUID:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description: The table UUID must match the requirement's `uuid`
required:
- type
- uuid
properties:
type:
type: string
enum: ["assert-table-uuid"]
uuid:
type: string

AssertRefSnapshotId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table branch or tag identified by the requirement's `ref` must reference the requirement's `snapshot-id`;
if `snapshot-id` is `null` or missing, the ref must not already exist
required:
- type
- ref
- snapshot-id
properties:
type:
type: string
enum: [ "assert-ref-snapshot-id" ]
ref:
type: string
snapshot-id:
type: integer
format: int64

AssertLastAssignedFieldId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table's last assigned column id must match the requirement's `last-assigned-field-id`
required:
- type
- last-assigned-field-id
properties:
type:
type: string
enum: [ "assert-last-assigned-field-id" ]
last-assigned-field-id:
type: integer

AssertCurrentSchemaId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table's current schema id must match the requirement's `current-schema-id`
required:
- type
- current-schema-id
properties:
type:
type: string
enum: [ "assert-current-schema-id" ]
current-schema-id:
type: integer

AssertLastAssignedPartitionId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table's last assigned partition id must match the requirement's `last-assigned-partition-id`
required:
- type
- last-assigned-partition-id
properties:
type:
type: string
enum: [ "assert-last-assigned-partition-id" ]
last-assigned-partition-id:
type: integer

AssertDefaultSpecId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table's default spec id must match the requirement's `default-spec-id`
required:
- type
- default-spec-id
properties:
type:
type: string
enum: [ "assert-default-spec-id" ]
default-spec-id:
type: integer

AssertDefaultSortOrderId:
allOf:
- $ref: "#/components/schemas/TableRequirement"
description:
The table's default sort order id must match the requirement's `default-sort-order-id`
required:
- type
- default-sort-order-id
properties:
type:
type: string
enum: [ "assert-default-sort-order-id" ]
default-sort-order-id:
type: integer

Expand Down