laurentgo commented on code in PR #13879:
URL: https://github.com/apache/iceberg/pull/13879#discussion_r2624053074
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -3265,6 +3265,133 @@ components:
additionalProperties:
type: string
+ ReadRestrictions:
+ type: object
+ description: >
+ Read restrictions for a table, including column projections and row
filter expressions, according to the current schema.
+
+ A client MUST enforce the restrictions defined in this object when
reading data
+ from the table.
+
+ These restrictions apply only to the authenticated principal, user,
or account
+ associated with the client. They MUST NOT be interpreted as global
policy and
+ MUST NOT be applied beyond the entity identified by the
Authentication header
+ (or other applicable authentication mechanism).
+ properties:
+ required-column-projections:
+ description: >
+ A list of projections that MUST be applied prior to any
query-specified
+ projections.
+ If the required-colum-projections property is absent, no mandatory
projection applies,
+ and a reader MAY project any subset of columns of the table,
including all columns.
+
+ 1. A reader MUST project only columns listed in the
required-colum-projections.
+ - If a listed column has a transform, the reader MUST apply it
and replace
+ all references to the underlying column with the transformed
value
+ (for example, truncate[4](cc) MUST be projected as
truncate[4](cc) AS cc,
+ and all references to cc during query evaluation post applying
required-row-filter MUST resolve to this alias).
+ - Columns not listed in the required-colum-projections MUST NOT
be read.
+
+ 2. A column MUST appear at most once in the
required-colum-projections.
+
+ 3. If a projection entry includes an action that the reader cannot
evaluate,
+ the reader MUST fail rather than ignore the transform.
+
+ 5. An identity transform is equivalent to projecting the column
directly.
+
+ 8. The data type of the projected column MUST match the data type
defined for the transform result.
+
+ type: array
+ items:
+ $ref: '#/components/schemas/Projection'
+ required-row-filter:
+ description: >
+ An expression that filters rows in the table.
+
+ 1. A reader MUST discard any row for which the filter evaluates to
false or null, and
+ no information derived from discarded rows MAY be included in
the query result.
+
+ 2. Row filters MUST be evaluated against the original,
untransformed column values.
+ Required projections MUST be applied only after row filters are
applied.
+
+ 3. If the catalog supports multiple row access filters for the
table, it is
+ the catalog's responsibility to combine them using the
appropriate logic (e.g., AND, OR).
+
+ 4. If a client cannot interpret or evaluate a provided filter
expression, it MUST fail.
+
+ 5. If the required-row-filter property is absent or empty, no
mandatory filtering is imposed.
+ $ref: '#/components/schemas/Expression'
+
+ Projection:
+ type: object
+ description: Defines a projection for a column.
+ properties:
+ field-id:
+ type: integer
+ description: field id of the column being projected.
+ action:
+ $ref: '#/components/schemas/Action'
+ required:
+ - field-id
+ - action
+
+ Action:
+ description: Defines the specific action to be executed for computing
the projection.
+ oneOf:
Review Comment:
Unless I'm missing something, I'm not sure how one can distinguish between
the various action types if the schema for the direct actions do not have any
property. Unlike protobuf or thrift, OpenAPI/JSon doesn't automatically encode
the type.
I'm not sure also why we care about things being verbose (it's JSON after
all and also isn't it true for iceberg expression): I don't expect people to
write responses by hand. Actually I would prefer if anything could be unified
as an iceberg expression instead of adding direct actions to the specification
(with the risk of people wanting to add their own action each time directly in
the specification instead of making iceberg expression language richer), like
it was discussed in one of the community sync on the subject.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
