Package com.northconcepts.datapipeline.foundations.jdbc

Class LoadTablesRequest

java.lang.Object
com.northconcepts.datapipeline.foundations.jdbc.LoadTablesRequest
public class LoadTablesRequest extends Object
The options for JdbcConnection.loadTables(LoadTablesRequest): which tables to load and which of their details (columns, keys, indexes) to load with them.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LoadTablesRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCatalog()
    Returns the catalog name passed to DatabaseMetaData.getTables; null (the default) does not filter by catalog.
    String
    getSchemaPattern()
    Returns the schema name pattern (% and _ wildcards); null (the default) does not filter by schema.
    String
    getTableNamePattern()
    Returns the table name pattern (% and _ wildcards); defaults to % for all tables.
    String[]
    getTypes()
    Returns the table types to load, such as TABLE or VIEW; null (the default) loads all types.
    boolean
    isLoadColumns()
    Indicates if each table's columns, primary key and row identifiers are loaded too, which also runs a SELECT returning no rows on each table (default is true).
    boolean
    isLoadExportedKeys()
    Indicates if the foreign keys referencing each table (exported keys) are loaded (default is true).
    boolean
    isLoadImportedKeys()
    Indicates if each table's foreign keys to other tables (imported keys) are loaded (default is true).
    boolean
    isLoadIndexes()
    Indicates if each table's indexes are loaded (default is true).
    LoadTablesRequest
    setCatalog(String catalog)
    Sets the catalog name passed to DatabaseMetaData.getTables; null (the default) does not filter by catalog.
    LoadTablesRequest
    setLoadColumns(boolean loadColumns)
    Indicates if each table's columns, primary key and row identifiers are loaded too, which also runs a SELECT returning no rows on each table (default is true).
    LoadTablesRequest
    setLoadExportedKeys(boolean loadExportedKeys)
    Indicates if the foreign keys referencing each table (exported keys) are loaded (default is true).
    LoadTablesRequest
    setLoadImportedKeys(boolean loadImportedKeys)
    Indicates if each table's foreign keys to other tables (imported keys) are loaded (default is true).
    LoadTablesRequest
    setLoadIndexes(boolean loadIndexes)
    Indicates if each table's indexes are loaded (default is true).
    LoadTablesRequest
    setSchemaPattern(String schemaPattern)
    Sets the schema name pattern (% and _ wildcards); null (the default) does not filter by schema.
    LoadTablesRequest
    setTableNamePattern(String tableNamePattern)
    Sets the table name pattern (% and _ wildcards); defaults to % for all tables.
    LoadTablesRequest
    setTypes(String... types)
    Sets the table types to load, such as TABLE or VIEW; null (the default) loads all types.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LoadTablesRequest

      public LoadTablesRequest()

  • Method Details

    • getCatalog

      public String getCatalog()
      Returns the catalog name passed to DatabaseMetaData.getTables; null (the default) does not filter by catalog.

    • setCatalog

      public LoadTablesRequest setCatalog(String catalog)
      Sets the catalog name passed to DatabaseMetaData.getTables; null (the default) does not filter by catalog.

    • getSchemaPattern

      public String getSchemaPattern()
      Returns the schema name pattern (% and _ wildcards); null (the default) does not filter by schema.

    • setSchemaPattern

      public LoadTablesRequest setSchemaPattern(String schemaPattern)
      Sets the schema name pattern (% and _ wildcards); null (the default) does not filter by schema.

    • getTableNamePattern

      public String getTableNamePattern()
      Returns the table name pattern (% and _ wildcards); defaults to % for all tables.

    • setTableNamePattern

      public LoadTablesRequest setTableNamePattern(String tableNamePattern)
      Sets the table name pattern (% and _ wildcards); defaults to % for all tables.

    • getTypes

      public String[] getTypes()
      Returns the table types to load, such as TABLE or VIEW; null (the default) loads all types.

    • setTypes

      public LoadTablesRequest setTypes(String... types)
      Sets the table types to load, such as TABLE or VIEW; null (the default) loads all types.

    • isLoadColumns

      public boolean isLoadColumns()
      Indicates if each table's columns, primary key and row identifiers are loaded too, which also runs a SELECT returning no rows on each table (default is true).

    • setLoadColumns

      public LoadTablesRequest setLoadColumns(boolean loadColumns)
      Indicates if each table's columns, primary key and row identifiers are loaded too, which also runs a SELECT returning no rows on each table (default is true).

    • isLoadImportedKeys

      public boolean isLoadImportedKeys()
      Indicates if each table's foreign keys to other tables (imported keys) are loaded (default is true).

    • setLoadImportedKeys

      public LoadTablesRequest setLoadImportedKeys(boolean loadImportedKeys)
      Indicates if each table's foreign keys to other tables (imported keys) are loaded (default is true).

    • isLoadExportedKeys

      public boolean isLoadExportedKeys()
      Indicates if the foreign keys referencing each table (exported keys) are loaded (default is true).

    • setLoadExportedKeys

      public LoadTablesRequest setLoadExportedKeys(boolean loadExportedKeys)
      Indicates if the foreign keys referencing each table (exported keys) are loaded (default is true).

    • isLoadIndexes

      public boolean isLoadIndexes()
      Indicates if each table's indexes are loaded (default is true).

    • setLoadIndexes

      public LoadTablesRequest setLoadIndexes(boolean loadIndexes)
      Indicates if each table's indexes are loaded (default is true).