Modularize calls to federated catalogs #2301
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| plugins { | ||
| id("polaris-client") | ||
| alias(libs.plugins.jandex) | ||
| } | ||
|
|
||
| dependencies { | ||
| // Polaris dependencies | ||
| implementation(project(":polaris-core")) | ||
|
|
||
| implementation(platform(libs.iceberg.bom)) | ||
| implementation("org.apache.iceberg:iceberg-api") | ||
| implementation("org.apache.iceberg:iceberg-core") | ||
| implementation("org.apache.iceberg:iceberg-common") | ||
|
|
||
| // Hadoop dependencies (for Hadoop catalog support) | ||
| implementation(libs.hadoop.common) { | ||
| exclude("org.slf4j", "slf4j-reload4j") | ||
| exclude("org.slf4j", "slf4j-log4j12") | ||
| exclude("ch.qos.reload4j", "reload4j") | ||
| exclude("log4j", "log4j") | ||
| exclude("org.apache.zookeeper", "zookeeper") | ||
| exclude("org.apache.hadoop.thirdparty", "hadoop-shaded-protobuf_3_25") | ||
| exclude("com.github.pjfanning", "jersey-json") | ||
| exclude("com.sun.jersey", "jersey-core") | ||
| exclude("com.sun.jersey", "jersey-server") | ||
| exclude("com.sun.jersey", "jersey-servlet") | ||
| exclude("io.dropwizard.metrics", "metrics-core") | ||
| } | ||
| implementation(libs.hadoop.client.api) | ||
| implementation(libs.hadoop.client.runtime) | ||
|
|
||
| // CDI dependencies for runtime discovery | ||
| implementation(libs.jakarta.enterprise.cdi.api) | ||
| implementation(libs.smallrye.common.annotation) | ||
|
|
||
| // Logging | ||
| implementation(libs.slf4j.api) | ||
| } |
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,61 @@ | ||
| /* | ||
| * 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.polaris.extensions.federation.hadoop; | ||
|
|
||
| import io.smallrye.common.annotation.Identifier; | ||
| import jakarta.enterprise.context.ApplicationScoped; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.iceberg.catalog.Catalog; | ||
| import org.apache.iceberg.hadoop.HadoopCatalog; | ||
| import org.apache.polaris.core.catalog.ExternalCatalogFactory; | ||
| import org.apache.polaris.core.connection.AuthenticationParametersDpo; | ||
| import org.apache.polaris.core.connection.AuthenticationType; | ||
| import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; | ||
| import org.apache.polaris.core.connection.ConnectionType; | ||
| import org.apache.polaris.core.connection.hadoop.HadoopConnectionConfigInfoDpo; | ||
| import org.apache.polaris.core.secrets.UserSecretsManager; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** Factory class for creating a Hadoop catalog handle based on connection configuration. */ | ||
| @ApplicationScoped | ||
| @Identifier(ConnectionType.HADOOP_FACTORY_IDENTIFIER) | ||
| public class HadoopFederatedCatalogFactory implements ExternalCatalogFactory { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(HadoopFederatedCatalogFactory.class); | ||
|
|
||
| @Override | ||
| public Catalog createCatalog( | ||
| ConnectionConfigInfoDpo connectionConfigInfoDpo, UserSecretsManager userSecretsManager) { | ||
| // Currently, Polaris supports Hadoop federation only via IMPLICIT authentication. | ||
| // Hence, prior to initializing the configuration, ensure that the catalog uses | ||
| // IMPLICIT authentication. | ||
| AuthenticationParametersDpo authenticationParametersDpo = | ||
| connectionConfigInfoDpo.getAuthenticationParameters(); | ||
| if (authenticationParametersDpo.getAuthenticationTypeCode() | ||
| != AuthenticationType.IMPLICIT.getCode()) { | ||
| throw new IllegalStateException("Hadoop federation only supports IMPLICIT authentication."); | ||
| } | ||
| Configuration conf = new Configuration(); | ||
| String warehouse = ((HadoopConnectionConfigInfoDpo) connectionConfigInfoDpo).getWarehouse(); | ||
| HadoopCatalog hadoopCatalog = new HadoopCatalog(conf, warehouse); | ||
| hadoopCatalog.initialize( | ||
| warehouse, connectionConfigInfoDpo.asIcebergCatalogProperties(userSecretsManager)); | ||
| return hadoopCatalog; | ||
| } | ||
| } |
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,43 @@ | ||
| /* | ||
| * 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.polaris.core.catalog; | ||
|
|
||
| import org.apache.iceberg.catalog.Catalog; | ||
| import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; | ||
| import org.apache.polaris.core.secrets.UserSecretsManager; | ||
|
|
||
| /** | ||
| * Factory interface for creating external catalog handles based on connection configuration. | ||
| * | ||
| * <p>Implementations should be annotated with CDI annotations and use the @Identifier annotation to | ||
| * specify which connection type they support. | ||
| */ | ||
| public interface ExternalCatalogFactory { | ||
|
|
||
| /** | ||
| * Creates a catalog handle for the given connection configuration. | ||
| * | ||
| * @param connectionConfig the connection configuration | ||
| * @param userSecretsManager the user secrets manager for handling credentials | ||
| * @return the initialized catalog | ||
| * @throws IllegalStateException if the connection configuration is invalid | ||
| */ | ||
| Catalog createCatalog( | ||
| ConnectionConfigInfoDpo connectionConfig, UserSecretsManager userSecretsManager); | ||
| } |
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
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.
This is a breaking change to Polaris that effectively removes functionality in the Polaris server.
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 the functionality is still there, but the way you need to build Polaris to use that functionality does change (across versions).
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.
In any case, shouldn't this block be declared rather in
runtime/server?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.
Regarding runtime/server module: We reference the ExternalCatalogFactory in the IcebergCatalogHandler which is in runtime/service module. So isn't this the correct location?
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.
But afaict
ExternalCatalogFactoryis an interface inpolaris-core. We don't referenceHadoopFederatedCatalogFactorydirectly in code.In
runtime/serverwe already have other similarruntimeOnlydeclarations: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.
I had that until c73966c
I can do either, from the Polaris OSS sync last week (discussion about regarding hive federation), my takeaway was that we wanted to avoid having the default Polaris JAR depend on anything hadoop.
However, if you'd prefer compiling it each time (and only loading if necessary), I can revert that change. I will send out a separate PR without dynamic compilation and update a README.md for this PR. Please pick the option that's best suited according to you.
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.
+1 to adding something to the README/getting-started or similar to better make it an easy copy/paste command to decide whether to compile with or without the extended dependencies.
My understanding is indeed that this check was directly to address the concern others had about having Hadoop (or Hive in the future) compile-time dependencies be always present for all Polaris builds.
Personally I don't feel too strongly either way, so I'm okay with or without the additional compilation property.
Uh oh!
There was an error while loading. Please reload this page.
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.
Also, per offline discussion, +1 to what @adutra said about putting the Hadoop extension into
runtime/serverif it works correctly for Quarkus finding it in the runtime assembly.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.
Done.