Interface InformationExtractor

@Incubating public interface InformationExtractor
Contract for extracting information about objects in the database schema(s). To an extent, the contract largely mirrors parts of the JDBC DatabaseMetaData contract. THe intention is to insulate callers from DatabaseMetaData since on many databases there are better ways to get information from the meta schema.
API Note:
Concepts here taken largely from the MetaDataDialect class in Hibernate Tools.

  • Method Details

    • catalogExists

      boolean catalogExists(Identifier catalog)
      Does the given catalog exist yet?
      Parameters:
      catalog - The name of the catalog to look for.
      Returns:
      true if the catalog does exist; false otherwise

    • schemaExists

      boolean schemaExists(Identifier catalog, Identifier schema)
      Does the given schema exist yet?
      Parameters:
      catalog - The name of the catalog to look in.
      schema - The name of the schema to look for.
      Returns:
      true if the schema does exist; false otherwise

    • getTable

      TableInformation getTable(Identifier catalog, Identifier schema, Identifier tableName)
      Look for a matching table.
      Parameters:
      catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.
      schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .
      tableName - The name of the table to look for.
      Returns:
      table info for the matching table

    • getTables

      NameSpaceTablesInformation getTables(Identifier catalog, Identifier schema)
      Extract all the tables information.
      Parameters:
      catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.
      schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .
      Returns:
      a NameSpaceTablesInformation

    • getPrimaryKey

      @Nullable PrimaryKeyInformation getPrimaryKey(TableInformation tableInformation)
      Extract information about the given table's primary key.
      Parameters:
      tableInformation - The table for which to locate primary key information,
      Returns:
      The extracted primary key information

    • getPrimaryKeys

      NameSpacePrimaryKeysInformation getPrimaryKeys(Identifier catalog, Identifier schema)
      Extract all the primary keys information.
      Parameters:
      catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.
      schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .
      Returns:
      a NameSpacePrimaryKeysInformation
      Throws:
      SchemaExtractionException - when bulk extraction isn't supported
      Since:
      7.2

    • getIndexes

      Iterable<IndexInformation> getIndexes(TableInformation tableInformation)
      Extract information about indexes defined against the given table. Typically called from the TableInformation itself as part of on-demand initialization of its state.
      Parameters:
      tableInformation - The table for which to locate indexes
      Returns:
      The extracted index information

    • getIndexes

      NameSpaceIndexesInformation getIndexes(Identifier catalog, Identifier schema)
      Extract all the indexes information.
      Parameters:
      catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.
      schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .
      Returns:
      a NameSpaceIndexesInformation
      Throws:
      SchemaExtractionException - when bulk extraction isn't supported
      Since:
      7.2

    • getForeignKeys

      Iterable<ForeignKeyInformation> getForeignKeys(TableInformation tableInformation)
      Extract information about foreign keys defined on the given table (targeting or point-at other tables). Typically called from the TableInformation itself as part of on-demand initialization of its state.
      Parameters:
      tableInformation - The table for which to locate foreign-keys
      Returns:
      The extracted foreign-key information

    • getForeignKeys

      NameSpaceForeignKeysInformation getForeignKeys(Identifier catalog, Identifier schema)
      Extract all the foreign keys information.
      Parameters:
      catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.
      schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .
      Returns:
      a NameSpaceForeignKeysInformation
      Throws:
      SchemaExtractionException - when bulk extraction isn't supported
      Since:
      7.2

    • supportsBulkPrimaryKeyRetrieval

      boolean supportsBulkPrimaryKeyRetrieval()
      Can getPrimaryKeys(Identifier, Identifier) be used?
      Since:
      7.2

    • supportsBulkForeignKeyRetrieval

      boolean supportsBulkForeignKeyRetrieval()
      Can getForeignKeys(Identifier, Identifier) be used?
      Since:
      7.2

    • supportsBulkIndexRetrieval

      boolean supportsBulkIndexRetrieval()
      Can getIndexes(Identifier, Identifier) be used?
      Since:
      7.2