Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.olap4j
Interface OlapDatabaseMetaData

All Superinterfaces:
DatabaseMetaData, OlapWrapper, Wrapper
public interface OlapDatabaseMetaData
extends 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
 ResultSet getActions(String catalog, String schemaPattern, String cubeNamePattern, String actionNamePattern)
          Retrieves a result set describing the Actions in this database.
 OlapConnection getConnection()
          
 ResultSet getCubes(String catalog, String schemaPattern, String cubeNamePattern)
          Retrieves a result set describing the Cubes in this database.
 ResultSet getDatabaseProperties(String dataSourceName, String propertyNamePattern)
          Retrieves a list of the standard and provider-specific properties supported by an olap4j provider.
 ResultSet getDatasources()
          Retrives a list of olap4j data sources that are available on the server.
 ResultSet getDimensions(String catalog, String schemaPattern, String cubeNamePattern, String dimensionNamePattern)
          Retrieves a result set describing the shared and private Dimensions in this database.
 ResultSet getHierarchies(String catalog, String schemaPattern, String cubeNamePattern, String dimensionNamePattern, String hierarchyNamePattern)
          Retrieves a result set describing the Hierarchies in this database.
 ResultSet getLevels(String catalog, String schemaPattern, String cubeNamePattern, String dimensionUniqueName, String hierarchyUniqueName, String levelNamePattern)
          Retrieves a result set describing the Levels in this database.
 ResultSet getLiterals()
          Retrieves a list of information on supported literals, including data types and values.
 String getMdxKeywords()
          Retrieves a comma-separated list of all of this database's MDX keywords.
 ResultSet getMeasures(String catalog, String schemaPattern, String cubeNamePattern, String measureNamePattern, String measureUniqueName)
          Retrieves a result set describing the Measures in this database.
 ResultSet getMembers(String catalog, String schemaPattern, String cubeNamePattern, String dimensionUniqueName, String hierarchyUniqueName, String levelUniqueName, String memberUniqueName, Set<Member.TreeOp> treeOps)
          Retrieves a result set describing the Members in this database.
 ResultSet getOlapFunctions(String functionNamePattern)
          Retrieves a result set describing the Functions available to client applications connected to the database.
 ResultSet getProperties(String catalog, String schemaPattern, String cubeNamePattern, String dimensionUniqueName, String hierarchyUniqueName, String levelUniqueName, String memberUniqueName, String propertyNamePattern)
          Retrieves a result set describing member and cell Properties.
 ResultSet getSets(String catalog, String schemaPattern, String cubeNamePattern, String setNamePattern)
          Retrieves a result set describing the named Sets in this database.
 
Methods inherited from interface java.sql.DatabaseMetaData
allProceduresAreCallable, allTablesAreSelectable, autoCommitFailureClosesAllResultSets, dataDefinitionCausesTransactionCommit, dataDefinitionIgnoredInTransactions, deletesAreDetected, doesMaxRowSizeIncludeBlobs, 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, getMaxProcedureNameLength, getMaxRowSize, getMaxSchemaNameLength, getMaxStatementLength, getMaxStatements, getMaxTableNameLength, getMaxTablesInSelect, getMaxUserNameLength, getNumericFunctions, getPrimaryKeys, getProcedureColumns, getProcedures, getProcedureTerm, 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, supportsResultSetConcurrency, supportsResultSetHoldability, supportsResultSetType, supportsSavepoints, supportsSchemasInDataManipulation, supportsSchemasInIndexDefinitions, supportsSchemasInPrivilegeDefinitions, supportsSchemasInProcedureCalls, supportsSchemasInTableDefinitions, supportsSelectForUpdate, supportsStatementPooling, supportsStoredFunctionsUsingCallSyntax, supportsStoredProcedures, supportsSubqueriesInComparisons, supportsSubqueriesInExists, supportsSubqueriesInIns, supportsSubqueriesInQuantifieds, supportsTableCorrelationNames, supportsTransactionIsolationLevel, supportsTransactions, supportsUnion, supportsUnionAll, updatesAreDetected, usesLocalFilePerTable, usesLocalFiles
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 
Methods inherited from interface org.olap4j.OlapWrapper
isWrapperFor, unwrap
 

