schemacrawler.crawl.IndexRetriever Maven / Gradle / Ivy
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2020, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------
SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.
You may elect to redistribute this code under any of these licenses.
The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html
The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/
========================================================================
*/
package schemacrawler.crawl;
import static java.util.Objects.requireNonNull;
import static schemacrawler.schemacrawler.InformationSchemaKey.INDEXES;
import static schemacrawler.schemacrawler.SchemaInfoMetadataRetrievalStrategy.indexesRetrievalStrategy;
import static us.fatehi.utility.Utility.isBlank;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Optional;
import java.util.logging.Level;
import schemacrawler.SchemaCrawlerLogger;
import schemacrawler.schema.Column;
import schemacrawler.schema.IndexColumnSortSequence;
import schemacrawler.schema.IndexType;
import schemacrawler.schema.Schema;
import schemacrawler.schemacrawler.InformationSchemaViews;
import schemacrawler.schemacrawler.Query;
import schemacrawler.schemacrawler.SchemaCrawlerOptions;
import schemacrawler.schemacrawler.SchemaCrawlerSQLException;
import us.fatehi.utility.string.StringFormat;
/**
* A retriever uses database metadata to get the details about the database
* tables.
*
* @author Sualeh Fatehi
*/
final class IndexRetriever
extends AbstractRetriever
{
private static final SchemaCrawlerLogger LOGGER =
SchemaCrawlerLogger.getLogger(IndexRetriever.class.getName());
IndexRetriever(final RetrieverConnection retrieverConnection,
final MutableCatalog catalog,
final SchemaCrawlerOptions options)
{
super(retrieverConnection, catalog, options);
}
void retrieveIndexes(final NamedObjectList allTables)
throws SQLException
{
requireNonNull(allTables, "No tables provided");
switch (getRetrieverConnection().get(indexesRetrievalStrategy))
{
case data_dictionary_all:
LOGGER.log(Level.INFO,
"Retrieving indexes, using fast data dictionary retrieval");
retrieveIndexesFromDataDictionary(allTables);
break;
case metadata:
LOGGER.log(Level.INFO, "Retrieving indexes");
retrieveIndexesFromMetadata(allTables);
break;
default:
break;
}
}
private void createIndexes(final MutableTable table,
final MetadataResultSet results)
throws SQLException
{
while (results.next())
{
createIndexForTable(table, results);
}
}
private void createIndexForTable(final MutableTable table,
final MetadataResultSet results)
{
// "TABLE_CAT", "TABLE_SCHEM", "TABLE_NAME"
String indexName = results.getString("INDEX_NAME");
LOGGER.log(Level.FINE,
new StringFormat("Retrieving index <%s.%s>", table, indexName));
// Work-around PostgreSQL JDBC driver bugs by unquoting column
// names first
// #3480 -
// http://www.postgresql.org/message-id/[email protected]
// #6253 -
// http://www.postgresql.org/message-id/[email protected]
final String columnName = results.getString("COLUMN_NAME");
if (isBlank(columnName))
{
return;
}
LOGGER.log(Level.FINE,
new StringFormat("Retrieving index column <%s.%s.%s>",
table,
indexName,
columnName));
final boolean uniqueIndex = !results.getBoolean("NON_UNIQUE");
final IndexType type = results.getEnumFromId("TYPE", IndexType.unknown);
final int ordinalPosition = results.getInt("ORDINAL_POSITION", 0);
final IndexColumnSortSequence sortSequence =
IndexColumnSortSequence.valueOfFromCode(results.getString("ASC_OR_DESC"));
final int cardinality = results.getInt("CARDINALITY", 0);
final int pages = results.getInt("PAGES", 0);
final Column column;
final Optional columnOptional =
table.lookupColumn(columnName);
if (columnOptional.isPresent())
{
final MutableColumn mutableColumn = columnOptional.get();
mutableColumn.markAsPartOfIndex();
if (uniqueIndex)
{
mutableColumn.markAsPartOfUniqueIndex();
}
column = mutableColumn;
}
else
{
// Indexes may have pseudo-columns, that are not part of the table
// for example, Oracle function-based indexes have columns from
// the result of a function
column = new ColumnPartial(table, columnName);
}
if (isBlank(indexName))
{
indexName = String.format("SC_%s",
Integer
.toHexString(column
.getFullName()
.hashCode())
.toUpperCase());
}
final Optional indexOptional = table.lookupIndex(indexName);
final MutableIndex index;
if (indexOptional.isPresent())
{
index = indexOptional.get();
}
else
{
index = new MutableIndex(table, indexName);
table.addIndex(index);
}
final MutableIndexColumn indexColumn =
new MutableIndexColumn(index, column);
indexColumn.setKeyOrdinalPosition(ordinalPosition);
indexColumn.setSortSequence(sortSequence);
//
index.addColumn(indexColumn);
index.setUnique(uniqueIndex);
index.setIndexType(type);
index.setCardinality(cardinality);
index.setPages(pages);
index.addAttributes(results.getAttributes());
}
private void retrieveIndexesFromDataDictionary(final NamedObjectList allTables)
throws SchemaCrawlerSQLException
{
final InformationSchemaViews informationSchemaViews =
getRetrieverConnection().getInformationSchemaViews();
if (!informationSchemaViews.hasQuery(INDEXES))
{
LOGGER.log(Level.FINE, "Extended indexes SQL statement was not provided");
return;
}
final Query indexesSql = informationSchemaViews.getQuery(INDEXES);
final Connection connection = getDatabaseConnection();
try (
final Statement statement = connection.createStatement();
final MetadataResultSet results = new MetadataResultSet(indexesSql,
statement,
getSchemaInclusionRule())
)
{
results.setDescription("retrieveIndexesFromDataDictionary");
while (results.next())
{
final String catalogName =
normalizeCatalogName(results.getString("TABLE_CAT"));
final String schemaName =
normalizeSchemaName(results.getString("TABLE_SCHEM"));
final String tableName = results.getString("TABLE_NAME");
final Optional optionalTable =
lookupTable(catalogName, schemaName, tableName);
if (!optionalTable.isPresent())
{
continue;
}
final MutableTable table = optionalTable.get();
createIndexForTable(table, results);
}
}
catch (final SQLException e)
{
throw new SchemaCrawlerSQLException(
"Could not retrieve indexes from SQL:\n" + indexesSql,
e);
}
}
private void retrieveTableIndexesFromMetadata(final MutableTable table,
final boolean unique)
throws SQLException
{
final Schema tableSchema = table.getSchema();
try (
final MetadataResultSet results = new MetadataResultSet(getMetaData().getIndexInfo(
tableSchema.getCatalogName(),
tableSchema.getName(),
table.getName(),
unique,
true/* approximate */))
)
{
createIndexes(table, results);
}
catch (final SQLException e)
{
throw new SchemaCrawlerSQLException(
"Could not retrieve indexes for table " + table,
e);
}
}
private void retrieveIndexesFromMetadata(final NamedObjectList allTables)
throws SQLException
{
for (final MutableTable table : allTables)
{
retrieveTableIndexesFromMetadata(table, false);
retrieveTableIndexesFromMetadata(table, true);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy