schemacrawler.crawl.SynonymRetriever Maven / Gradle / Ivy

Go to download
/*
========================================================================
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 schemacrawler.schemacrawler.InformationSchemaKey.EXT_SYNONYMS;
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.filter.InclusionRuleFilter;
import schemacrawler.inclusionrule.InclusionRule;
import schemacrawler.schema.DatabaseObject;
import schemacrawler.schema.Schema;
import schemacrawler.schema.Synonym;
import schemacrawler.schemacrawler.InformationSchemaViews;
import schemacrawler.schemacrawler.Query;
import schemacrawler.schemacrawler.SchemaCrawlerOptions;
import schemacrawler.schemacrawler.SchemaReference;
import us.fatehi.utility.string.StringFormat;

/**
 * A retriever that uses database metadata to get the extended details about the
 * database synonyms.
 *
 * @author Matt Albrecht, Sualeh Fatehi
 */
final class SynonymRetriever
  extends AbstractRetriever
{

  private static final SchemaCrawlerLogger LOGGER =
    SchemaCrawlerLogger.getLogger(SynonymRetriever.class.getName());

  SynonymRetriever(final RetrieverConnection retrieverConnection,
                   final MutableCatalog catalog,
                   final SchemaCrawlerOptions options)
    throws SQLException
  {
    super(retrieverConnection, catalog, options);
  }

  /**
   * Retrieves the synonym definitions from the database.
   *
   * @param synonymInclusionRule
   *   Rule for including synonyms
   * @throws SQLException
   *   On a SQL exception
   */
  void retrieveSynonymInformation(final InclusionRule synonymInclusionRule)
    throws SQLException
  {
    final InclusionRuleFilter synonymFilter =
      new InclusionRuleFilter<>(synonymInclusionRule, false);
    if (synonymFilter.isExcludeAll())
    {
      LOGGER.log(Level.INFO,
                 "Not retrieving synonyms, since this was not requested");
      return;
    }

    LOGGER.log(Level.INFO, "Retrieving synonyms");

    final InformationSchemaViews informationSchemaViews =
      getRetrieverConnection().getInformationSchemaViews();
    if (!informationSchemaViews.hasQuery(EXT_SYNONYMS))
    {
      LOGGER.log(Level.FINE,
                 "Synonym definition SQL statement was not provided");
      return;
    }

    final NamedObjectList schemas = getAllSchemas();

    final Query synonymsDefinitionSql =
      informationSchemaViews.getQuery(EXT_SYNONYMS);
    final Connection connection = getDatabaseConnection();
    try (
      final Statement statement = connection.createStatement();
      MetadataResultSet results = new MetadataResultSet(synonymsDefinitionSql,
                                                        statement,
                                                        getSchemaInclusionRule())
    )
    {
      while (results.next())
      {
        final String catalogName =
          normalizeCatalogName(results.getString("SYNONYM_CATALOG"));
        final String schemaName =
          normalizeSchemaName(results.getString("SYNONYM_SCHEMA"));
        final String synonymName = results.getString("SYNONYM_NAME");
        final String referencedObjectCatalogName =
          results.getString("REFERENCED_OBJECT_CATALOG");
        final String referencedObjectSchemaName =
          results.getString("REFERENCED_OBJECT_SCHEMA");
        final String referencedObjectName =
          results.getString("REFERENCED_OBJECT_NAME");

        if (isBlank(referencedObjectName))
        {
          LOGGER.log(Level.FINE,
                     new StringFormat("No reference for synonym <%s.%s.%s>",
                                      catalogName,
                                      schemaName,
                                      synonymName));
          continue;
        }

        final Schema schema = new SchemaReference(catalogName, schemaName);
        final Schema referencedSchema = new SchemaReference(
          referencedObjectCatalogName,
          referencedObjectSchemaName);
        if (!schemas.contains(schema) && !schemas.contains(referencedSchema))
        {
          continue;
        }

        final Optional referencedTable = lookupTable(
          referencedObjectCatalogName,
          referencedObjectSchemaName,
          referencedObjectName);
        final Optional referencedRoutine = lookupRoutine(
          referencedObjectCatalogName,
          referencedObjectSchemaName,
          referencedObjectName,
          referencedObjectName);
        final DatabaseObject referencedObject;
        if (referencedTable.isPresent())
        {
          referencedObject = referencedTable.get();
        }
        else if (referencedRoutine.isPresent())
        {
          referencedObject = referencedRoutine.get();
        }
        else
        {
          referencedObject =
            new AbstractDatabaseObject(referencedSchema, referencedObjectName)
            {

              private static final long serialVersionUID =
                -2212843304418302122L;
            };
        }

        final MutableSynonym synonym = new MutableSynonym(schema, synonymName);
        synonym.setReferencedObject(referencedObject);

        synonym.addAttributes(results.getAttributes());

        if (synonymFilter.test(synonym))
        {
          catalog.addSynonym(synonym);
        }

      }
    }
    catch (final Exception e)
    {
      LOGGER.log(Level.WARNING, "Could not retrieve synonyms", e);
    }

  }

}