OleDbLiteral OleDbLiteral OleDbLiteral OleDbLiteral Enum

Definition

Returns information about literals used in text commands, data values, and database objects.

public enum class OleDbLiteral
public enum OleDbLiteral
type OleDbLiteral = 
Public Enum OleDbLiteral
Inheritance

Fields

Binary_Literal Binary_Literal Binary_Literal Binary_Literal 1

A binary literal in a text command. Maps to DBLITERAL_BINARY_LITERAL.

Catalog_Name Catalog_Name Catalog_Name Catalog_Name 2

A catalog name in a text command. Maps to DBLITERAL_CATALOG_NAME.

Catalog_Separator Catalog_Separator Catalog_Separator Catalog_Separator 3

The character that separates the catalog name from the rest of the identifier in a text command. Maps to DBLITERAL_CATALOG_SEPARATOR.

Char_Literal Char_Literal Char_Literal Char_Literal 4

A character literal in a text command. Maps to DBLITERAL_CHAR_LITERAL.

Column_Alias Column_Alias Column_Alias Column_Alias 5

A column alias in a text command. Maps to DBLITERAL_COLUMN_ALIAS.

Column_Name Column_Name Column_Name Column_Name 6

A column name used in a text command or in a data-definition interface. Maps to DBLITERAL_COLUMN_NAME.

Correlation_Name Correlation_Name Correlation_Name Correlation_Name 7

A correlation name (table alias) in a text command. Maps to DBLITERAL_CORRELATION_NAME.

Cube_Name Cube_Name Cube_Name Cube_Name 21

The name of a cube in a schema (or the catalog if the provider does not support schemas).

Cursor_Name Cursor_Name Cursor_Name Cursor_Name 8

A cursor name in a text command. Maps to DBLITERAL_CURSOR_NAME.

Dimension_Name Dimension_Name Dimension_Name Dimension_Name 22

The name of the dimension. If a dimension is part of more than one cube, there is one row for each cube/dimension combination.

Escape_Percent_Prefix Escape_Percent_Prefix Escape_Percent_Prefix Escape_Percent_Prefix 9

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_PERCENT literal. For example, if a percent sign (%) is used to match zero or more characters and this is a backslash (\), the characters "abc\%%" match all character values that start with "abc%". Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value. Maps to DBLITERAL_ESCAPE_PERCENT_PREFIX.

Escape_Percent_Suffix Escape_Percent_Suffix Escape_Percent_Suffix Escape_Percent_Suffix 29

The escape character, if any, used to suffix the character returned for the DBLITERAL_LIKE_PERCENT literal. For example, if a percent sign (%) is used to match zero or more characters and percent signs are escaped by enclosing in open and close square brackets, DBLITERAL_ESCAPE_PERCENT_PREFIX is "[", DBLITERAL_ESCAPE_PERCENT_SUFFIX is "]", and the characters "abc[%]%" match all character values that start with "abc%". Providers that do not use a suffix character to escape the DBLITERAL_ESCAPE_PERCENT character do not return this literal value and can set the lt member of the DBLITERAL structure to DBLITERAL_INVALID if requested. Maps to DBLITERAL_ESCAPE_PERCENT_SUFFIX.

Escape_Underscore_Prefix Escape_Underscore_Prefix Escape_Underscore_Prefix Escape_Underscore_Prefix 10

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_UNDERSCORE literal. For example, if an underscore (_) is used to match exactly one character and this is a backslash (\), the characters "abc\_ " match all character values that are five characters long and start with "abc\". Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value. Maps to DBLITERAL_ESCAPE_UNDERSCORE_PREFIX.

Escape_Underscore_Suffix Escape_Underscore_Suffix Escape_Underscore_Suffix Escape_Underscore_Suffix 30

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_UNDERSCORE literal. For example, if an underscore (_) is used to match exactly one character and this is a backslash (\), the characters "abc\_ " match all character values that are five characters long and start with "abc\". Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value. Maps to DBLITERAL_ESCAPE_UNDERSCORE_SUFFIX.

Hierarchy_Name Hierarchy_Name Hierarchy_Name Hierarchy_Name 23

The name of the hierarchy. If the dimension does not contain a hierarchy or has only one hierarchy, the current column contains a null value.

Index_Name Index_Name Index_Name Index_Name 11

An index name used in a text command or in a data-definition interface. Maps to DBLITERAL_INDEX_NAME.

Invalid Invalid Invalid Invalid 0

An invalid value. Maps to DBLITERAL_INVALID.

Level_Name Level_Name Level_Name Level_Name 24

Name of the cube to which the current level belongs.

Like_Percent Like_Percent Like_Percent Like_Percent 12

The character used in a LIKE clause to match zero or more characters. For example, if this is a percent sign (%), the characters "abc%" match all character values that start with "abc". Maps to DBLITERAL_LIKE_PERCENT.

Like_Underscore Like_Underscore Like_Underscore Like_Underscore 13

The character used in a LIKE clause to match exactly one character. For example, if this is an underscore (), the characters "abc\" match all character values that are four characters long and start with "abc". Maps to DBLITERAL_LIKE_UNDERSCORE.

Member_Name Member_Name Member_Name Member_Name 25

The name of the member.

Procedure_Name Procedure_Name Procedure_Name Procedure_Name 14

A procedure name in a text command. Maps to DBLITERAL_PROCEDURE_NAME.

Property_Name Property_Name Property_Name Property_Name 26

The name of the property.

Quote_Prefix Quote_Prefix Quote_Prefix Quote_Prefix 15

The character used in a text command as the opening quote for quoting identifiers that contain special characters. Maps to DBLITERAL_QUOTE_PREFIX.

Quote_Suffix Quote_Suffix Quote_Suffix Quote_Suffix 28

The character used in a text command as the closing quote for quoting identifiers that contain special characters. 1.x providers that use the same character as the prefix and suffix may not return this literal value and can set the member of the DBLITERAL structure to DBLITERAL_INVALID if requested. Maps to DBLITERAL_QUOTE_SUFFIX.

Schema_Name Schema_Name Schema_Name Schema_Name 16

A schema name in a text command. Maps to DBLITERAL_SCHEMA_NAME.

Schema_Separator Schema_Separator Schema_Separator Schema_Separator 27

The character that separates the schema name from the rest of the identifier in a text command. Maps to DBLITERAL_SCHEMA_SEPARATOR.

Table_Name Table_Name Table_Name Table_Name 17

A table name used in a text command or in a data-definition interface. Maps to DBLITERAL_TABLE_NAME.

Text_Command Text_Command Text_Command Text_Command 18

A text command, such as an SQL statement. Maps to DBLITERAL_TEXT_COMMAND.

User_Name User_Name User_Name User_Name 19

A user name in a text command. Maps to DBLITERAL_USER_NAME.

View_Name View_Name View_Name View_Name 20

A view name in a text command. Maps to DBLITERAL_VIEW_NAME.

Remarks

The OleDbLiteral enumeration returns the following categories of literal information.

Category Returns
A special character or characters used by text commands, such as the character used to quote identifiers. The character or characters.
A literal data value, such as a character literal in an SQL statement. The maximum length of the literal in characters, a list of the characters that cannot be used in the literal, and a list of the characters that cannot be used as the first character of the literal.
The name of a database object such as a column or table. The maximum length of the name in characters, a list of the characters that cannot be used in the name, and a list of the characters that cannot be used as the first character of the name.
Multidimensional restriction columns. Restriction values that return information about cubes, dimensions, hierarchies, levels, and members available from a data source; and are treated as literals instead of as search patterns.

Most members of the OleDbLiteral enumeration maps to one of the OLE DB DBLITERAL values that are returned in the DBLITERALINFO structure.

Multidimensional restriction columns are members of schema objects and map to OLE DB for OLAP used by the IDBSchemaRowset interface.

A NotSupportedException is generated if the specified literal information is not supported and cannot be returned.

Applies to