-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Oracle case insensitive search (#2487)
- Loading branch information
Showing
4 changed files
with
536 additions
and
33 deletions.
There are no files selected for viewing
203 changes: 203 additions & 0 deletions
203
athena-oracle/src/main/java/com/amazonaws/athena/connectors/oracle/OracleCaseResolver.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,203 @@ | ||
|
|
||
| /*- | ||
| * #%L | ||
| * athena-oracle | ||
| * %% | ||
| * Copyright (C) 2019 Amazon Web Services | ||
| * %% | ||
| * Licensed 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. | ||
| * #L% | ||
| */ | ||
| package com.amazonaws.athena.connectors.oracle; | ||
|
|
||
| import com.amazonaws.athena.connector.lambda.domain.TableName; | ||
| import com.amazonaws.athena.connectors.jdbc.manager.PreparedStatementBuilder; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.sql.Connection; | ||
| import java.sql.PreparedStatement; | ||
| import java.sql.ResultSet; | ||
| import java.sql.SQLException; | ||
| import java.util.Arrays; | ||
| import java.util.Map; | ||
|
|
||
| import static com.amazonaws.athena.connector.lambda.connection.EnvironmentConstants.DEFAULT_GLUE_CONNECTION; | ||
|
|
||
| public class OracleCaseResolver | ||
| { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(OracleCaseResolver.class); | ||
| static final String SCHEMA_NAME_QUERY_TEMPLATE = "SELECT DISTINCT OWNER as \"OWNER\" FROM all_tables WHERE lower(OWNER) = ?"; | ||
| static final String TABLE_NAME_QUERY_TEMPLATE = "SELECT DISTINCT TABLE_NAME as \"TABLE_NAME\" FROM all_tables WHERE OWNER = ? and lower(TABLE_NAME) = ?"; | ||
| static final String SCHEMA_NAME_COLUMN_KEY = "OWNER"; | ||
| static final String TABLE_NAME_COLUMN_KEY = "TABLE_NAME"; | ||
|
|
||
| // the environment variable that can be set to specify which casing mode to use | ||
| static final String CASING_MODE = "casing_mode"; | ||
|
|
||
| // used for identifying database objects (ex: table names) | ||
| private static final String ORACLE_IDENTIFIER_CHARACTER = "\""; | ||
| // used in SQL statements for character strings (ex: where OWNER = 'example') | ||
| private static final String ORACLE_STRING_LITERAL_CHARACTER = "\'"; | ||
|
|
||
| private OracleCaseResolver() {} | ||
|
|
||
| private enum OracleCasingMode | ||
| { | ||
| LOWER, // casing mode to lower case everything (glue and trino lower case everything) | ||
| UPPER, // casing mode to upper case everything (oracle by default upper cases everything) | ||
| CASE_INSENSITIVE_SEARCH // casing mode to perform case insensitive search | ||
| } | ||
|
|
||
| public static TableName getAdjustedTableObjectName(final Connection connection, TableName tableName, Map<String, String> configOptions) | ||
| throws SQLException | ||
| { | ||
| OracleCasingMode casingMode = getCasingMode(configOptions); | ||
| switch (casingMode) { | ||
| case CASE_INSENSITIVE_SEARCH: | ||
| String schemaNameCaseInsensitively = getSchemaNameCaseInsensitively(connection, tableName.getSchemaName()); | ||
| String tableNameCaseInsensitively = getTableNameCaseInsensitively(connection, schemaNameCaseInsensitively, tableName.getTableName()); | ||
| TableName tableNameResult = new TableName(schemaNameCaseInsensitively, tableNameCaseInsensitively); | ||
| LOGGER.info("casing mode is `SEARCH`: performing case insensitive search for TableName object. TableName:{}", tableNameResult); | ||
| return tableNameResult; | ||
| case UPPER: | ||
| TableName upperTableName = new TableName(tableName.getSchemaName().toUpperCase(), tableName.getTableName().toUpperCase()); | ||
| LOGGER.info("casing mode is `UPPER`: adjusting casing from input to upper case for TableName object. TableName:{}", upperTableName); | ||
| return upperTableName; | ||
| case LOWER: | ||
| TableName lowerTableName = new TableName(tableName.getSchemaName().toLowerCase(), tableName.getTableName().toLowerCase()); | ||
| LOGGER.info("casing mode is `LOWER`: adjusting casing from input to lower case for TableName object. TableName:{}", lowerTableName); | ||
| return lowerTableName; | ||
| } | ||
| LOGGER.warn("casing mode is empty: not adjust casing from input for TableName object. TableName:{}", tableName); | ||
| return tableName; | ||
| } | ||
|
|
||
| public static String getAdjustedSchemaName(final Connection connection, String schemaNameInput, Map<String, String> configOptions) | ||
| throws SQLException | ||
| { | ||
| OracleCasingMode casingMode = getCasingMode(configOptions); | ||
| switch (casingMode) { | ||
| case CASE_INSENSITIVE_SEARCH: | ||
| LOGGER.info("casing mode is SEARCH: performing case insensitive search for Schema..."); | ||
| return getSchemaNameCaseInsensitively(connection, schemaNameInput); | ||
| case UPPER: | ||
| LOGGER.info("casing mode is `UPPER`: adjusting casing from input to upper case for Schema"); | ||
| return schemaNameInput.toUpperCase(); | ||
| case LOWER: | ||
| LOGGER.info("casing mode is `LOWER`: adjusting casing from input to lower case for Schema"); | ||
| return schemaNameInput.toLowerCase(); | ||
| } | ||
|
|
||
| return schemaNameInput; | ||
| } | ||
|
|
||
| public static String getSchemaNameCaseInsensitively(final Connection connection, String schemaName) | ||
| throws SQLException | ||
| { | ||
| String nameFromOracle = null; | ||
| int i = 0; | ||
| try (PreparedStatement preparedStatement = new PreparedStatementBuilder() | ||
| .withConnection(connection) | ||
| .withQuery(SCHEMA_NAME_QUERY_TEMPLATE) | ||
| .withParameters(Arrays.asList(schemaName.toLowerCase())).build(); | ||
| ResultSet resultSet = preparedStatement.executeQuery()) { | ||
| while (resultSet.next()) { | ||
| i++; | ||
| String schemaNameCandidate = resultSet.getString(SCHEMA_NAME_COLUMN_KEY); | ||
| LOGGER.debug("Case insensitive search on columLabel: {}, schema name: {}", SCHEMA_NAME_COLUMN_KEY, schemaNameCandidate); | ||
| nameFromOracle = schemaNameCandidate; | ||
| } | ||
| } | ||
| catch (SQLException e) { | ||
| throw new RuntimeException(String.format("getSchemaNameCaseInsensitively query failed for %s", schemaName), e); | ||
| } | ||
|
|
||
| if (i != 1) { | ||
| throw new RuntimeException(String.format("Schema name case insensitive match failed, number of match : %d", i)); | ||
| } | ||
|
|
||
| return nameFromOracle; | ||
| } | ||
|
|
||
| public static String getTableNameCaseInsensitively(final Connection connection, String schemaName, String tableNameInput) | ||
| throws SQLException | ||
| { | ||
| // schema name input should be correct case before searching tableName already | ||
| String nameFromOracle = null; | ||
| int i = 0; | ||
| try (PreparedStatement preparedStatement = new PreparedStatementBuilder() | ||
| .withConnection(connection) | ||
| .withQuery(TABLE_NAME_QUERY_TEMPLATE) | ||
| .withParameters(Arrays.asList((schemaName), tableNameInput.toLowerCase())).build(); | ||
| ResultSet resultSet = preparedStatement.executeQuery()) { | ||
| while (resultSet.next()) { | ||
| i++; | ||
| String schemaNameCandidate = resultSet.getString(TABLE_NAME_COLUMN_KEY); | ||
| LOGGER.debug("Case insensitive search on columLabel: {}, schema name: {}", TABLE_NAME_COLUMN_KEY, schemaNameCandidate); | ||
| nameFromOracle = schemaNameCandidate; | ||
| } | ||
| } | ||
| catch (SQLException e) { | ||
| throw new RuntimeException(String.format("getTableNameCaseInsensitively query failed for schema: %s tableName: %s", schemaName, tableNameInput), e); | ||
| } | ||
|
|
||
| if (i != 1) { | ||
| throw new RuntimeException(String.format("Schema name case insensitive match failed, number of match : %d", i)); | ||
| } | ||
|
|
||
| return nameFromOracle; | ||
| } | ||
|
|
||
| private static OracleCasingMode getCasingMode(Map<String, String> configOptions) | ||
| { | ||
| boolean isGlueConnection = StringUtils.isNotBlank(configOptions.get(DEFAULT_GLUE_CONNECTION)); | ||
| if (!configOptions.containsKey(CASING_MODE)) { | ||
| LOGGER.info("CASING MODE not set"); | ||
| return isGlueConnection ? OracleCasingMode.LOWER : OracleCasingMode.UPPER; | ||
| } | ||
|
|
||
| try { | ||
| OracleCasingMode oracleCasingMode = OracleCasingMode.valueOf(configOptions.get(CASING_MODE).toUpperCase()); | ||
| LOGGER.info("CASING MODE enable: {}", oracleCasingMode.toString()); | ||
| return oracleCasingMode; | ||
| } | ||
| catch (IllegalArgumentException ex) { | ||
| // print error log for customer along with list of input | ||
| LOGGER.error("Invalid input for:{}, input value:{}, valid values:{}", CASING_MODE, configOptions.get(CASING_MODE), Arrays.asList(OracleCasingMode.values()), ex); | ||
| throw ex; | ||
| } | ||
| } | ||
|
|
||
| public static TableName quoteTableName(TableName inputTable) | ||
| { | ||
| String schemaName = inputTable.getSchemaName(); | ||
| String tableName = inputTable.getTableName(); | ||
| if (!schemaName.contains(ORACLE_IDENTIFIER_CHARACTER)) { | ||
| schemaName = ORACLE_IDENTIFIER_CHARACTER + schemaName + ORACLE_IDENTIFIER_CHARACTER; | ||
| } | ||
| if (!tableName.contains(ORACLE_IDENTIFIER_CHARACTER)) { | ||
| tableName = ORACLE_IDENTIFIER_CHARACTER + tableName + ORACLE_IDENTIFIER_CHARACTER; | ||
| } | ||
| return new TableName(schemaName, tableName); | ||
| } | ||
|
|
||
| public static String convertToLiteral(String input) | ||
| { | ||
| if (!input.contains(ORACLE_STRING_LITERAL_CHARACTER)) { | ||
| input = ORACLE_STRING_LITERAL_CHARACTER + input + ORACLE_STRING_LITERAL_CHARACTER; | ||
| } | ||
| return input; | ||
| } | ||
| } |
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
Oops, something went wrong.