com.palantir.atlasdb.keyvalue.dbkvs.OracleTableNameGetterImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-dbkvs Show documentation
Palantir open source project
There is a newer version: 0.1193.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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.
 */
package com.palantir.atlasdb.keyvalue.dbkvs;

import com.palantir.atlasdb.keyvalue.api.TableReference;
import com.palantir.atlasdb.keyvalue.dbkvs.impl.ConnectionSupplier;
import com.palantir.atlasdb.keyvalue.dbkvs.impl.DbKvs;
import com.palantir.common.exception.TableMappingNotFoundException;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.logger.SafeLogger;
import com.palantir.logsafe.logger.SafeLoggerFactory;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;

public final class OracleTableNameGetterImpl implements OracleTableNameGetter {
    private static final SafeLogger log = SafeLoggerFactory.get(OracleTableNameGetterImpl.class);

    private final String tablePrefix;
    private final String overflowTablePrefix;
    private final OracleTableNameMapper oracleTableNameMapper;
    private final OracleTableNameUnmapper oracleTableNameUnmapper;
    private final boolean useTableMapping;

    private OracleTableNameGetterImpl(
            OracleDdlConfig config, OracleTableNameMapper tableNameMapper, OracleTableNameUnmapper tableNameUnmapper) {
        this.tablePrefix = config.tablePrefix();
        this.overflowTablePrefix = config.overflowTablePrefix();
        this.useTableMapping = config.useTableMapping();

        this.oracleTableNameMapper = tableNameMapper;
        this.oracleTableNameUnmapper = tableNameUnmapper;
    }

    public static OracleTableNameGetter createDefault(OracleDdlConfig config) {
        return new OracleTableNameGetterImpl(config, new OracleTableNameMapper(), new OracleTableNameUnmapper());
    }

    public static OracleTableNameGetter createForTests(
            OracleDdlConfig config, OracleTableNameMapper tableNameMapper, OracleTableNameUnmapper tableNameUnmapper) {
        return new OracleTableNameGetterImpl(config, tableNameMapper, tableNameUnmapper);
    }

    @Override
    public String generateShortTableName(ConnectionSupplier connectionSupplier, TableReference tableRef) {
        if (useTableMapping) {
            return oracleTableNameMapper.getShortPrefixedTableName(connectionSupplier, tablePrefix, tableRef);
        }
        return getPrefixedTableName(tableRef);
    }

    @Override
    public String generateShortOverflowTableName(ConnectionSupplier connectionSupplier, TableReference tableRef) {
        if (useTableMapping) {
            return oracleTableNameMapper.getShortPrefixedTableName(connectionSupplier, overflowTablePrefix, tableRef);
        }
        return getPrefixedOverflowTableName(tableRef);
    }

    @Override
    public String getInternalShortTableName(ConnectionSupplier connectionSupplier, TableReference tableRef)
            throws TableMappingNotFoundException {
        if (useTableMapping) {
            return oracleTableNameUnmapper.getShortTableNameFromMappingTable(connectionSupplier, tablePrefix, tableRef);
        }
        return getPrefixedTableName(tableRef);
    }

    @Override
    public String getInternalShortOverflowTableName(ConnectionSupplier connectionSupplier, TableReference tableRef)
            throws TableMappingNotFoundException {
        if (useTableMapping) {
            return oracleTableNameUnmapper.getShortTableNameFromMappingTable(
                    connectionSupplier, overflowTablePrefix, tableRef);
        }
        return getPrefixedOverflowTableName(tableRef);
    }

    @Override
    public Set getTableReferencesFromShortTableNames(
            ConnectionSupplier connectionSupplier, Set shortTableNames) {
        return getTableReferencesFromShortTableNamesWithPrefix(connectionSupplier, shortTableNames, tablePrefix);
    }

    @Override
    public Set getTableReferencesFromShortOverflowTableNames(
            ConnectionSupplier connectionSupplier, Set shortTableNames) {
        return getTableReferencesFromShortTableNamesWithPrefix(
                connectionSupplier, shortTableNames, overflowTablePrefix);
    }

    private Set getTableReferencesFromShortTableNamesWithPrefix(
            ConnectionSupplier connectionSupplier, Set shortTableNames, String tablePrefixToStrip) {
        Set longTableNames = getLongTableNames(connectionSupplier, shortTableNames);
        return longTableNames.stream()
                .peek(tableName -> {
                    if (!StringUtils.startsWithIgnoreCase(tableName, tablePrefixToStrip)) {
                        throw new SafeIllegalArgumentException(
                                "Long table name does not begin with prefix",
                                UnsafeArg.of("tableName", tableName),
                                SafeArg.of("prefix", tablePrefixToStrip));
                    }
                })
                .map(tableName -> StringUtils.removeStartIgnoreCase(tableName, tablePrefixToStrip))
                .map(TableReference::fromInternalTableName)
                .collect(Collectors.toSet());
    }

    private Set getLongTableNames(ConnectionSupplier connectionSupplier, Set shortTableNames) {
        Map shortToLongTableNames =
                oracleTableNameUnmapper.getShortToLongTableNamesFromMappingTable(connectionSupplier, shortTableNames);
        Set unmappedTableNames = getUnmappedTableNames(shortToLongTableNames, shortTableNames);

        if (useTableMapping) {
            logIfUnmappedTablesPresent(unmappedTableNames);
            return new HashSet<>(shortToLongTableNames.values());
        }

        return unmappedTableNames;
    }

    private Set getUnmappedTableNames(
            Map shortToLongTableNameMapping, Set expectedShortTableNames) {
        Set mappedShortTableNames = shortToLongTableNameMapping.keySet().stream()
                .map(OracleTableNameGetterImpl::toLowerCase)
                .collect(Collectors.toSet());
        return expectedShortTableNames.stream()
                .filter(tableName -> !mappedShortTableNames.contains(OracleTableNameGetterImpl.toLowerCase(tableName)))
                .collect(Collectors.toSet());
    }

    private void logIfUnmappedTablesPresent(Set unmappedTableNames) {
        if (!unmappedTableNames.isEmpty()) {
            log.info(
                    "Some tables are missing a mapping. This may be due to another client using the same user and"
                            + " prefix without table mapping",
                    SafeArg.of("numTablesMissingMapping", unmappedTableNames.size()),
                    UnsafeArg.of("unmappedShortTableNames", unmappedTableNames));
        }
    }

    @Override
    public String getPrefixedTableName(TableReference tableRef) {
        return tablePrefix + DbKvs.internalTableName(tableRef);
    }

    @Override
    public String getPrefixedOverflowTableName(TableReference tableRef) {
        return overflowTablePrefix + DbKvs.internalTableName(tableRef);
    }

    @Override
    public void clearCacheForTable(String fullTableName) {
        oracleTableNameUnmapper.clearCacheForTable(fullTableName);
    }

    private static String toLowerCase(String string) {
        return string.toLowerCase(Locale.ROOT);
    }
}