-
Notifications
You must be signed in to change notification settings - Fork 70
feat: basic table scan planning #112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
e971cc4
5fc6971
6a2cb74
d71c26a
c6c1a1f
cd07a0c
b7becc2
abfdfcd
28043b1
fa25891
428651f
812a545
0f79c7c
85802e9
c7621b3
e1267fc
5248e22
368e268
29e8865
ae560f3
0ff952b
1b5d123
3dc2b38
702d0f4
4342887
0d9b89e
e4af0e7
8705a82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ | |
| #include "iceberg/schema.h" | ||
| #include "iceberg/sort_order.h" | ||
| #include "iceberg/table_metadata.h" | ||
| #include "iceberg/table_scan.h" | ||
|
|
||
| namespace iceberg { | ||
|
|
||
|
|
@@ -107,4 +108,8 @@ const std::vector<SnapshotLogEntry>& Table::history() const { | |
|
|
||
| const std::shared_ptr<FileIO>& Table::io() const { return io_; } | ||
|
|
||
| std::unique_ptr<TableScanBuilder> Table::NewScan() const { | ||
| return std::make_unique<TableScanBuilder>(metadata_, io_); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about passing in the
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If I pass "Table" to the "TableScanBuilder," I cannot pass it further to "DataTableScan," as "Table" can only be passed by reference to the "TableScanBuilder."
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Fokko There are some (outdated) comments on this: #112 (comment) |
||
| } | ||
|
|
||
| } // namespace iceberg | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,192 @@ | ||||||||||
| /* | ||||||||||
| * 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. | ||||||||||
| */ | ||||||||||
|
|
||||||||||
| #include "iceberg/table_scan.h" | ||||||||||
|
|
||||||||||
| #include <algorithm> | ||||||||||
| #include <ranges> | ||||||||||
|
|
||||||||||
| #include "iceberg/manifest_entry.h" | ||||||||||
| #include "iceberg/manifest_list.h" | ||||||||||
| #include "iceberg/manifest_reader.h" | ||||||||||
| #include "iceberg/schema.h" | ||||||||||
| #include "iceberg/schema_field.h" | ||||||||||
| #include "iceberg/snapshot.h" | ||||||||||
| #include "iceberg/table_metadata.h" | ||||||||||
| #include "iceberg/util/macros.h" | ||||||||||
|
|
||||||||||
| namespace iceberg { | ||||||||||
|
|
||||||||||
| // implement FileScanTask | ||||||||||
| FileScanTask::FileScanTask(std::shared_ptr<DataFile> file) | ||||||||||
| : data_file_(std::move(file)) {} | ||||||||||
|
Comment on lines
+37
to
+38
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
nit: I think eventually we need to rename it to |
||||||||||
|
|
||||||||||
| const std::shared_ptr<DataFile>& FileScanTask::data_file() const { return data_file_; } | ||||||||||
|
|
||||||||||
| int64_t FileScanTask::size_bytes() const { return data_file_->file_size_in_bytes; } | ||||||||||
|
|
||||||||||
| int32_t FileScanTask::files_count() const { return 1; } | ||||||||||
|
|
||||||||||
| int64_t FileScanTask::estimated_row_count() const { return data_file_->record_count; } | ||||||||||
|
|
||||||||||
| TableScanBuilder::TableScanBuilder(std::shared_ptr<TableMetadata> table_metadata, | ||||||||||
| std::shared_ptr<FileIO> file_io) | ||||||||||
| : file_io_(std::move(file_io)) { | ||||||||||
| context_.table_metadata = std::move(table_metadata); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithColumnNames( | ||||||||||
| std::vector<std::string> column_names) { | ||||||||||
| column_names_ = std::move(column_names); | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: make sure |
||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithProjectedSchema(std::shared_ptr<Schema> schema) { | ||||||||||
| context_.projected_schema = std::move(schema); | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: make sure
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In a conflict situation, it's not very convenient to throw an exception here, I want to put the check in the build. |
||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithSnapshotId(int64_t snapshot_id) { | ||||||||||
| snapshot_id_ = snapshot_id; | ||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithFilter(std::shared_ptr<Expression> filter) { | ||||||||||
| context_.filter = std::move(filter); | ||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithCaseSensitive(bool case_sensitive) { | ||||||||||
| context_.case_sensitive = case_sensitive; | ||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithOption(std::string property, std::string value) { | ||||||||||
| context_.options[std::move(property)] = std::move(value); | ||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScanBuilder& TableScanBuilder::WithLimit(std::optional<int64_t> limit) { | ||||||||||
| context_.limit = limit; | ||||||||||
| return *this; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| Result<std::unique_ptr<TableScan>> TableScanBuilder::Build() { | ||||||||||
| const auto& table_metadata = context_.table_metadata; | ||||||||||
| auto snapshot_id = snapshot_id_ ? snapshot_id_ : table_metadata->current_snapshot_id; | ||||||||||
| if (!snapshot_id) { | ||||||||||
| return InvalidArgument("No snapshot ID specified for table {}", | ||||||||||
| table_metadata->table_uuid); | ||||||||||
| } | ||||||||||
| auto iter = std::ranges::find_if( | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: add |
||||||||||
| table_metadata->snapshots, | ||||||||||
| [id = *snapshot_id](const auto& snapshot) { return snapshot->snapshot_id == id; }); | ||||||||||
| if (iter == table_metadata->snapshots.end()) { | ||||||||||
| return NotFound("Snapshot with ID {} is not found", *snapshot_id); | ||||||||||
| } | ||||||||||
| context_.snapshot = *iter; | ||||||||||
|
|
||||||||||
| if (!context_.projected_schema) { | ||||||||||
| const auto& snapshot = context_.snapshot; | ||||||||||
| auto schema_id = | ||||||||||
| snapshot->schema_id ? snapshot->schema_id : table_metadata->current_schema_id; | ||||||||||
| if (!schema_id) { | ||||||||||
| return InvalidArgument("No schema ID found in snapshot {} for table {}", | ||||||||||
| snapshot->snapshot_id, table_metadata->table_uuid); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| const auto& schemas = table_metadata->schemas; | ||||||||||
| const auto it = std::ranges::find_if(schemas, [id = *schema_id](const auto& schema) { | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ditto, we can add |
||||||||||
| return schema->schema_id() == id; | ||||||||||
| }); | ||||||||||
| if (it == schemas.end()) { | ||||||||||
| return InvalidArgument("Schema {} in snapshot {} is not found", | ||||||||||
| *snapshot->schema_id, snapshot->snapshot_id); | ||||||||||
| } | ||||||||||
| const auto& schema = *it; | ||||||||||
|
|
||||||||||
| if (column_names_.empty()) { | ||||||||||
| context_.projected_schema = schema; | ||||||||||
| } else { | ||||||||||
| // TODO(gty404): collect touched columns from filter expression | ||||||||||
| std::vector<SchemaField> projected_fields; | ||||||||||
| projected_fields.reserve(column_names_.size()); | ||||||||||
| for (const auto& column_name : column_names_) { | ||||||||||
| // TODO(gty404): support case-insensitive column names | ||||||||||
| auto field_opt = schema->GetFieldByName(column_name); | ||||||||||
| if (!field_opt) { | ||||||||||
| return InvalidArgument("Column {} not found in schema '{}'", column_name, | ||||||||||
| *schema_id); | ||||||||||
| } | ||||||||||
| projected_fields.emplace_back(field_opt.value().get()); | ||||||||||
| } | ||||||||||
| context_.projected_schema = | ||||||||||
| std::make_shared<Schema>(std::move(projected_fields), schema->schema_id()); | ||||||||||
| } | ||||||||||
| } | ||||||||||
|
|
||||||||||
| return std::make_unique<DataTableScan>(std::move(context_), file_io_); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| TableScan::TableScan(TableScanContext context, std::shared_ptr<FileIO> file_io) | ||||||||||
| : context_(std::move(context)), file_io_(std::move(file_io)) {} | ||||||||||
|
|
||||||||||
| const std::shared_ptr<Snapshot>& TableScan::snapshot() const { return context_.snapshot; } | ||||||||||
|
|
||||||||||
| const std::shared_ptr<Schema>& TableScan::projection() const { | ||||||||||
| return context_.projected_schema; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| const TableScanContext& TableScan::context() const { return context_; } | ||||||||||
|
|
||||||||||
| const std::shared_ptr<FileIO>& TableScan::io() const { return file_io_; } | ||||||||||
|
|
||||||||||
| DataTableScan::DataTableScan(TableScanContext context, std::shared_ptr<FileIO> file_io) | ||||||||||
| : TableScan(std::move(context), std::move(file_io)) {} | ||||||||||
|
|
||||||||||
| Result<std::vector<std::shared_ptr<FileScanTask>>> DataTableScan::PlanFiles() const { | ||||||||||
| ICEBERG_ASSIGN_OR_RAISE(auto manifest_list_reader, | ||||||||||
| CreateManifestListReader(context_.snapshot->manifest_list)); | ||||||||||
| ICEBERG_ASSIGN_OR_RAISE(auto manifest_files, manifest_list_reader->Files()); | ||||||||||
|
|
||||||||||
| std::vector<std::shared_ptr<FileScanTask>> tasks; | ||||||||||
| for (const auto& manifest_file : manifest_files) { | ||||||||||
| ICEBERG_ASSIGN_OR_RAISE(auto manifest_reader, | ||||||||||
| CreateManifestReader(manifest_file->manifest_path)); | ||||||||||
| ICEBERG_ASSIGN_OR_RAISE(auto manifests, manifest_reader->Entries()); | ||||||||||
|
|
||||||||||
| // TODO(gty404): filter manifests using partition spec and filter expression | ||||||||||
|
|
||||||||||
| for (auto& manifest_entry : manifests) { | ||||||||||
| const auto& data_file = manifest_entry->data_file; | ||||||||||
| switch (data_file->content) { | ||||||||||
| case DataFile::Content::kData: | ||||||||||
| tasks.emplace_back(std::make_shared<FileScanTask>(manifest_entry->data_file)); | ||||||||||
| break; | ||||||||||
| case DataFile::Content::kPositionDeletes: | ||||||||||
| case DataFile::Content::kEqualityDeletes: | ||||||||||
| return NotSupported("Equality/Position deletes are not supported in data scan"); | ||||||||||
| } | ||||||||||
| } | ||||||||||
| } | ||||||||||
|
|
||||||||||
| return tasks; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| } // namespace iceberg | ||||||||||
Uh oh!
There was an error while loading. Please reload this page.