Package org.kie.workbench.common.screens.datasource.management.service

Interface DatabaseMetadataService

  • public interface DatabaseMetadataService
    Service for getting information about a database structure.

    • Method Detail

      • getMetadata

        DatabaseMetadata getMetadata​(String dataSourceUuid,
                             boolean includeCatalogs,
                             boolean includeSchemas)
        Gets the metadata for the database pointed by a given data source.
        Parameters:
        dataSourceUuid - A data source uuid.
        Returns:
        the metadata object for the given database.

      • findTables

        List<TableMetadata> findTables​(String dataSourceUuid,
                               String schema,
                               DatabaseMetadata.TableType... types)
        Gets a list of database objects metadata for a given database.
        Parameters:
        dataSourceUuid - A data source uuid.
        schema - A schema name for filtering. A null value will query all the available schemas.
        types - A list of database object types for filtering.
        Returns:
        A list of database objects fulfilling the filtering criteria.

      • findTables

        List<TableMetadata> findTables​(String dataSourceUuid,
                               String schema,
                               String tableNamePattern,
                               DatabaseMetadata.TableType... types)
        Gets a list of database objects metadata for a given database.
        Parameters:
        dataSourceUuid - A data source uuid.
        schema - A schema name for filtering. A null value will query all the available schemas.
        tableNamePattern - A table name pattern for filtering the database objects by name, e.g. %INVOICE_%.
        types - A list of database object types for filtering.
        Returns:
        A list of database objects fulfilling the filtering criteria.