rdblue commented on code in PR #9695:
URL: https://github.com/apache/iceberg/pull/9695#discussion_r1494943508


##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -532,6 +532,100 @@ paths:
         5XX:
           $ref: '#/components/responses/ServerErrorResponse'
 
+  /v1/{prefix}/namespaces/{namespace}/tables/{table}/preplan:
+    parameters:
+      - $ref: '#/components/parameters/prefix'
+      - $ref: '#/components/parameters/namespace'
+      - $ref: '#/components/parameters/table'
+    post:
+      tags:
+        - Catalog API
+      summary: Find plan-tasks based on a plan context.
+      description:
+        When a user submits a query, this operation will find the relevant 
plan-tasks
+        based on the user's selected columns, and filters. The plan-tasks can 
be later used during PlanTable
+        to distribute this work for performance gain.

Review Comment:
   What does it mean for a user to submit a query? I think that this needs to 
be more direct and clear about what this endpoint specifically does.
   
   > Scan pre-planning creates a set of opaque planning tasks for a set of scan 
configuration options. Each task can be passed to the plan endpoint to fetch a 
(disjoint) subset of the file scan tasks for the scan.
   >
   > Scan pre-planning enables breaking scan planning across multiple tasks. 
This can be used to parallelize scan planning requests, use fewer resources in 
each planning request, or to delay parts of scan planning that may not be 
needed.



-- 
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: issues-unsubscr...@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org

Reply via email to