Package org.olap4j

Interface OlapDatabaseMetaData

  • All Superinterfaces:
    java.sql.DatabaseMetaData, OlapWrapper, java.sql.Wrapper

    public interface OlapDatabaseMetaData
    extends java.sql.DatabaseMetaData, OlapWrapper
    Information about an OLAP database.

    Methods are provided to query the metadata catalog of the database. There is a method for each metadata class, and each method takes zero or more parameters to qualify the instances should be returned, and returns a JDBC ResultSet.

    For example, getCubes(java.lang.String, java.lang.String, java.lang.String) returns the description of a cube.

    Since:
    Oct 12, 2006
    Author:
    jhyde
    • Field Summary

      • Fields inherited from interface java.sql.DatabaseMetaData

        attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.sql.ResultSet getActions​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String actionNamePattern)
      Retrieves a result set describing the Actions in this database.
      OlapConnection getConnection()
      java.sql.ResultSet getCubes​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern)
      Retrieves a result set describing the Cubes in this database.
      java.sql.ResultSet getDatabaseProperties​(java.lang.String dataSourceName, java.lang.String propertyNamePattern)
      Retrieves a list of the standard and provider-specific properties supported by an olap4j provider.
      java.sql.ResultSet getDatabases()
      Retrieves a row set describing the databases that are available on the server.
      java.sql.ResultSet getDimensions​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionNamePattern)
      Retrieves a result set describing the shared and private Dimensions in this database.
      java.sql.ResultSet getHierarchies​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyNamePattern)
      Retrieves a result set describing the Hierarchies in this database.
      java.sql.ResultSet getLevels​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelNamePattern)
      Retrieves a result set describing the Levels in this database.
      java.sql.ResultSet getLiterals()
      Retrieves a list of information on supported literals, including data types and values.
      java.lang.String getMdxKeywords()
      Retrieves a comma-separated list of all of this database's MDX keywords.
      java.sql.ResultSet getMeasures​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String measureNamePattern, java.lang.String measureUniqueName)
      Retrieves a result set describing the Measures in this database.
      java.sql.ResultSet getMembers​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelUniqueName, java.lang.String memberUniqueName, java.util.Set<Member.TreeOp> treeOps)
      Retrieves a result set describing the Members in this database.
      java.sql.ResultSet getOlapFunctions​(java.lang.String functionNamePattern)
      Retrieves a result set describing the Functions available to client applications connected to the database.
      java.sql.ResultSet getProperties​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelUniqueName, java.lang.String memberUniqueName, java.lang.String propertyNamePattern)
      Retrieves a result set describing member and cell Properties.
      java.sql.ResultSet getSets​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String setNamePattern)
      Retrieves a result set describing the named Sets in this database.
      java.util.Set<CellSetListener.Granularity> getSupportedCellSetListenerGranularities()
      Returns the granularity of changes to cell sets that the database is capable of providing.
      • Methods inherited from interface java.sql.DatabaseMetaData

        allProceduresAreCallable, allTablesAreSelectable, autoCommitFailureClosesAllResultSets, dataDefinitionCausesTransactionCommit, dataDefinitionIgnoredInTransactions, deletesAreDetected, doesMaxRowSizeIncludeBlobs, generatedKeyAlwaysReturned, getAttributes, getBestRowIdentifier, getCatalogs, getCatalogSeparator, getCatalogTerm, getClientInfoProperties, getColumnPrivileges, getColumns, getCrossReference, getDatabaseMajorVersion, getDatabaseMinorVersion, getDatabaseProductName, getDatabaseProductVersion, getDefaultTransactionIsolation, getDriverMajorVersion, getDriverMinorVersion, getDriverName, getDriverVersion, getExportedKeys, getExtraNameCharacters, getFunctionColumns, getFunctions, getIdentifierQuoteString, getImportedKeys, getIndexInfo, getJDBCMajorVersion, getJDBCMinorVersion, getMaxBinaryLiteralLength, getMaxCatalogNameLength, getMaxCharLiteralLength, getMaxColumnNameLength, getMaxColumnsInGroupBy, getMaxColumnsInIndex, getMaxColumnsInOrderBy, getMaxColumnsInSelect, getMaxColumnsInTable, getMaxConnections, getMaxCursorNameLength, getMaxIndexLength, getMaxLogicalLobSize, getMaxProcedureNameLength, getMaxRowSize, getMaxSchemaNameLength, getMaxStatementLength, getMaxStatements, getMaxTableNameLength, getMaxTablesInSelect, getMaxUserNameLength, getNumericFunctions, getPrimaryKeys, getProcedureColumns, getProcedures, getProcedureTerm, getPseudoColumns, getResultSetHoldability, getRowIdLifetime, getSchemas, getSchemas, getSchemaTerm, getSearchStringEscape, getSQLKeywords, getSQLStateType, getStringFunctions, getSuperTables, getSuperTypes, getSystemFunctions, getTablePrivileges, getTables, getTableTypes, getTimeDateFunctions, getTypeInfo, getUDTs, getURL, getUserName, getVersionColumns, insertsAreDetected, isCatalogAtStart, isReadOnly, locatorsUpdateCopy, nullPlusNonNullIsNull, nullsAreSortedAtEnd, nullsAreSortedAtStart, nullsAreSortedHigh, nullsAreSortedLow, othersDeletesAreVisible, othersInsertsAreVisible, othersUpdatesAreVisible, ownDeletesAreVisible, ownInsertsAreVisible, ownUpdatesAreVisible, storesLowerCaseIdentifiers, storesLowerCaseQuotedIdentifiers, storesMixedCaseIdentifiers, storesMixedCaseQuotedIdentifiers, storesUpperCaseIdentifiers, storesUpperCaseQuotedIdentifiers, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsANSI92EntryLevelSQL, supportsANSI92FullSQL, supportsANSI92IntermediateSQL, supportsBatchUpdates, supportsCatalogsInDataManipulation, supportsCatalogsInIndexDefinitions, supportsCatalogsInPrivilegeDefinitions, supportsCatalogsInProcedureCalls, supportsCatalogsInTableDefinitions, supportsColumnAliasing, supportsConvert, supportsConvert, supportsCoreSQLGrammar, supportsCorrelatedSubqueries, supportsDataDefinitionAndDataManipulationTransactions, supportsDataManipulationTransactionsOnly, supportsDifferentTableCorrelationNames, supportsExpressionsInOrderBy, supportsExtendedSQLGrammar, supportsFullOuterJoins, supportsGetGeneratedKeys, supportsGroupBy, supportsGroupByBeyondSelect, supportsGroupByUnrelated, supportsIntegrityEnhancementFacility, supportsLikeEscapeClause, supportsLimitedOuterJoins, supportsMinimumSQLGrammar, supportsMixedCaseIdentifiers, supportsMixedCaseQuotedIdentifiers, supportsMultipleOpenResults, supportsMultipleResultSets, supportsMultipleTransactions, supportsNamedParameters, supportsNonNullableColumns, supportsOpenCursorsAcrossCommit, supportsOpenCursorsAcrossRollback, supportsOpenStatementsAcrossCommit, supportsOpenStatementsAcrossRollback, supportsOrderByUnrelated, supportsOuterJoins, supportsPositionedDelete, supportsPositionedUpdate, supportsRefCursors, supportsResultSetConcurrency, supportsResultSetHoldability, supportsResultSetType, supportsSavepoints, supportsSchemasInDataManipulation, supportsSchemasInIndexDefinitions, supportsSchemasInPrivilegeDefinitions, supportsSchemasInProcedureCalls, supportsSchemasInTableDefinitions, supportsSelectForUpdate, supportsSharding, supportsStatementPooling, supportsStoredFunctionsUsingCallSyntax, supportsStoredProcedures, supportsSubqueriesInComparisons, supportsSubqueriesInExists, supportsSubqueriesInIns, supportsSubqueriesInQuantifieds, supportsTableCorrelationNames, supportsTransactionIsolationLevel, supportsTransactions, supportsUnion, supportsUnionAll, updatesAreDetected, usesLocalFilePerTable, usesLocalFiles
      • Methods inherited from interface java.sql.Wrapper

        isWrapperFor, unwrap
    • Method Detail

      • getConnection

        OlapConnection getConnection()
                              throws java.sql.SQLException
        Specified by:
        getConnection in interface java.sql.DatabaseMetaData
        Throws:
        java.sql.SQLException
      • getSupportedCellSetListenerGranularities

        java.util.Set<CellSetListener.Granularity> getSupportedCellSetListenerGranularities()
                                                                                     throws OlapException
        Returns the granularity of changes to cell sets that the database is capable of providing.

        It's optional whether an olap4j provider supports cellset listeners, and also optional which granularities it supports. If the provider does not support the cell set listener API, returns an empty set. Never returns null.

        Returns:
        set of the granularities that are supported when listening for changes to a cell set, never null
        Throws:
        OlapException
      • getActions

        java.sql.ResultSet getActions​(java.lang.String catalog,
                                      java.lang.String schemaPattern,
                                      java.lang.String cubeNamePattern,
                                      java.lang.String actionNamePattern)
                               throws OlapException
        Retrieves a result set describing the Actions in this database.

        Specification as for XML/A MDSCHEMA_ACTIONS schema rowset.

        Each action description has the following columns:

      • CATALOG_NAME String (may be null) => The name of the database.
      • SCHEMA_NAME String (may be null) => The name of the schema to which this action belongs.
      • CUBE_NAME String => The name of the cube to which this action belongs.
      • ACTION_NAME String => The name of the action.
      • COORDINATE String => null
      • COORDINATE_TYPE int => null
Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
cubeNamePattern - a cube name pattern; must match the cube name as it is stored in the database; "" retrieves those without a cube (such as shared dimensions); null means that the cube name should not be used to narrow the search
actionNamePattern - an action name pattern; must match the action name as it is stored in the database; null means that the action name should not be used to narrow the search
Returns:
a ResultSet object in which each row is an action description
Throws:
OlapException - if a database access error occurs
See Also:
DatabaseMetaData.getSearchStringEscape()
Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
cubeNamePattern - a cube name pattern; must match the cube name as it is stored in the database; "" retrieves those without a cube; null means that the cube name should not be used to narrow the search
dimensionUniqueName - unique name of a dimension (not a pattern); must match the dimension name as it is stored in the database; null means that the dimension name should not be used to narrow the search
hierarchyUniqueName - unique name of a hierarchy (not a pattern); must match the hierarchy name as it is stored in the database; null means that the hierarchy name should not be used to narrow the search
levelUniqueName - unique name of a level (not a pattern); must match the level name as it is stored in the database; null means that the level name should not be used to narrow the search
memberUniqueName - unique name of member (not a pattern); null means that the member unique name should not be used to narrow the search
propertyNamePattern - a property name pattern; must match the property name as it is stored in the database; null means that the property name should not be used to narrow the search
Returns:
a ResultSet object in which each row is a description of a member or cell property
Throws:
OlapException - if a database access error occurs
See Also:
DatabaseMetaData.getSearchStringEscape(), Property