Package com.databricks.jdbc.dbclient

Interface IDatabricksMetadataClient

    • Method Detail

      • listSchemas

        DatabricksResultSet listSchemas​(IDatabricksSession session,
                                String catalog,
                                String schemaNamePattern)
                         throws SQLException
        Returns the list of schemas
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schemaNamePattern - must match to schema name in database (can be a regex pattern or absolute name)
        Returns:
        a DatabricksResultSet representing list of schemas
        Throws:
        SQLException

      • listTables

        DatabricksResultSet listTables​(IDatabricksSession session,
                               String catalog,
                               String schemaNamePattern,
                               String tableNamePattern,
                               String[] tableTypes)
                        throws SQLException
        Returns the list of tables
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schemaNamePattern - must match to schema name in database (can be a regex pattern or absolute name)
        tableNamePattern - must match to table name in database (can be a regex pattern or absolute name)
        Returns:
        a DatabricksResultSet representing list of tables
        Throws:
        SQLException

      • listColumns

        DatabricksResultSet listColumns​(IDatabricksSession session,
                                String catalog,
                                String schemaNamePattern,
                                String tableNamePattern,
                                String columnNamePattern)
                         throws SQLException
        Returns the list of columns
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schemaNamePattern - must match to schema name in database (can be a regex pattern or absolute name)
        tableNamePattern - must match to table name in database (can be a regex pattern or absolute name)
        columnNamePattern - must match to column name in database (can be a regex pattern or absolute name)
        Returns:
        a DatabricksResultSet representing list of columns
        Throws:
        SQLException

      • listFunctions

        DatabricksResultSet listFunctions​(IDatabricksSession session,
                                  String catalog,
                                  String schemaNamePattern,
                                  String functionNamePattern)
                           throws SQLException
        Returns the list of functions
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schemaNamePattern - must match to schema name in database (can be a regex pattern or absolute name)
        functionNamePattern - must match to function name in database (can be a regex pattern or absolute name)
        Returns:
        a DatabricksResultSet representing list of functions
        Throws:
        SQLException

      • listPrimaryKeys

        DatabricksResultSet listPrimaryKeys​(IDatabricksSession session,
                                    String catalog,
                                    String schema,
                                    String table)
                             throws SQLException
        Returns the list of primary keys
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schema - must match to a schema in database
        table - must match to a table in database
        Returns:
        a DatabricksResultSet representing list of functions
        Throws:
        SQLException

      • listImportedKeys

        DatabricksResultSet listImportedKeys​(IDatabricksSession session,
                                     String catalog,
                                     String schema,
                                     String table)
                              throws SQLException
        Returns the list of imported keys
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schema - must match to a schema in database
        table - must match to a table in database
        Returns:
        a DatabricksResultSet representing list of imported keys
        Throws:
        SQLException

      • listExportedKeys

        DatabricksResultSet listExportedKeys​(IDatabricksSession session,
                                     String catalog,
                                     String schema,
                                     String table)
                              throws SQLException
        Returns the list of imported keys
        Parameters:
        session - underlying session
        catalog - catalogName which must match to catalog in database
        schema - must match to a schema in database
        table - must match to a table in database
        Returns:
        a DatabricksResultSet representing list of imported keys
        Throws:
        SQLException

      • listCrossReferences

        DatabricksResultSet listCrossReferences​(IDatabricksSession session,
                                        String parentCatalog,
                                        String parentSchema,
                                        String parentTable,
                                        String foreignCatalog,
                                        String foreignSchema,
                                        String foreignTable)
                                 throws SQLException
        Returns the list of cross references between a parent table and a foreign table
        Parameters:
        session - underlying session
        parentCatalog - catalogName which must match to catalog in database
        parentSchema - must match to a schema in database
        parentTable - must match to a table in database
        foreignCatalog - catalogName which must match to foreign catalog in database
        foreignSchema - must match to a foreign schema in database
        foreignTable - must match to a foreign table in database
        Returns:
        a DatabricksResultSet representing list of cross references
        Throws:
        SQLException