forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-12677][hive][sql-client] Add descriptor, validator, and factor…
…y for HiveCatalog This PR adds descriptor, validator, and factory for HiveCatalog, and tests in flink-sql-client. This closes apache#8589.
- Loading branch information
Showing
16 changed files
with
794 additions
and
62 deletions.
There are no files selected for viewing
This file contains 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 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
61 changes: 61 additions & 0 deletions
61
.../src/main/java/org/apache/flink/table/catalog/hive/descriptors/HiveCatalogDescriptor.java
This file contains 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:https://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.flink.table.catalog.hive.descriptors; | ||
|
|
||
| import org.apache.flink.table.catalog.hive.HiveCatalog; | ||
| import org.apache.flink.table.descriptors.CatalogDescriptor; | ||
| import org.apache.flink.table.descriptors.DescriptorProperties; | ||
| import org.apache.flink.util.Preconditions; | ||
| import org.apache.flink.util.StringUtils; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import static org.apache.flink.table.catalog.hive.descriptors.HiveCatalogValidator.CATALOG_HIVE_SITE_PATH; | ||
| import static org.apache.flink.table.catalog.hive.descriptors.HiveCatalogValidator.CATALOG_TYPE_VALUE_HIVE; | ||
|
|
||
| /** | ||
| * Catalog descriptor for {@link HiveCatalog}. | ||
| */ | ||
| public class HiveCatalogDescriptor extends CatalogDescriptor { | ||
|
|
||
| private String hiveSitePath; | ||
|
|
||
| // TODO : set default database | ||
| public HiveCatalogDescriptor() { | ||
| super(CATALOG_TYPE_VALUE_HIVE, 1); | ||
| } | ||
|
|
||
| public HiveCatalogDescriptor hiveSitePath(String hiveSitePath) { | ||
| Preconditions.checkArgument(!StringUtils.isNullOrWhitespaceOnly(hiveSitePath)); | ||
| this.hiveSitePath = hiveSitePath; | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| protected Map<String, String> toCatalogProperties() { | ||
| final DescriptorProperties properties = new DescriptorProperties(); | ||
|
|
||
| if (hiveSitePath != null) { | ||
| properties.putString(CATALOG_HIVE_SITE_PATH, hiveSitePath); | ||
| } | ||
|
|
||
| return properties.asMap(); | ||
| } | ||
| } |
37 changes: 37 additions & 0 deletions
37
...e/src/main/java/org/apache/flink/table/catalog/hive/descriptors/HiveCatalogValidator.java
This file contains 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,37 @@ | ||
| /* | ||
| * 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:https://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.flink.table.catalog.hive.descriptors; | ||
|
|
||
| import org.apache.flink.table.descriptors.CatalogDescriptorValidator; | ||
| import org.apache.flink.table.descriptors.DescriptorProperties; | ||
|
|
||
| /** | ||
| * Validator for {@link HiveCatalogDescriptor}. | ||
| */ | ||
| public class HiveCatalogValidator extends CatalogDescriptorValidator { | ||
| public static final String CATALOG_TYPE_VALUE_HIVE = "hive"; | ||
| public static final String CATALOG_HIVE_SITE_PATH = "hive-site-path"; | ||
|
|
||
| @Override | ||
| public void validate(DescriptorProperties properties) { | ||
| super.validate(properties); | ||
| properties.validateValue(CATALOG_TYPE, CATALOG_TYPE_VALUE_HIVE, false); | ||
| properties.validateString(CATALOG_HIVE_SITE_PATH, true, 1); | ||
| } | ||
| } |
113 changes: 113 additions & 0 deletions
113
...-hive/src/main/java/org/apache/flink/table/catalog/hive/factories/HiveCatalogFactory.java
This file contains 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,113 @@ | ||
| /* | ||
| * 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:https://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.flink.table.catalog.hive.factories; | ||
|
|
||
| import org.apache.flink.table.catalog.Catalog; | ||
| import org.apache.flink.table.catalog.exceptions.CatalogException; | ||
| import org.apache.flink.table.catalog.hive.HiveCatalog; | ||
| import org.apache.flink.table.catalog.hive.descriptors.HiveCatalogValidator; | ||
| import org.apache.flink.table.descriptors.DescriptorProperties; | ||
| import org.apache.flink.table.factories.CatalogFactory; | ||
| import org.apache.flink.util.StringUtils; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.io.File; | ||
| import java.net.MalformedURLException; | ||
| import java.net.URL; | ||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| import static org.apache.flink.table.catalog.hive.descriptors.HiveCatalogValidator.CATALOG_HIVE_SITE_PATH; | ||
| import static org.apache.flink.table.catalog.hive.descriptors.HiveCatalogValidator.CATALOG_TYPE_VALUE_HIVE; | ||
| import static org.apache.flink.table.descriptors.CatalogDescriptorValidator.CATALOG_DEFAULT_DATABASE; | ||
| import static org.apache.flink.table.descriptors.CatalogDescriptorValidator.CATALOG_PROPERTY_VERSION; | ||
| import static org.apache.flink.table.descriptors.CatalogDescriptorValidator.CATALOG_TYPE; | ||
|
|
||
| /** | ||
| * Catalog factory for {@link HiveCatalog}. | ||
| */ | ||
| public class HiveCatalogFactory implements CatalogFactory { | ||
| private static final Logger LOG = LoggerFactory.getLogger(HiveCatalogFactory.class); | ||
|
|
||
| @Override | ||
| public Map<String, String> requiredContext() { | ||
| Map<String, String> context = new HashMap<>(); | ||
| context.put(CATALOG_TYPE, CATALOG_TYPE_VALUE_HIVE); // hive | ||
| context.put(CATALOG_PROPERTY_VERSION, "1"); // backwards compatibility | ||
| return context; | ||
| } | ||
|
|
||
| @Override | ||
| public List<String> supportedProperties() { | ||
| List<String> properties = new ArrayList<>(); | ||
|
|
||
| // default database | ||
| properties.add(CATALOG_DEFAULT_DATABASE); | ||
|
|
||
| properties.add(CATALOG_HIVE_SITE_PATH); | ||
|
|
||
| return properties; | ||
| } | ||
|
|
||
| @Override | ||
| public Catalog createCatalog(String name, Map<String, String> properties) { | ||
| final DescriptorProperties descriptorProperties = getValidatedProperties(properties); | ||
|
|
||
| final String defaultDatabase = | ||
| descriptorProperties.getOptionalString(CATALOG_DEFAULT_DATABASE) | ||
| .orElse(HiveCatalog.DEFAULT_DB); | ||
|
|
||
| final Optional<String> hiveSitePath = descriptorProperties.getOptionalString(CATALOG_HIVE_SITE_PATH); | ||
|
|
||
| return new HiveCatalog(name, defaultDatabase, loadHiveSiteUrl(hiveSitePath.orElse(null))); | ||
| } | ||
|
|
||
| private static URL loadHiveSiteUrl(String filePath) { | ||
|
|
||
| URL url = null; | ||
|
|
||
| if (!StringUtils.isNullOrWhitespaceOnly(filePath)) { | ||
| try { | ||
| url = new File(filePath).toURI().toURL(); | ||
|
|
||
| LOG.info("Successfully loaded '{}'", filePath); | ||
|
|
||
| } catch (MalformedURLException e) { | ||
| throw new CatalogException( | ||
| String.format("Failed to get hive-site.xml from the given path '%s'", filePath), e); | ||
| } | ||
| } | ||
|
|
||
| return url; | ||
| } | ||
|
|
||
| private static DescriptorProperties getValidatedProperties(Map<String, String> properties) { | ||
| final DescriptorProperties descriptorProperties = new DescriptorProperties(true); | ||
| descriptorProperties.putProperties(properties); | ||
|
|
||
| new HiveCatalogValidator().validate(descriptorProperties); | ||
|
|
||
| return descriptorProperties; | ||
| } | ||
| } |
Oops, something went wrong.