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 org.olap4j.OlapWrapper
isWrapperFor, unwrap
-
-
-
-
Method Detail
-
getConnection
OlapConnection getConnection() throws java.sql.SQLException
- Specified by:
getConnection
in interfacejava.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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchactionNamePattern
- 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()
- CATALOG_NAME String (may be
-
getDatabases
java.sql.ResultSet getDatabases() throws OlapException
Retrieves a row set describing the databases that are available on the server.Specification as for XML/A DISCOVER_DATASOURCES schema rowset.
- DATA_SOURCE_NAME String => The name of the data source, such as FoodMart 2000.
- DATA_SOURCE_DESCRIPTION String => A description of the data
source, as entered by the publisher. (may be
null
) - URL String => The unique path that shows where to invoke the
XML for Analysis methods for that data source. (may be
null
) - 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 benull
) - PROVIDER_NAME String => The name of the provider behind the
data source.
Example: "MSDASQL" (may benull
) - 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. - 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).
- Returns:
- a
ResultSet
object in which each row is an OLAP database description - Throws:
OlapException
- if a database access error occurs
-
getLiterals
java.sql.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.
- LITERAL_NAME String => The name of the literal described in
the row.
Example: DBLITERAL_LIKE_PERCENT - 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 "%". - 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". - 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. - 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.
- Returns:
- a
ResultSet
object in which each row is a literal description - Throws:
OlapException
- if a database access error occurs
- LITERAL_NAME String => The name of the literal described in
the row.
-
getDatabaseProperties
java.sql.ResultSet getDatabaseProperties(java.lang.String dataSourceName, java.lang.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)
.- PROPERTY_NAME String => The name of the property.
- PROPERTY_DESCRIPTION String => A localizable text description of the property.
- PROPERTY_TYPE String => The XML data type of the property.
- PROPERTY_ACCESS_TYPE EnumString => Access for the property. The value can be Read, Write, or ReadWrite.
- IS_REQUIRED Boolean => True if a property is required, false if it is not required.
- PROPERTY_VALUE String => The current value of the property.
- Parameters:
dataSourceName
- Name of data sourcepropertyNamePattern
- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
-
getProperties
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) 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.- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchdimensionUniqueName
- 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 searchhierarchyUniqueName
- 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 searchlevelUniqueName
- 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 searchmemberUniqueName
- unique name of member (not a pattern);null
means that the member unique name should not be used to narrow the searchpropertyNamePattern
- 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
- CATALOG_NAME String (may be
-
getMdxKeywords
java.lang.String getMdxKeywords() throws OlapException
Retrieves a comma-separated list of all of this database's MDX keywords.- Returns:
- the list of this database's MDX keywords
- Throws:
OlapException
- if a database access error occurs
-
getCubes
java.sql.ResultSet getCubes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.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:
- CATALOG_NAME String (may be
null
) => The name of the catalog to which this cube belongs. - SCHEMA_NAME String (may be
null
) => The name of the schema to which this cube belongs. - CUBE_NAME String => Name of the cube.
- CUBE_TYPE String => Cube type.
- CUBE_GUID UUID (may be
null
) => Cube type. - CREATED_ON Timestamp (may be
null
) => Date and time of cube creation. - LAST_SCHEMA_UPDATE Timestamp (may be
null
) => Date and time of last schema update. - SCHEMA_UPDATED_BY String (may be
null
) => User ID of the person who last updated the schema. - LAST_DATA_UPDATE Timestamp (may be
null
) => Date and time of last data update. - DATA_UPDATED_BY String (may be
null
) => User ID of the person who last updated the data. - IS_DRILLTHROUGH_ENABLED boolean => Describes whether DRILLTHROUGH can be performed on the members of a cube
- IS_WRITE_ENABLED boolean => Describes whether a cube is write-enabled
- IS_LINKABLE boolean => Describes whether a cube can be used in a linked cube
- IS_SQL_ENABLED boolean => Describes whether or not SQL can be used on the cube
- DESCRIPTION String (may be
null
) => A user-friendly description of the cube. - CUBE_CAPTION String (may be
null
) => The caption of the cube. - BASE_CUBE_NAME String (may be
null
) => The name of the source cube if this cube is a perspective cube.
- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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- Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Cube
- CATALOG_NAME String (may be
-
getDimensions
java.sql.ResultSet getDimensions(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.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:
- CATALOG_NAME String (may be
null
) => The name of the database. - SCHEMA_NAME String (may be
null
) => Not supported. - CUBE_NAME String => The name of the cube.
- DIMENSION_NAME String => The name of the dimension.
- DIMENSION_UNIQUE_NAME String => The unique name of the dimension.
- DIMENSION_GUID String (may be
null
) => Not supported. - DIMENSION_CAPTION String => The caption of the dimension.
- DIMENSION_ORDINAL int => The position of the dimension within the cube.
- DIMENSION_TYPE Short => The type of the dimension.
- DIMENSION_CARDINALITY int => The number of members in the key attribute.
- DEFAULT_HIERARCHY String => A hierarchy from the dimension. Preserved for backwards compatibility.
- DESCRIPTION String (may be
null
) => A user-friendly description of the dimension. - IS_VIRTUAL boolean (may be
null
) => Always FALSE. - IS_READWRITE boolean (may be
null
) => A Boolean that indicates whether the dimension is write-enabled. - 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. - DIMENSION_MASTER_UNIQUE_NAME String (may be
null
) => Always NULL. - DIMENSION_IS_VISIBLE boolean (may be
null
) => Always TRUE.
- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchdimensionNamePattern
- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Dimension
- CATALOG_NAME String (may be
-
getOlapFunctions
java.sql.ResultSet getOlapFunctions(java.lang.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.- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
-
getHierarchies
java.sql.ResultSet getHierarchies(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.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.- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchdimensionUniqueName
- 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 searchhierarchyNamePattern
- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Hierarchy
- CATALOG_NAME String (may be
-
getLevels
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) 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:
- CATALOG_NAME String (may be
null
) => The name of the catalog to which this level belongs. - SCHEMA_NAME String (may be
null
) => The name of the schema to which this level belongs. - CUBE_NAME String => The name of the cube to which this level belongs.
- DIMENSION_UNIQUE_NAME String => The unique name of the dimension to which this level belongs.
- HIERARCHY_UNIQUE_NAME String => The unique name of the hierarchy.
- LEVEL_NAME String => The name of the level.
- LEVEL_UNIQUE_NAME String => The properly escaped unique name of the level.
- LEVEL_GUID String (may be
null
) => Level GUID. - LEVEL_CAPTION String => A label or caption associated with the hierarchy.
- LEVEL_NUMBER int => The distance of the level from the root of the hierarchy. Root level is zero (0).
- LEVEL_CARDINALITY int => The number of members in the level. This value can be an approximation of the real cardinality.
- LEVEL_TYPE int => Type of the level
- CUSTOM_ROLLUP_SETTINGS int => A bitmap that specifies the custom rollup options.
- LEVEL_UNIQUE_SETTINGS int => A bitmap that specifies which columns contain unique values, if the level only has members with unique names or keys.
- LEVEL_IS_VISIBLE boolean => A Boolean that indicates whether the level is visible.
- DESCRIPTION String (may be
null
) => A human-readable description of the level. NULL if no description exists.
- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchdimensionUniqueName
- 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 searchhierarchyUniqueName
- 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 searchlevelNamePattern
- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Level
- CATALOG_NAME String (may be
-
getMeasures
java.sql.ResultSet getMeasures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String measureNamePattern, java.lang.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:
- CATALOG_NAME String (may be
null
) => The name of the catalog to which this measure belongs. - SCHEMA_NAME String (may be
null
) => The name of the schema to which this measure belongs. - CUBE_NAME String => The name of the cube to which this measure belongs.
- MEASURE_NAME String => The name of the measure.
- MEASURE_UNIQUE_NAME String => The Unique name of the measure.
- MEASURE_CAPTION String => A label or caption associated with the measure.
- MEASURE_GUID String (may be
null
) => Measure GUID. - MEASURE_AGGREGATOR int => How a measure was derived.
- DATA_TYPE UnsignedShort => Data type of the measure.
- 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.
- LEVELS_LIST String (may be
null
) => A string that always returns NULL. EXCEPT that SQL Server returns non-null values!!! - DESCRIPTION String (may be
null
) => A human-readable description of the measure.
- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchmeasureNamePattern
- 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 searchmeasureUniqueName
- 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 - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Measure
- CATALOG_NAME String (may be
-
getMembers
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) 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 amemberUniqueName
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:
- CATALOG_NAME String (may be
null
) => The name of the catalog to which this member belongs. - SCHEMA_NAME String (may be
null
) => The name of the schema to which this member belongs. - CUBE_NAME String => Name of the cube to which this member belongs.
- DIMENSION_UNIQUE_NAME String => Unique name of the dimension to which this member belongs.
- 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.
- LEVEL_UNIQUE_NAME String => Unique name of the level to which the member belongs.
- LEVEL_NUMBER int => The distance of the member from the root of the hierarchy.
- 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.
- MEMBER_NAME String => Name of the member.
- MEMBER_UNIQUE_NAME String => Unique name of the member.
- MEMBER_TYPE int => Type of the member.
- MEMBER_GUID String (may be
null
) => Memeber GUID. - MEMBER_CAPTION String => A label or caption associated with the member.
- CHILDREN_CARDINALITY int => Number of children that the member has.
- PARENT_LEVEL int => The distance of the member's parent from the root level of the hierarchy.
- PARENT_UNIQUE_NAME String (may be
null
) => Unique name of the member's parent. - PARENT_COUNT int => Number of parents that this member has.
- TREE_OP Enumeration (may be
null
) => Tree Operation - DEPTH int (may be
null
) => depth
- 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchdimensionUniqueName
- unique name of 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 searchhierarchyUniqueName
- unique name of 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 searchlevelUniqueName
- unique name of 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 searchmemberUniqueName
- unique name of member (not a pattern);null
means that the measure unique name should not be used to narrow the searchtreeOps
- set of tree operations to retrieve members relative to the member whose unique name was specified; or null to return just the member itself. Ignored ifmemberUniqueName
is not specified.- Returns:
- a
ResultSet
object in which each row is a member description - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,Member
- CATALOG_NAME String (may be
-
getSets
java.sql.ResultSet getSets(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String setNamePattern) throws OlapException
Retrieves a result set describing the named Sets in this database.Specification as for XML/A MDSCHEMA_SETS schema rowset.
Each set description has the following columns:
- CATALOG_NAME String (may be
null
) => null - SCHEMA_NAME String (may be
null
) => null - CUBE_NAME String => null
- SET_NAME String => null
- SCOPE 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 searchschemaPattern
- 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 searchcubeNamePattern
- 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 searchsetNamePattern
- pattern for the unique name of a set; must match the set name as it is stored in the database;null
means that the set name should not be used to narrow the search- Returns:
- a
ResultSet
object in which each row is a description of a named set - Throws:
OlapException
- if a database access error occurs- See Also:
DatabaseMetaData.getSearchStringEscape()
,NamedSet
- CATALOG_NAME String (may be
-
-