Revanth14 commented on code in PR #1213: URL: https://github.com/apache/iceberg-go/pull/1213#discussion_r3421750638
########## table/scan_planning.go: ########## @@ -0,0 +1,97 @@ +// 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). The bodies are intentionally +// unimplemented; the file exists so the seam can be reviewed as Go rather +// than prose. Nothing here changes existing behavior. + +package table + +import ( + "context" + + "github.com/apache/iceberg-go" +) + +// ScanPlanningMode selects how (*Scan).PlanFiles plans a scan. Local planning +// remains the default; remote planning is opt-in via WithScanPlanningMode. +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 { + panic("unimplemented: proposed API for #1178") +} + +// ScanPlanningRequest is the input a Scan hands to a ScanPlanner. It carries +// the resolved scan state a planner needs without depending on catalog/rest. +// +// Open question (epic OQ4): when the table has evolved, UseSnapshotSchema must +// pin which schema binds a returned residual and the partition decode — the +// snapshot's schema (via schema-id), kept separate from each file's partition +// spec-id. Incremental scans (start/end snapshot) are deferred to a later +// phase; point-in-time SnapshotID lands first. +type ScanPlanningRequest struct { + Identifier Identifier + Metadata Metadata + MetadataLocation string + SnapshotID *int64 + SelectedFields []string + RowFilter iceberg.BooleanExpression + CaseSensitive bool Review Comment: Good point. I kept this as `bool` because `ScanPlanningRequest` is intended to be built from a resolved `Scan`, not directly from the wire/default state. `Table.Scan` initializes `caseSensitive` to `true`, and `WithCaseSensitive(false)` is the explicit opt-out path, so this field should always carry the scan’s resolved value. I added a doc line on `ScanPlanningRequest.CaseSensitive` to make that contract explicit and avoid accidentally mapping Go’s zero value to the REST default. -- 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]
