Skip to content

Core: expose labels on the loaded table via SupportsLabels - #17410

Draft
laskoviymishka wants to merge 2 commits into
apache:mainfrom
laskoviymishka:labels-catalog
Draft

Core: expose labels on the loaded table via SupportsLabels#17410
laskoviymishka wants to merge 2 commits into
apache:mainfrom
laskoviymishka:labels-catalog

Conversation

@laskoviymishka

Copy link
Copy Markdown
Contributor

Exposes the catalog-provided labels obtained from the load response on the loaded Table, so engines and tooling can read them.

Stacked on #17337 (the labels read-path serde). Review the top commit — the serde layer belongs to #17337.

What changed

  • New SupportsLabels mixin interface (mirroring SupportsDistributedScanPlanning) with a single labels() accessor.
  • BaseTable implements SupportsLabels via a new constructor carrying an optional Labels; existing constructors default to an empty instance. The field is transient and is not copied into SerializableTable, so labels are ephemeral catalog enrichment and are not preserved across table serialization (driver-side only).
  • RESTSessionCatalog populates labels from the load response for both the plain BaseTable and the server-side scan-planning RESTTable paths, across loadTable, registerTable, and createTable.

Read-only; the write path is out of scope.

Reference client implementation for the IRC labels read-path spec change
(apache#15750). Without it, RESTObjectMapper (which sets
FAIL_ON_UNKNOWN_PROPERTIES = false) silently drops the labels field on
deserialization, so labels returned by a catalog are invisible to the Java
client.

New rest.labels package (mirroring rest.credentials): Labels (object + fields
sub-scopes, with a shared empty instance) and FieldLabels (per-field, keyed by
field-id) value types as immutables interfaces, each with a JSON parser.
FieldLabels validates field-id >= 1 and a non-empty labels map, matching
Credential.

Wire an optional labels field into LoadTableResponse / LoadViewResponse and
their parsers. labels() never returns null (empty instance when absent), on
LoadViewResponse via a @Value.Default default method so no interface API break
is introduced. Labels are omitted from the wire when absent (or empty), so the
change is additive and backward compatible.
Builds on the labels read-path serde: make the catalog-provided labels from
the load response reachable by consumers.

- New SupportsLabels mixin interface (mirroring SupportsDistributedScanPlanning)
  with a single labels() accessor.
- BaseTable implements SupportsLabels via a new constructor that carries an
  optional Labels; existing constructors default to an empty instance. The field
  is transient and not copied into SerializableTable, so labels are ephemeral
  catalog enrichment and are not preserved across table serialization.
- RESTSessionCatalog populates labels from the load response for both the plain
  BaseTable and the server-side scan-planning RESTTable paths, across loadTable,
  registerTable, and createTable.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant