public interface QueryMetadataInterface
Modifier and Type | Field and Description |
---|---|
static int |
UNKNOWN_CARDINALITY
Unknown cardinality.
|
Modifier and Type | Method and Description |
---|---|
Object |
addToMetadataCache(Object metadataID,
String key,
Object value) |
boolean |
elementSupports(Object elementID,
int elementConstant)
Determine whether the specified element supports some feature.
|
boolean |
findShortName() |
Collection |
getAccessPatternsInGroup(Object groupID)
Get the access patterns for the specified group
|
byte[] |
getBinaryVDBResource(String resourcePath)
Gets the contents of a VDB resource in binary form.
|
float |
getCardinality(Object groupID)
Return the cardinality for this group
|
String |
getCharacterVDBResource(String resourcePath)
Gets the contents of a VDB resource as a String.
|
Class<?> |
getDataTypeClass(String typeOrDomainName)
Get the runtime type class for the given type name, which may include domains
|
String |
getDefaultValue(Object elementID)
Get the element's default value for an element symbol
|
String |
getDeletePlan(Object groupID)
Get procedure defining the delete plan for this group.
|
QueryMetadataInterface |
getDesignTimeMetadata()
Get the metadata without visibility and session tables
|
float |
getDistinctValues(Object elementID)
Get the number of distinct values for this column.
|
Object |
getElementID(String elementName)
Get the metadata-implementation identifier object for the given element name.
|
List |
getElementIDsInAccessPattern(Object accessPattern)
Get the elements in the access pattern
|
List |
getElementIDsInGroupID(Object groupID)
Get list of metadata element IDs for a group ID
|
List |
getElementIDsInIndex(Object index)
Get the elements in the index
|
List |
getElementIDsInKey(Object key)
Get the elements in the key
|
int |
getElementLength(Object elementID)
Get the element length for a given element ID.
|
String |
getElementRuntimeTypeName(Object elementID)
Get the element type name for an element symbol.
|
Properties |
getExtensionProperties(Object metadataID)
Get all extension properties defined on this metadata object
|
String |
getExtensionProperty(Object metadataID,
String key,
boolean checkUnqualified) |
Collection |
getForeignKeysInGroup(Object groupID)
Get the foreign keys for the specified group
|
String |
getFormat(Object elementID)
Get the element's format
|
Object |
getFromMetadataCache(Object metadataID,
String key) |
String |
getFullName(Object metadataID)
Get the fully qualified (unique) name of the metadata identifier specified.
|
Map<Expression,Integer> |
getFunctionBasedExpressions(Object metadataID) |
FunctionLibrary |
getFunctionLibrary() |
Object |
getGroupID(String groupName)
Get the metadata-implementation identifier object for the given group name.
|
Object |
getGroupIDForElementID(Object elementID)
Get containg group ID given element ID
|
Collection |
getGroupsForPartialName(String partialGroupName)
Get a collection of group names that match the partially qualified group name.
|
Set<String> |
getImportedModels() |
Collection |
getIndexesInGroup(Object groupID)
Get the indexes for the specified group
|
String |
getInsertPlan(Object groupID)
Get procedure defining the insert plan for this group.
|
Object |
getMaterialization(Object groupID)
Accquire the physical group ID (the Materialization) for the given virtual
group ID, or
null if the given virtual group has no Materialization. |
Object |
getMaterializationStage(Object groupID)
Accquire the physical group ID that is used for the staging area for loading
(the Materialization) for the given virtual group ID, or
null
if the given virtual group has no Materialization. |
Object |
getMaximumValue(Object elementID)
Get the element's default value for an element symbol
|
int |
getMaxSetSize(Object modelID)
Get the max set size for the specified model.
|
Object |
getMinimumValue(Object elementID)
Get the element's minimum value for an element symbol
|
Object |
getModelID(Object groupOrElementID)
Get the metadata-implementation identifier object for the model containing the
specified group or element ID.
|
Object |
getModelID(String modelName) |
String |
getName(Object metadataID)
Get the name of the metadata identifier specified.
|
String |
getNameInSource(Object metadataID)
Get the name in source of the metadata identifier specified.
|
String |
getNativeType(Object elementID)
Get the native type of the element specified.
|
float |
getNullValues(Object elementID)
Get the number of distinct values for this column.
|
int |
getPosition(Object elementID)
Get the element's position in the group
|
int |
getPrecision(Object elementID)
Get the element's precision
|
Object |
getPrimaryKey(Object metadataID) |
Object |
getPrimaryKeyIDForForeignKeyID(Object foreignKeyID)
Get the corresponding primary key ID for the specified foreign
key ID
|
int |
getRadix(Object elementID)
Get the element's radix
|
int |
getScale(Object elementID)
Get the element's scale
|
ScriptEngine |
getScriptEngine(String langauge) |
QueryMetadataInterface |
getSessionMetadata() |
StoredProcedureInfo |
getStoredProcedureInfoForProcedure(String fullyQualifiedProcedureName)
Get the the StoredProcedureInfo based on the fully qualified procedure name
|
Collection |
getUniqueKeysInGroup(Object groupID)
Get the unique keys for the specified group (primary and unique keys)
The primary key if present will be first in the collection
|
String |
getUpdatePlan(Object groupID)
Get procedure defining the update plan for this group.
|
String[] |
getVDBResourcePaths()
Gets the resource paths of all the resources in the VDB.
|
String |
getVirtualDatabaseName()
Get the currently connected virtual database name.
|
QueryNode |
getVirtualPlan(Object groupID)
Get virtual plan for a group symbol.
|
boolean |
groupSupports(Object groupID,
int groupConstant)
Determine whether the specified group supports some feature.
|
boolean |
hasMaterialization(Object groupID)
Determine whether given virtual group has an associated Materialization.
|
boolean |
hasProcedure(String name)
Return true if a procedure exists with the given name (partial or fqn)
|
boolean |
isEnvAllowed() |
boolean |
isLongRanks() |
boolean |
isMultiSource(Object modelId) |
boolean |
isMultiSourceElement(Object elementId) |
boolean |
isProcedure(Object groupID)
Determine whether this is a procedure
|
boolean |
isPseudo(Object elementId) |
boolean |
isScalarGroup(Object groupID) |
boolean |
isTemporaryTable(Object groupID)
Determine whether a group is a temporary table.
|
boolean |
isVariadic(Object metadataID) |
boolean |
isVirtualGroup(Object groupID)
Determine whether a group is virtual or not.
|
boolean |
isVirtualModel(Object modelID)
Determine whether a model is virtual or not.
|
boolean |
modelSupports(Object modelID,
int modelConstant)
Determine whether the specified model supports some feature.
|
boolean |
useOutputName() |
boolean |
widenComparisonToString() |
static final int UNKNOWN_CARDINALITY
Object getElementID(String elementName) throws TeiidComponentException, QueryMetadataException
elementName
- Fully qualified element nameQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getGroupID(String groupName) throws TeiidComponentException, QueryMetadataException
groupName
- Fully qualified group nameQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getModelID(String modelName) throws TeiidComponentException, QueryMetadataException
Collection getGroupsForPartialName(String partialGroupName) throws TeiidComponentException, QueryMetadataException
partialGroupName
- Partially qualified group nameQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getModelID(Object groupOrElementID) throws TeiidComponentException, QueryMetadataException
groupOrElementID
- Metadata group or element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getFullName(Object metadataID) throws TeiidComponentException, QueryMetadataException
metadataID
- Metadata identifierQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getName(Object metadataID) throws TeiidComponentException, QueryMetadataException
metadataID
- Metadata identifierQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestList getElementIDsInGroupID(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Group IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getGroupIDForElementID(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- Element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestStoredProcedureInfo getStoredProcedureInfoForProcedure(String fullyQualifiedProcedureName) throws TeiidComponentException, QueryMetadataException
fullyQualifiedProcedureName
- the fully qualified stored procedure nameQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getElementRuntimeTypeName(Object elementID) throws TeiidComponentException, QueryMetadataException
DataTypeManager.DefaultDataTypes
.symbol
- The element symbolQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getDefaultValue(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getMinimumValue(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getMaximumValue(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getPosition(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getPrecision(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getScale(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getRadix(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getFormat(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestfloat getDistinctValues(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestfloat getNullValues(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean isVirtualGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
symbol
- Group symbolQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean isVirtualModel(Object modelID) throws TeiidComponentException, QueryMetadataException
symbol
- model symbolQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestQueryNode getVirtualPlan(Object groupID) throws TeiidComponentException, QueryMetadataException
symbol
- GroupTeiidComponentException
QueryMetadataException
String getInsertPlan(Object groupID) throws TeiidComponentException, QueryMetadataException
symbol
- GroupTeiidComponentException
QueryMetadataException
String getUpdatePlan(Object groupID) throws TeiidComponentException, QueryMetadataException
symbol
- GroupTeiidComponentException
QueryMetadataException
String getDeletePlan(Object groupID) throws TeiidComponentException, QueryMetadataException
symbol
- GroupTeiidComponentException
QueryMetadataException
boolean modelSupports(Object modelID, int modelConstant) throws TeiidComponentException, QueryMetadataException
modelID
- Metadata identifier specifying the modelmodelConstant
- Constant from SupportConstants.Model
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean groupSupports(Object groupID, int groupConstant) throws TeiidComponentException, QueryMetadataException
groupID
- Group metadata IDgroupConstant
- Constant from SupportConstants.Group
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean elementSupports(Object elementID, int elementConstant) throws TeiidComponentException, QueryMetadataException
elementID
- Element metadata IDelementConstant
- Constant from SupportConstants.Element
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestProperties getExtensionProperties(Object metadataID) throws TeiidComponentException, QueryMetadataException
metadataID
- Typically element, group, model, or procedureQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getMaxSetSize(Object modelID) throws TeiidComponentException, QueryMetadataException
modelID
- Metadata identifier specifying modelQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestCollection getIndexesInGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Metadata identifier specifying groupQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestCollection getUniqueKeysInGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Metadata identifier specifying groupQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestCollection getForeignKeysInGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Metadata identifier specifying groupQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getPrimaryKeyIDForForeignKeyID(Object foreignKeyID) throws TeiidComponentException, QueryMetadataException
foreignKeyID
- Metadata identifier of a foreign keyQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestCollection getAccessPatternsInGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Metadata identifier specifying groupQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestList getElementIDsInIndex(Object index) throws TeiidComponentException, QueryMetadataException
index
- Index identifier, as returned by getIndexesInGroup(java.lang.Object)
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestList getElementIDsInKey(Object key) throws TeiidComponentException, QueryMetadataException
key
- Key identifier, as returned by getUniqueKeysInGroup(java.lang.Object)
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestList getElementIDsInAccessPattern(Object accessPattern) throws TeiidComponentException, QueryMetadataException
accessPattern
- access pattern identifier, as returned by getAccessPatternsInGroup(java.lang.Object)
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString getVirtualDatabaseName() throws TeiidComponentException, QueryMetadataException
QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestfloat getCardinality(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Metadata identifier specifying groupTeiidComponentException
QueryMetadataException
String getNameInSource(Object metadataID) throws TeiidComponentException, QueryMetadataException
metadataID
- Metadata identifierQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestint getElementLength(Object elementID) throws TeiidComponentException, QueryMetadataException
DataTypeManager.DefaultDataTypes
.elementID
- The element IDQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean hasMaterialization(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- the groupID of the virtual group in question.QueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestObject getMaterialization(Object groupID) throws TeiidComponentException, QueryMetadataException
null
if the given virtual group has no Materialization.groupID
- the groupID of a virtual group that has a Materialization.TeiidComponentException
- Unexpected internal system problem during requestQueryMetadataException
- Metadata implementation detected a problem during the requestObject getMaterializationStage(Object groupID) throws TeiidComponentException, QueryMetadataException
null
if the given virtual group has no Materialization.groupID
- the groupID of a virtual group that has a Materialization.TeiidComponentException
- Unexpected internal system problem during requestQueryMetadataException
- Metadata implementation detected a problem during the requestString getNativeType(Object elementID) throws TeiidComponentException, QueryMetadataException
elementID
- Element identifierQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestboolean isProcedure(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Group identifierQueryMetadataException
- Metadata implementation detected a problem during the requestTeiidComponentException
- Unexpected internal system problem during requestString[] getVDBResourcePaths() throws TeiidComponentException, QueryMetadataException
TeiidComponentException
- Unexpected internal system problem during requestQueryMetadataException
- Metadata implementation detected a problem during the requestString getCharacterVDBResource(String resourcePath) throws TeiidComponentException, QueryMetadataException
resourcePath
- a path returned by getVDBResourcePaths()TeiidComponentException
- Unexpected internal system problem during requestQueryMetadataException
- Metadata implementation detected a problem during the requestbyte[] getBinaryVDBResource(String resourcePath) throws TeiidComponentException, QueryMetadataException
resourcePath
- a path returned by getVDBResourcePaths()TeiidComponentException
- Unexpected internal system problem during requestQueryMetadataException
- Metadata implementation detected a problem during the requestboolean isTemporaryTable(Object groupID) throws TeiidComponentException, QueryMetadataException
groupID
- Group to checkTeiidComponentException
QueryMetadataException
Object addToMetadataCache(Object metadataID, String key, Object value) throws TeiidComponentException, QueryMetadataException
Object getFromMetadataCache(Object metadataID, String key) throws TeiidComponentException, QueryMetadataException
boolean isScalarGroup(Object groupID) throws TeiidComponentException, QueryMetadataException
FunctionLibrary getFunctionLibrary()
ScriptEngine getScriptEngine(String langauge) throws TeiidProcessingException
langauge
- null is treated as the default of 'javascript'TeiidProcessingException
- if the ScriptEngine is requiredboolean isMultiSource(Object modelId) throws QueryMetadataException, TeiidComponentException
boolean isMultiSourceElement(Object elementId) throws QueryMetadataException, TeiidComponentException
QueryMetadataInterface getDesignTimeMetadata()
boolean hasProcedure(String name) throws TeiidComponentException
name
- TeiidComponentException
QueryMetadataInterface getSessionMetadata()
boolean isVariadic(Object metadataID)
Map<Expression,Integer> getFunctionBasedExpressions(Object metadataID)
boolean isPseudo(Object elementId)
String getExtensionProperty(Object metadataID, String key, boolean checkUnqualified)
boolean useOutputName()
boolean findShortName()
boolean widenComparisonToString()
Class<?> getDataTypeClass(String typeOrDomainName) throws QueryMetadataException
typeName
- QueryMetadataException
boolean isEnvAllowed()
boolean isLongRanks()
Copyright © 2019. All rights reserved.