Revanth14 commented on code in PR #1213: URL: https://github.com/apache/iceberg-go/pull/1213#discussion_r3471152925
########## table/scan_planning.go: ########## @@ -0,0 +1,138 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +// This file is a PROPOSED public API surface for REST server-side scan +// planning (apache/iceberg-go#1178). It defines the table-side seam — the +// option, request/result types, and the ScanPlanner interface (implemented by +// catalog/rest) — so it can be reviewed as Go rather than prose. +// WithScanPlanningMode records the requested mode on the Scan, but nothing reads +// it until scanner delegation lands, so nothing here changes existing behavior. + +package table + +import ( + "context" + + "github.com/apache/iceberg-go" + icebergio "github.com/apache/iceberg-go/io" +) + +// ScanPlanningMode is the user-facing scan option: three values +// (local/remote/auto) selecting how (*Scan).PlanFiles plans a scan. Local +// planning remains the default; remote is opt-in via WithScanPlanningMode. +// +// This is deliberately distinct from the REST table-config key +// `scan-planning-mode` (values `client`/`server`), which is a server directive +// resolved separately (OQ4): a `client` table forces local planning, a `server` +// table forces remote planning, and explicit conflicting scan options fail +// fast. There is intentionally no fourth `server` value here; the directive +// lives in the table config, not the user option. +type ScanPlanningMode string + +const ( + // ScanPlanningLocal always plans locally by reading manifests through the + // table's FileIO. This is the default and current behavior. + ScanPlanningLocal ScanPlanningMode = "local" + // ScanPlanningRemote requires a planner that advertises remote capability + // and fails loudly if remote planning is unavailable. + ScanPlanningRemote ScanPlanningMode = "remote" + // ScanPlanningAuto uses remote planning when available and allowed by the + // table config, otherwise falls back to local. + ScanPlanningAuto ScanPlanningMode = "auto" +) + +// WithScanPlanningMode sets the scan-planning mode for a scan. The default is +// ScanPlanningLocal unless the REST table config requires server planning. +func WithScanPlanningMode(mode ScanPlanningMode) ScanOption { + return func(scan *Scan) { scan.planningMode = mode } Review Comment: Yes, this is wired now. `PlanFiles` switches on `planningMode`; `remote` delegates to `planFilesRemote`, which fails with `ErrInvalidOperation` when there is no capable planner instead of silently planning locally. `auto` still falls back to local by design, matching its documented semantics. Added tests for the remote unavailable/incapable cases. -- 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]