Method Detail

getConnection

OlapConnection getConnection()
                             throws SQLException

Specified by:
getConnection in interface DatabaseMetaData
Throws:
SQLException

getActions

ResultSet getActions(String catalog,
                     String schemaPattern,
                     String cubeNamePattern,
                     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:

  • 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

    • Throws:
    OlapException - if a database access error occurs
    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
    See Also:
    DatabaseMetaData.getSearchStringEscape()

    getDatasources

    ResultSet getDatasources()
                         throws OlapException
    Retrives a list of olap4j data sources that are available on the server.

    Specification as for XML/A DISCOVER_DATASOURCES schema rowset.

    1. DATA_SOURCE_NAME String => The name of the data source, such as FoodMart 2000.
    2. DATA_SOURCE_DESCRIPTION String => A description of the data source, as entered by the publisher. (may be null)
    3. URL String => The unique path that shows where to invoke the XML for Analysis methods for that data source. (may be null)
    4. DATA_SOURCE_INFO String => A string containing any additional information required to connect to the data source. This can include the Initial Catalog property or other information for the provider.
      Example: "Provider=MSOLAP;Data Source=Local;" (may be null)
    5. PROVIDER_NAME String => The name of the provider behind the data source.
      Example: "MSDASQL" (may be null)
    6. PROVIDER_TYPE EnumerationArray => The types of data supported by the provider. May include one or more of the following types. Example follows this table.
      TDP: tabular data provider.
      MDP: multidimensional data provider.
      DMP: data mining provider. A DMP provider implements the OLE DB for Data Mining specification.
    7. AUTHENTICATION_MODE EnumString => Specification of what type of security mode the data source uses. Values can be one of the following:
      Unauthenticated: no user ID or password needs to be sent.
      Authenticated: User ID and Password must be included in the information required for the connection.
      Integrated: the data source uses the underlying security to determine authorization, such as Integrated Security provided by Microsoft Internet Information Services (IIS).

    Throws:
    OlapException - if a database access error occurs
    Returns:
    a ResultSet object in which each row is a datasource description

    getLiterals

    ResultSet getLiterals()
                      throws OlapException
    Retrieves a list of information on supported literals, including data types and values.

    Specification as for XML/A DISCOVER_LITERALS schema rowset.

    1. LITERAL_NAME String => The name of the literal described in the row.
      Example: DBLITERAL_LIKE_PERCENT
    2. LITERAL_VALUE String (may be null) => Contains the actual literal value.
      Example, if LiteralName is DBLITERAL_LIKE_PERCENT and the percent character (%) is used to match zero or more characters in a LIKE clause, this column's value would be "%".
    3. LITERAL_INVALID_CHARS String (may be null) => The characters, in the literal, that are not valid.
      For example, if table names can contain anything other than a numeric character, this string would be "0123456789".
    4. LITERAL_INVALID_STARTING_CHARS String (may be null) => The characters that are not valid as the first character of the literal. If the literal can start with any valid character, this is null.
    5. LITERAL_MAX_LENGTH int (may be null) => The maximum number of characters in the literal. If there is no maximum or the maximum is unknown, the value is -1.

    Throws:
    OlapException - if a database access error occurs
    Returns:
    a ResultSet object in which each row is a literal description

    getDatabaseProperties

    ResultSet getDatabaseProperties(String dataSourceName,
                                String propertyNamePattern)
                                throws OlapException
    Retrieves a list of the standard and provider-specific properties supported by an olap4j provider. Properties that are not supported by a provider are not listed in the return result set.

    Specification as for XML/A DISCOVER_PROPERTIES schema rowset.

    Not to be confused with getProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String).

    1. PROPERTY_NAME String => The name of the property.
    2. PROPERTY_DESCRIPTION String => A localizable text description of the property.
    3. PROPERTY_TYPE String => The XML data type of the property.
    4. PROPERTY_ACCESS_TYPE EnumString => Access for the property. The value can be Read, Write, or ReadWrite.
    5. IS_REQUIRED Boolean => True if a property is required, false if it is not required.
    6. PROPERTY_VALUE String => The current value of the property.

    Throws:
    OlapException - if a database access error occurs
    Parameters:
    dataSourceName - Name of data source
    propertyNamePattern - an 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 the description of a database property
    See Also:
    DatabaseMetaData.getSearchStringEscape()

    getProperties

    ResultSet getProperties(String catalog,
                        String schemaPattern,
                        String cubeNamePattern,
                        String dimensionUniqueName,
                        String hierarchyUniqueName,
                        String levelUniqueName,
                        String memberUniqueName,
                        String propertyNamePattern)
                        throws OlapException
    Retrieves a result set describing member and cell Properties.

    Specification as for XML/A MDSCHEMA_PROPERTIES schema rowset.

    Not to be confused with getDatabaseProperties(String,String).

  • 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 property belongs.
  • CUBE_NAME String => The name of the cube.
  • DIMENSION_UNIQUE_NAME String => The unique name of the dimension.
  • HIERARCHY_UNIQUE_NAME String => The unique name of the hierarchy.
  • LEVEL_UNIQUE_NAME String => The unique name of the level to which this property belongs.
  • MEMBER_UNIQUE_NAME String (may be null) => The unique name of the member to which the property belongs.
  • PROPERTY_NAME String => Name of the property.
  • PROPERTY_CAPTION String => A label or caption associated with the property, used primarily for display purposes.
  • PROPERTY_TYPE Short => A bitmap that specifies the type of the property
  • DATA_TYPE UnsignedShort => Data type of the property.
  • PROPERTY_CONTENT_TYPE Short (may be null) => The type of the property.
  • DESCRIPTION String (may be null) => A human-readable description of the measure.

    • Throws:
    OlapException - if a database access error occurs
    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
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Property

    getMdxKeywords

    String getMdxKeywords()
                      throws OlapException
    Retrieves a comma-separated list of all of this database's MDX keywords.

    Throws:
    OlapException - if a database access error occurs
    Returns:
    the list of this database's MDX keywords

    getCubes

    ResultSet getCubes(String catalog,
                   String schemaPattern,
                   String cubeNamePattern)
                   throws OlapException
    Retrieves a result set describing the Cubes in this database.

    Specification as for XML/A MDSCHEMA_CUBES schema rowset.

    Each cube description has the following columns:

    1. CATALOG_NAME String (may be null) => The name of the catalog to which this cube belongs.
    2. SCHEMA_NAME String (may be null) => The name of the schema to which this cube belongs.
    3. CUBE_NAME String => Name of the cube.
    4. CUBE_TYPE String => Cube type.
    5. CUBE_GUID UUID (may be null) => Cube type.
    6. CREATED_ON Timestamp (may be null) => Date and time of cube creation.
    7. LAST_SCHEMA_UPDATE Timestamp (may be null) => Date and time of last schema update.
    8. SCHEMA_UPDATED_BY String (may be null) => User ID of the person who last updated the schema.
    9. LAST_DATA_UPDATE Timestamp (may be null) => Date and time of last data update.
    10. DATA_UPDATED_BY String (may be null) => User ID of the person who last updated the data.
    11. IS_DRILLTHROUGH_ENABLED boolean => Describes whether DRILLTHROUGH can be performed on the members of a cube
    12. IS_WRITE_ENABLED boolean => Describes whether a cube is write-enabled
    13. IS_LINKABLE boolean => Describes whether a cube can be used in a linked cube
    14. IS_SQL_ENABLED boolean => Describes whether or not SQL can be used on the cube
    15. DESCRIPTION String (may be null) => A user-friendly description of the dimension.

    Throws:
    OlapException - if a database access error occurs
    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; null means that the cube name should not be used to narrow the search
    Returns:
    ResultSet in which each row is a cube description
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Cube

    getDimensions

    ResultSet getDimensions(String catalog,
                        String schemaPattern,
                        String cubeNamePattern,
                        String dimensionNamePattern)
                        throws OlapException
    Retrieves a result set describing the shared and private Dimensions in this database.

    Specification as for XML/A MDSCHEMA_DIMENSIONS schema rowset.

    Each dimension description has the following columns:

    1. CATALOG_NAME String (may be null) => The name of the database.
    2. SCHEMA_NAME String (may be null) => Not supported.
    3. CUBE_NAME String => The name of the cube.
    4. DIMENSION_NAME String => The name of the dimension.
    5. DIMENSION_UNIQUE_NAME String => The unique name of the dimension.
    6. DIMENSION_GUID String (may be null) => Not supported.
    7. DIMENSION_CAPTION String => The caption of the dimension.
    8. DIMENSION_ORDINAL int => The position of the dimension within the cube.
    9. DIMENSION_TYPE Short => The type of the dimension.
    10. DIMENSION_CARDINALITY int => The number of members in the key attribute.
    11. DEFAULT_HIERARCHY String => A hierarchy from the dimension. Preserved for backwards compatibility.
    12. DESCRIPTION String (may be null) => A user-friendly description of the dimension.
    13. IS_VIRTUAL boolean (may be null) => Always FALSE.
    14. IS_READWRITE boolean (may be null) => A Boolean that indicates whether the dimension is write-enabled.
    15. DIMENSION_UNIQUE_SETTINGS int (may be null) => A bitmap that specifies which columns contain unique values if the dimension contains only members with unique names.
    16. DIMENSION_MASTER_UNIQUE_NAME String (may be null) => Always NULL.
    17. DIMENSION_IS_VISIBLE boolean (may be null) => Always TRUE.

    Throws:
    OlapException - if a database access error occurs
    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
    dimensionNamePattern - a dimension name 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
    Returns:
    a ResultSet object in which each row is a dimension description
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Dimension

    getOlapFunctions

    ResultSet getOlapFunctions(String functionNamePattern)
                           throws OlapException
    Retrieves a result set describing the Functions available to client applications connected to the database.

    Specification as for XML/A MDSCHEMA_FUNCTIONS schema rowset.

    Each function description has the following columns:

  • FUNCTION_NAME String => The name of the function.
  • DESCRIPTION String (may be null) => A description of the function.
  • PARAMETER_LIST String (may be null) => A comma delimited list of parameters.
  • RETURN_TYPE int => The VARTYPE of the return data type of the function.
  • ORIGIN int => The origin of the function: 1 for MDX functions. 2 for user-defined functions.
  • INTERFACE_NAME String => The name of the interface for user-defined functions
  • LIBRARY_NAME String (may be null) => The name of the type library for user-defined functions. NULL for MDX functions.
  • CAPTION String (may be null) => The display caption for the function.

    • Throws:
    OlapException - if a database access error occurs
    Parameters:
    functionNamePattern - a function name pattern; must match the function name as it is stored in the database; null means that the function name should not be used to narrow the search
    Returns:
    a ResultSet object in which each row is a function description
    See Also:
    DatabaseMetaData.getFunctions(String, String, String), DatabaseMetaData.getSearchStringEscape()

    getHierarchies

    ResultSet getHierarchies(String catalog,
                         String schemaPattern,
                         String cubeNamePattern,
                         String dimensionNamePattern,
                         String hierarchyNamePattern)
                         throws OlapException
    Retrieves a result set describing the Hierarchies in this database.

    Specification as for XML/A MDSCHEMA_HIERARCHIES schema rowset.

    Each hierarchy description has the following columns:

  • CATALOG_NAME String (may be null) => The name of the catalog to which this hierarchy belongs.
  • SCHEMA_NAME String (may be null) => Not supported
  • CUBE_NAME String => The name of the cube to which this hierarchy belongs.
  • DIMENSION_UNIQUE_NAME String => The unique name of the dimension to which this hierarchy belongs.
  • HIERARCHY_NAME String => The name of the hierarchy. Blank if there is only a single hierarchy in the dimension.
  • HIERARCHY_UNIQUE_NAME String => The unique name of the hierarchy.
  • HIERARCHY_GUID String (may be null) => Hierarchy GUID.
  • HIERARCHY_CAPTION String => A label or a caption associated with the hierarchy.
  • DIMENSION_TYPE Short => The type of the dimension.
  • HIERARCHY_CARDINALITY int => The number of members in the hierarchy.
  • DEFAULT_MEMBER String (may be null) => The default member for this hierarchy.
  • ALL_MEMBER String (may be null) => The member at the highest level of rollup in the hierarchy.
  • DESCRIPTION String (may be null) => A human-readable description of the hierarchy. NULL if no description exists.
  • STRUCTURE Short => The structure of the hierarchy.
  • IS_VIRTUAL boolean => Always returns False.
  • IS_READWRITE boolean => A Boolean that indicates whether the Write Back to dimension column is enabled.
  • DIMENSION_UNIQUE_SETTINGS int => Always returns MDDIMENSIONS_MEMBER_KEY_UNIQUE (1).
  • DIMENSION_IS_VISIBLE boolean => Always returns true.
  • HIERARCHY_ORDINAL int => The ordinal number of the hierarchy across all hierarchies of the cube.
  • DIMENSION_IS_SHARED boolean => Always returns true.
  • PARENT_CHILD boolean (may be null) => Is hierarchy a parent.

    • Throws:
    OlapException - if a database access error occurs
    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
    dimensionNamePattern - a dimension name 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
    hierarchyNamePattern - a hierarchy name 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
    Returns:
    a ResultSet object in which each row is a hierarchy description
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Hierarchy

    getLevels

    ResultSet getLevels(String catalog,
                    String schemaPattern,
                    String cubeNamePattern,
                    String dimensionUniqueName,
                    String hierarchyUniqueName,
                    String levelNamePattern)
                    throws OlapException
    Retrieves a result set describing the Levels in this database.

    Specification as for XML/A MDSCHEMA_LEVELS schema rowset.

    Each level description has the following columns:

    1. CATALOG_NAME String (may be null) => The name of the catalog to which this level belongs.
    2. SCHEMA_NAME String (may be null) => The name of the schema to which this level belongs.
    3. CUBE_NAME String => The name of the cube to which this level belongs.
    4. DIMENSION_UNIQUE_NAME String => The unique name of the dimension to which this level belongs.
    5. HIERARCHY_UNIQUE_NAME String => The unique name of the hierarchy.
    6. LEVEL_NAME String => The name of the level.
    7. LEVEL_UNIQUE_NAME String => The properly escaped unique name of the level.
    8. LEVEL_GUID String (may be null) => Level GUID.
    9. LEVEL_CAPTION String => A label or caption associated with the hierarchy.
    10. LEVEL_NUMBER int => The distance of the level from the root of the hierarchy. Root level is zero (0).
    11. LEVEL_CARDINALITY int => The number of members in the level. This value can be an approximation of the real cardinality.
    12. LEVEL_TYPE int => Type of the level
    13. CUSTOM_ROLLUP_SETTINGS int => A bitmap that specifies the custom rollup options.
    14. LEVEL_UNIQUE_SETTINGS int => A bitmap that specifies which columns contain unique values, if the level only has members with unique names or keys.
    15. LEVEL_IS_VISIBLE boolean => A Boolean that indicates whether the level is visible.
    16. DESCRIPTION String (may be null) => A human-readable description of the level. NULL if no description exists.

    Throws:
    OlapException - if a database access error occurs
    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
    levelNamePattern - a level name 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
    Returns:
    a ResultSet object in which each row is a level description
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Level

    getMeasures

    ResultSet getMeasures(String catalog,
                      String schemaPattern,
                      String cubeNamePattern,
                      String measureNamePattern,
                      String measureUniqueName)
                      throws OlapException
    Retrieves a result set describing the Measures in this database.

    Specification as for XML/A MDSCHEMA_MEASURES schema rowset.

    Each measure description has the following columns:

    1. CATALOG_NAME String (may be null) => The name of the catalog to which this measure belongs.
    2. SCHEMA_NAME String (may be null) => The name of the schema to which this measure belongs.
    3. CUBE_NAME String => The name of the cube to which this measure belongs.
    4. MEASURE_NAME String => The name of the measure.
    5. MEASURE_UNIQUE_NAME String => The Unique name of the measure.
    6. MEASURE_CAPTION String => A label or caption associated with the measure.
    7. MEASURE_GUID String (may be null) => Measure GUID.
    8. MEASURE_AGGREGATOR int => How a measure was derived.
    9. DATA_TYPE UnsignedShort => Data type of the measure.
    10. MEASURE_IS_VISIBLE boolean => A Boolean that always returns True. If the measure is not visible, it will not be included in the schema rowset.
    11. LEVELS_LIST String (may be null) => A string that always returns NULL. EXCEPT that SQL Server returns non-null values!!!
    12. DESCRIPTION String (may be null) => A human-readable description of the measure.

    Throws:
    OlapException - if a database access error occurs
    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
    measureNamePattern - a measure name pattern; must match the measure name as it is stored in the database; null means that the measure name should not be used to narrow the search
    measureUniqueName - unique name of measure (not a pattern); null means that the measure unique name should not be used to narrow the search
    Returns:
    a ResultSet object in which each row is a measure description
    See Also:
    DatabaseMetaData.getSearchStringEscape(), Measure

    getMembers

    ResultSet getMembers(String catalog,
                     String schemaPattern,
                     String cubeNamePattern,
                     String dimensionUniqueName,
                     String hierarchyUniqueName,
                     String levelUniqueName,
                     String memberUniqueName,
                     Set<Member.TreeOp> treeOps)
                     throws OlapException
    Retrieves a result set describing the Members in this database.

    Specification as for XML/A MDSCHEMA_MEMBERS schema rowset. Rows are sorted by level number then by ordinal.

    The treeOps parameter allows you to retrieve members relative to a given member. It is only applicable if a memberUniqueName is also specified; otherwise it is ignored. The following example retrieves all descendants and ancestors of California, but not California itself: 

     OlapDatabaseMetaData metaData;
 ResultSet rset = metaData.getMembers(
     "LOCALDB", "FoodMart", "Sales", null, null, null,
     "[Customers].[USA].[CA]",
     EnumSet.of(Member.TreeOp.ANCESTORS, Member.TreeOp.DESCENDANTS));

    Each member description has the following columns:

    1. CATALOG_NAME String (may be null) => The name of the catalog to which this member belongs.
    2. SCHEMA_NAME String (may be null) => The name of the schema to which this member belongs.
    3. CUBE_NAME String => Name of the cube to which this member belongs.
    4. DIMENSION_UNIQUE_NAME String => Unique name of the dimension to which this member belongs.
    5. HIERARCHY_UNIQUE_NAME String => Unique name of the hierarchy. If the member belongs to more than one hierarchy, there is one row for each hierarchy to which it belongs.
    6. LEVEL_UNIQUE_NAME String => Unique name of the level to which the member belongs.
    7. LEVEL_NUMBER int => The distance of the member from the root of the hierarchy.
    8. MEMBER_ORDINAL int => Ordinal number of the member. Sort rank of the member when members of this dimension are sorted in their natural sort order. If providers do not have the concept of natural ordering, this should be the rank when sorted by MEMBER_NAME.
    9. MEMBER_NAME String => Name of the member.
    10. MEMBER_UNIQUE_NAME String => Unique name of the member.
    11. MEMBER_TYPE int => Type of the member.
    12. MEMBER_GUID String (may be null) => Memeber GUID.
    13. MEMBER_CAPTION String => A label or caption associated with the member.
    14. CHILDREN_CARDINALITY int => Number of children that the member has.
    15. PARENT_LEVEL int => The distance of the member's parent from the root level of the hierarchy.
    16. PARENT_UNIQUE_NAME String (may be null) => Unique name of the member's parent.
    17. PARENT_COUNT int => Number of parents that this member has.
    18. TREE_OP Enumeration (may be null) => Tree Operation
    19. DEPTH int (may be null) => depth

    Throws:
    OlapException - if a database access error occurs
    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 - uniqu