Module org.jooq.meta
Package org.jooq.meta

Interface ResultQueryDatabase

All Superinterfaces:
AutoCloseable, Database
All Known Implementing Classes:
DerbyDatabase, FirebirdDatabase, H2Database, HSQLDBDatabase, MariaDBDatabase, MySQLDatabase, PostgresDatabase, SQLiteDatabase, YugabyteDBDatabase
@Internal public interface ResultQueryDatabase extends Database
An interface for all AbstractDatabase implementations that can produce ResultQuery objects to query meta data.

These queries will be used to generate some internal queries in the core library's Meta API. The return types of the various methods are subject to change and should not be relied upon.

Author:
Lukas Eder

  • Method Details

    • primaryKeys

      @Internal @Nullable @Nullable ResultQuery<Record6<String,String,String,String,String,Integer>> primaryKeys(List<String> schemas)
      A query that produces primary keys for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Table name
      4. Constraint name
      5. Column name
      6. Column sequence
      Returns:
      The query or null if this implementation doesn't support the query.

    • uniqueKeys

      @Internal @Nullable @Nullable ResultQuery<Record6<String,String,String,String,String,Integer>> uniqueKeys(List<String> schemas)
      A query that produces (non-primary) unique keys for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Table name
      4. Constraint name
      5. Column name
      6. Column sequence
      Returns:
      The query or null if this implementation doesn't support the query.

    • sequences

      @Internal @Nullable @Nullable ResultQuery<Record12<String,String,String,String,Integer,Integer,Long,Long,BigDecimal,BigDecimal,Boolean,Long>> sequences(List<String> schemas)
      A query that produces sequences for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Sequence name
      4. Data type name
      5. Data type precision
      6. Data type scale
      7. Start value
      8. Increment
      9. Min value
      10. Max value
      11. Cycle
      12. Cache
      Returns:
      The query or null if this implementation doesn't support the query.

    • enums

      @Internal @Nullable @Nullable ResultQuery<Record6<String,String,String,String,String,Integer>> enums(List<String> schemas)
      A query that produces enum types and their literals for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Column name (if applicable, e.g. in MySQL style RDBMS)
      4. Enum type name (if applicable, e.g. in PostgreSQL style RDBMS)
      5. Literal value
      6. Literal position
      Returns:
      The query or null if this implementation doesn't support the query.

    • sources

      @Internal @Nullable @Nullable ResultQuery<Record4<String,String,String,String>> sources(List<String> schemas)
      A query that produces source code for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Object name (e.g. table, view, function, package)
      4. Source
      Returns:
      The query or null if this implementation doesn't support the query.

    • comments

      @Internal @Nullable @Nullable ResultQuery<Record5<String,String,String,String,String>> comments(List<String> schemas)
      A query that produces comments for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Object name (e.g. table, view, function, package)
      4. Object sub name (e.g. column, package routine)
      5. Comment
      Returns:
      The query or null if this implementation doesn't support the query.

    • generators

      @Internal @Nullable @Nullable ResultQuery<Record6<String,String,String,String,String,String>> generators(List<String> schemas)
      A query that produces generator expressions for computed columns for a set of input schemas.

      The resulting columns are:

      1. Catalog name
      2. Schema name
      3. Table name
      4. Column name
      5. Generator expression as in
        invalid reference 
        DataType#generatedAlwaysAs()
      6. Generation option as in
        invalid reference 
        DataType#generationOption()
      Returns:
      The query or null if this implementation doesn't support the query.