REST: Add Support for Custom Operations Builders in RESTCatalog #14465
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.iceberg.rest; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.function.Supplier; | ||
| import org.apache.iceberg.MetadataUpdate; | ||
| import org.apache.iceberg.TableMetadata; | ||
| import org.apache.iceberg.io.FileIO; | ||
| import org.apache.iceberg.view.ViewMetadata; | ||
|
|
||
| /** | ||
| * A factory interface for creating {@link RESTTableOperations} and {@link RESTViewOperations} | ||
| * instances for REST catalogs. | ||
| * | ||
| * <p>This interface allows custom implementations of table and view operations to be injected into | ||
| * {@link RESTSessionCatalog} and {@link RESTCatalog}, enabling extensibility for specialized use | ||
| * cases. | ||
| * | ||
| * <p>Example usage: | ||
| * | ||
| * <pre> | ||
| * RESTOperationsFactory customFactory = new RESTOperationsFactory() { | ||
| * {@literal @}Override | ||
| * public RESTTableOperations createTableOperations( | ||
| * RESTClient client, | ||
| * String path, | ||
| * Supplier<Map<String, String>> headers, | ||
| * FileIO io, | ||
| * TableMetadata current, | ||
| * Set<Endpoint> endpoints) { | ||
| * return new CustomRESTTableOperations(client, path, headers, io, current, endpoints); | ||
| * } | ||
| * | ||
| * {@literal @}Override | ||
| * public RESTViewOperations createViewOperations( | ||
| * RESTClient client, | ||
| * String path, | ||
| * Supplier<Map<String, String>> headers, | ||
| * ViewMetadata current, | ||
| * Set<Endpoint> endpoints) { | ||
| * return new CustomRESTViewOperations(client, path, headers, current, endpoints); | ||
| * } | ||
| * }; | ||
| * | ||
| * RESTSessionCatalog catalog = new RESTSessionCatalog(clientBuilder, ioBuilder, customFactory); | ||
| * </pre> | ||
| */ | ||
| public interface RESTOperationsFactory { | ||
|
|
||
| /** | ||
| * Create a new {@link RESTTableOperations} instance for simple table operations. | ||
| * | ||
| * <p>The default implementation creates a standard {@link RESTTableOperations} instance. | ||
| * | ||
| * @param client the REST client to use for communicating with the catalog server | ||
| * @param path the REST path for the table | ||
| * @param headers a supplier for additional HTTP headers to include in requests | ||
| * @param io the FileIO implementation for reading and writing table metadata and data files | ||
| * @param current the current table metadata | ||
| * @param endpoints the set of supported REST endpoints | ||
| * @return a new RESTTableOperations instance | ||
| */ | ||
| default RESTTableOperations createTableOperations( | ||
| RESTClient client, | ||
| String path, | ||
| Supplier<Map<String, String>> headers, | ||
| FileIO io, | ||
| TableMetadata current, | ||
| Set<Endpoint> endpoints) { | ||
| return new RESTTableOperations(client, path, headers, io, current, endpoints); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new {@link RESTTableOperations} instance for transaction-based operations (create or | ||
| * replace). | ||
| * | ||
| * <p>This method is used when creating tables or replacing table metadata within a transaction. | ||
| * The default implementation creates a standard {@link RESTTableOperations} instance. | ||
| * | ||
| * @param client the REST client to use for communicating with the catalog server | ||
| * @param path the REST path for the table | ||
| * @param headers a supplier for additional HTTP headers to include in requests | ||
| * @param io the FileIO implementation for reading and writing table metadata and data files | ||
| * @param updateType the type of update being performed (CREATE, REPLACE, or SIMPLE) | ||
| * @param createChanges the list of metadata updates to apply during table creation or replacement | ||
| * @param current the current table metadata (may be null for CREATE operations) | ||
| * @param endpoints the set of supported REST endpoints | ||
| * @return a new RESTTableOperations instance | ||
| */ | ||
| default RESTTableOperations createTableOperationsForTransaction( | ||
| RESTClient client, | ||
| String path, | ||
| Supplier<Map<String, String>> headers, | ||
| FileIO io, | ||
| RESTTableOperations.UpdateType updateType, | ||
| List<MetadataUpdate> createChanges, | ||
| TableMetadata current, | ||
| Set<Endpoint> endpoints) { | ||
| return new RESTTableOperations( | ||
| client, path, headers, io, updateType, createChanges, current, endpoints); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new {@link RESTViewOperations} instance. | ||
| * | ||
| * <p>The default implementation creates a standard {@link RESTViewOperations} instance. | ||
| * | ||
| * @param client the REST client to use for communicating with the catalog server | ||
| * @param path the REST path for the view | ||
| * @param headers a supplier for additional HTTP headers to include in requests | ||
| * @param current the current view metadata | ||
| * @param endpoints the set of supported REST endpoints | ||
| * @return a new RESTViewOperations instance | ||
| */ | ||
| default RESTViewOperations createViewOperations( | ||
| RESTClient client, | ||
| String path, | ||
| Supplier<Map<String, String>> headers, | ||
| ViewMetadata current, | ||
| Set<Endpoint> endpoints) { | ||
| return new RESTViewOperations(client, path, headers, current, endpoints); | ||
| } | ||
|
|
||
| /** Default {@link RESTOperationsFactory} instance. */ | ||
| RESTOperationsFactory DEFAULT = new RESTOperationsFactory() {}; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How is fileIO handled for view opertions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIUC,
FileIOis not required for view operations, because Iceberg views are logical objects that contain only metadata (SQL definitions, schemas, and versions) and do not read or write any physical files.When a user runs a query against a view, the query engine expands the view's SQL definition, compiles it into a query plan, and resolves the underlying tables. At that point, the engine loads the actual table objects (which include
TableOperationsandFileIO) to read the physical data files.