ild.h File Reference

#include <ilog/macros.h>

Classes
struct	IldBytes
	This structure is used to handle long binary data. More...

Enumerations
enum	IldADTType {   IldADTNone, IldADTArray, IldADTObject, IldADTTable,   IldADTList }
	This enumeration defines the typology of user-defined data types. More...
enum	IldColumnType
	This enumeration defines the typology for data stored in a database. More...
enum	IldEntityType {   IldUnknownEntity, IldTableEntity, IldViewEntity, IldADTEntity,   IldCallableEntity, IldSynonymEntity }
	The values of this enumeration distinguish the various schema entities that can be retrieved from the server. More...
enum	IldErrorOrigin { IldUnknownOrigin, IldDbLink, IldClientAPI, IldRDBMServer }
	The values of this enumeration indicate where the error originates from. More...
enum	IldFuncId {   ILD_D_START_TRANSACTION, ILD_D_COMMIT, ILD_D_ROLLBACK, ILD_D_AUTO_COMMIT_ON,   ILD_D_AUTO_COMMIT_OFF, ILD_D_SET_TRANSACTION_READONLY, ILD_D_FREE_NAMES, ILD_D_GET_FREE_REQUEST,   ILD_D_GET_NUM_ENTITIES, ILD_D_GET_RELATION, ILD_D_GET_PROCEDURE, ILD_D_GET_ADT,   ILD_D_GET_SYNONYM, ILD_D_GET_NUMBER_OF_ACTIVE_CONN, ILD_D_GET_NAME, ILD_D_GET_USER,   ILD_D_GET_DBMS_VERSIONS, ILD_D_GET_DBMS_VERSION, ILD_D_GET_DATABASE, ILD_D_GET_DBMS_SERVER,   ILD_D_CONNECT, ILD_D_DISCONNECT, ILD_D_IS_CONNECTED, ILD_D_IS_TRANSACTION_ENABLED,   ILD_D_GET_HOOK, ILD_D_SET_HOOK, ILD_D_READ_OWNERS, ILD_D_READ_ENTITY_NAMES,   ILD_D_READ_TABLE_PRIVILEGES, ILD_D_READ_RELATION_NAMES, ILD_D_READ_RELATION_OWNERS, ILD_D_READ_PROCEDURE_NAMES,   ILD_D_READ_ABSTRACT_TYPE_NAMES, ILD_D_READ_SYNONYM_NAMES, ILD_D_DBMS, ILD_D_TILDE_DBMS,   ILD_D_EXECUTE, ILD_D_GET_INFO, ILD_D_SET_REPORTER, ILD_D_GET_TYPE_INFO,   ILD_D_FREE_TYPE_INFO, ILD_D_READ_PKEY, ILD_D_READ_FKEYS, ILD_D_READ_INDEXES,   ILD_D_READ_SCOLS, ILD_D_SET_TIMEOUT, ILD_D_SET_ASYNC, ILD_D_SET_ERROR_REP,   ILD_D_CANCEL, ILD_D_REMOVE_ENTITY, ILD_D_SUBSCRIBE_EVENT, ILD_D_UNSUBSCRIBE_EVENT,   ILD_D_GET_ERROR_REPORTER, ILD_D_IS_COMPLETED, ILD_R_REQUEST, ILD_R_TILDE_REQUEST,   ILD_R_RELEASE, ILD_R_SET_COL_ARRAY_SIZE, ILD_R_REMOVE_COL_ARRAY_SIZE, ILD_R_SET_COL_POS,   ILD_R_SET_PARAM_ARRAY_SIZE, ILD_R_REMOVE_PARAM_ARRAY_SIZE, ILD_R_GET_COL_DESC, ILD_R_GET_COL_INDEX,   ILD_R_GET_COL_SIZE, ILD_R_GET_COL_NAME, ILD_R_GET_PARAM_DESC, ILD_R_GET_PARAM_INDEX,   ILD_R_GET_PARAM_NAME, ILD_R_GET_PARAM_TYPE, ILD_R_GET_PARAM_SQLTYPE, ILD_R_GET_PARAM_SQLTYPE_NAME,   ILD_R_GET_PARAM_SIZE, ILD_R_GET_PARAM_BUFFER_SIZE, ILD_R_BIND_COL, ILD_R_BIND_PARAM,   ILD_R_EXECUTE, ILD_R_FETCH, ILD_R_INSERT_LONGTEXT, ILD_R_INSERT_BINARY,   ILD_R_IS_COL_NULL, ILD_R_GET_COL_ADT, ILD_R_GET_COL_BINARY, ILD_R_GET_COL_BYTE,   ILD_R_GET_COL_DATE, ILD_R_GET_COL_DATETIME, ILD_R_GET_COL_INTEGER, ILD_R_GET_COL_LONGTEXT,   ILD_R_GET_COL_MONEY, ILD_R_GET_COL_NUMERIC, ILD_R_GET_COL_REAL, ILD_R_GET_COL_REF,   ILD_R_GET_COL_STRING, ILD_R_PARSE, ILD_R_SET_PARAM_VALUE, ILD_R_SET_PARAM_NULL,   ILD_R_IS_PARAM_NULL, ILD_R_GET_PARAM_ADT, ILD_R_GET_PARAM_BINARY, ILD_R_GET_PARAM_BYTE,   ILD_R_GET_PARAM_CURSOR, ILD_R_GET_PARAM_DATE, ILD_R_GET_PARAM_DATETIME, ILD_R_GET_PARAM_INTEGER,   ILD_R_GET_PARAM_LONGTEXT, ILD_R_GET_PARAM_MONEY, ILD_R_GET_PARAM_NUMERIC, ILD_R_GET_PARAM_REAL,   ILD_R_GET_PARAM_REF, ILD_R_GET_PARAM_STRING, ILD_R_IS_NULL_INDICATOR_ON, ILD_R_HAS_TUPLE,   ILD_R_GET_STATUS, ILD_R_GET_HOOK, ILD_R_GET_LARGE_OBJECT, ILD_R_CLOSE_CURSOR,   ILD_R_SET_REPORTER, ILD_R_SET_CURSOR_NAME, ILD_R_SET_READONLY, ILD_R_SET_CURSOR_MODE_ON,   ILD_R_SET_SCROLLABLE, ILD_R_FETCH_SCROLL, ILD_R_GET_ERROR_REPORTER, ILD_R_IS_COMPLETED }
	This enumeration gives an identifier to each function of the DB Link API. It is used in error handling to identify the function in which the error occurred. More...
enum	IldKeyType { IldPrimaryKey, IldForeignKey, IldIndexKey, IldSpecialColumn }
	The values of this enumeration indicate the type of the IldKey objects. More...

Detailed Description

Declaration of various data types, constants, and so forth.

Enumeration Type Documentation

enum IldADTType

This enumeration defines the typology of user-defined data types.

These types are also called abstract data types.

See Also

IldADTDescriptor, IldADTValue

Enumerator
IldADTNone	This value must never appear in application code nor be returned by any DB Link function.
IldADTArray	Identifies the related value as an Oracle varray.
IldADTObject	Identifies the related value as either an Oracle object or an Informix named row or (unnamed) row.
IldADTTable	Identifies the related value as an Oracle nested table.
IldADTList	Identifies the related value as an Informix list, set, or multiset.

enum IldColumnType

This enumeration defines the typology for data stored in a database.

This type takes care of the various data types that the relation columns in the various database management systems can store. DB Link uses the symbols in this enumeration whenever the data type of a column can be requested, whether in a table description, in a result set, or in a parameter set.

Each symbol in the enumeration is associated with a C++ data type, struct, or class.

Symbol	C++ Type, struct, or Class
IldByteType	IlUChar
IldIntegerType	IlInt
IldRealType	double
IldMoneyType	double
IldDateType	char*
IldDateTimeType	IldDateTime
IldNumericType	IlNumeric
IldStringType	char*
IldLongTextType	char*
IldBinaryType	IldBytes
IldObjectType	IldADTValue
IldCollectionType	IldADTValue
IldRefType	IldBytes
IldCursorType	IldRequest
IldCLOBType	char*
IldBLOBType	IlUChar*
IldDecfloatType	double

In particular, IldDateType is not different from IldDateTimeType with respect to the database types they handle. That is, both symbols handle such database types as DATE, TIME, DATETIME, TIMESTAMP, INTERVAL, and so on, depending on the RDBMS. However, IldDateType and IldDateTimeType differ semantically: IldDateType is used to retrieve or send date or time data as strings, whereas IldDateTimeType is used to retrieve or send date or time data as objects (as instances of the class IldDateTime).

A value is said to be of IldUnknownType if one of the following conditions is met:

• An internal DB Link error occurred, or
• The version of the RDBMS used is more recent than the one against which DB Link has been tested, and it introduces new data types.

See Also

IldBytes, IldDateTime, IldADTValue, IlNumeric, IldRequest

enum IldEntityType

The values of this enumeration distinguish the various schema entities that can be retrieved from the server.

DB Link defines a schema entity as an object that can exist on its own in the database. This definition eliminates the objects whose existence depends on other objects. Thus, table keys (primary or foreign), indexes, and arguments in procedures are not schema entities because they depend on tables or procedures.

See Also

IldSchemaEntity

Enumerator
IldUnknownEntity	This value should never appear in application code. If found anywhere, it is an internal Db Link error.
IldTableEntity	The entity is a table.
IldViewEntity	The entity is a view.
IldADTEntity	The entity is an abstract data type.
IldCallableEntity	The entity is a procedure, function, or trigger.
IldSynonymEntity	The entity is a synonym.

enum IldErrorOrigin

The values of this enumeration indicate where the error originates from.

See Also

IldDiagnostic, IldErrorReporter

Enumerator
IldUnknownOrigin	Should never appear in diagnostics.
IldDbLink	The error comes from DB Link API.
IldClientAPI	The error comes from the API of the RDBMS.
IldRDBMServer	The error comes from the server of the RDBMS.

enum IldFuncId

This enumeration gives an identifier to each function of the DB Link API. It is used in error handling to identify the function in which the error occurred.

Enumerator
ILD_D_START_TRANSACTION	IldDbms::startTransaction
ILD_D_COMMIT	IldDbms::commit
ILD_D_ROLLBACK	IldDbms::rollback
ILD_D_AUTO_COMMIT_ON	IldDbms::autoCommitOn
ILD_D_AUTO_COMMIT_OFF	IldDbms::autoCommitOff
ILD_D_SET_TRANSACTION_READONLY	IldDbms::setTransactionReadOnly
ILD_D_FREE_NAMES	IldDbms::freeNames
ILD_D_GET_FREE_REQUEST	IldDbms::getFreeRequest
ILD_D_GET_NUM_ENTITIES	IldDbms::getNumberOfEntities
ILD_D_GET_RELATION	IldDbms::getRelation
ILD_D_GET_PROCEDURE	IldDbms::getProcedure
ILD_D_GET_ADT	IldDbms::getAbstractType
ILD_D_GET_SYNONYM	IldDbms::getSynonym
ILD_D_GET_NUMBER_OF_ACTIVE_CONN	IldDbms::getNumberOfActiveConnections
ILD_D_GET_NAME	IldDbms::getName
ILD_D_GET_USER	IldDbms::getUser
ILD_D_GET_DBMS_VERSIONS	IldDbms::getDbmsVersions
ILD_D_GET_DBMS_VERSION	IldDbms::getDbmsVersion
ILD_D_GET_DATABASE	IldDbms::getDatabase
ILD_D_GET_DBMS_SERVER	IldDbms::getDbmsServer
ILD_D_CONNECT	IldDbms::connect
ILD_D_DISCONNECT	IldDbms::disconnect
ILD_D_IS_CONNECTED	IldDbms::isConnected
ILD_D_IS_TRANSACTION_ENABLED	IldDbms::isTransactionEnabled
ILD_D_GET_HOOK	IldDbms::getHook
ILD_D_SET_HOOK	IldDbms::setHook
ILD_D_READ_OWNERS	IldDbms::readOwners
ILD_D_READ_ENTITY_NAMES	IldDbms::readEntityNames
ILD_D_READ_TABLE_PRIVILEGES	IldDbms::readTablePrivileges
ILD_D_READ_RELATION_NAMES	IldDbms::readRelationNames
ILD_D_READ_RELATION_OWNERS	IldDbms::readRelationOwners
ILD_D_READ_PROCEDURE_NAMES	IldDbms::readProcedureNames
ILD_D_READ_ABSTRACT_TYPE_NAMES	IldDbms::readAbstractTypeNames
ILD_D_READ_SYNONYM_NAMES	IldDbms::readSynonymNames
ILD_D_DBMS	IldDbmsModel::IldDbmsModel, IldNewDbms
ILD_D_TILDE_DBMS	IldDbms::~IldDbms
ILD_D_EXECUTE	IldDbms::execute
ILD_D_GET_INFO	IldDbms::getInfo
ILD_D_SET_REPORTER	IldDbms::setErrorReporter
ILD_D_GET_TYPE_INFO	IldDbms::getTypeInfo
ILD_D_FREE_TYPE_INFO	IldDbms::freeTypeInfo
ILD_D_READ_PKEY	IldDbms::readPrimaryKey
ILD_D_READ_FKEYS	IldDbms::readForeignKeys
ILD_D_READ_INDEXES	IldDbms::readIndexes
ILD_D_READ_SCOLS	IldDbms::readSpecialColumns
ILD_D_SET_TIMEOUT	IldDbms::setTimeOut
ILD_D_SET_ASYNC	IldDbms::setAsync
ILD_D_SET_ERROR_REP	IldDbms:setErrorReporter
ILD_D_CANCEL	IldDbms::cancel
ILD_D_REMOVE_ENTITY	IldDbms::removeEntity
ILD_D_SUBSCRIBE_EVENT	IldDbms::subscribeEvent
ILD_D_UNSUBSCRIBE_EVENT	IldDbms::unSubscribeEvent
ILD_D_GET_ERROR_REPORTER	IldDbms::getErrorReporter
ILD_D_IS_COMPLETED	IldDbms::isCompleted
ILD_R_REQUEST	IldRequest::IldRequest
ILD_R_TILDE_REQUEST	IldRequest::~IldRequest
ILD_R_RELEASE	IldRequest::release
ILD_R_SET_COL_ARRAY_SIZE	IldRequest::setColArraySize
ILD_R_REMOVE_COL_ARRAY_SIZE	IldRequest::removeColArraySize
ILD_R_SET_COL_POS	IldRequest::setColPos
ILD_R_SET_PARAM_ARRAY_SIZE	IldRequest::setParamArraySize
ILD_R_REMOVE_PARAM_ARRAY_SIZE	IldRequest::removeParamArraySize
ILD_R_GET_COL_DESC	IldRequest::getColDescriptor
ILD_R_GET_COL_INDEX	IldRequest::getColIndex
ILD_R_GET_COL_SIZE	IldRequest::getColSize
ILD_R_GET_COL_NAME	IldRequest::getColName
ILD_R_GET_PARAM_DESC	IldRequest::getParamDescriptor
ILD_R_GET_PARAM_INDEX	IldRequest::getParamIndex
ILD_R_GET_PARAM_NAME	IldRequest::getParamName
ILD_R_GET_PARAM_TYPE	IldRequest::getParamType
ILD_R_GET_PARAM_SQLTYPE	IldRequest::getParamSQLType
ILD_R_GET_PARAM_SQLTYPE_NAME	IldRequest::getParamSQLTypeName
ILD_R_GET_PARAM_SIZE	IldRequest::getParamSize
ILD_R_GET_PARAM_BUFFER_SIZE	IldRequest::getParamBufferSize
ILD_R_BIND_COL	IldRequest::bindCol
ILD_R_BIND_PARAM	IldRequest::bindParam
ILD_R_EXECUTE	IldRequest::execute
ILD_R_FETCH	IldRequest::fetch
ILD_R_INSERT_LONGTEXT	IldRequest::insertLongText
ILD_R_INSERT_BINARY	IldRequest::insertBinary
ILD_R_IS_COL_NULL	IldRequest::isColNull
ILD_R_GET_COL_ADT	IldRequest::getColADTValue
ILD_R_GET_COL_BINARY	IldRequest::getColBinaryValue
ILD_R_GET_COL_BYTE	IldRequest::getColByteValue
ILD_R_GET_COL_DATE	IldRequest::getColDateValue
ILD_R_GET_COL_DATETIME	IldRequest::getColDateTimeValue
ILD_R_GET_COL_INTEGER	IldRequest::getColIntegerValue
ILD_R_GET_COL_LONGTEXT	IldRequest::getColLongTextValue
ILD_R_GET_COL_MONEY	IldRequest::getColMoneyValue
ILD_R_GET_COL_NUMERIC	IldRequest::getColNumericValue
ILD_R_GET_COL_REAL	IldRequest::getColRealValue
ILD_R_GET_COL_REF	IldRequest::getColRefValue
ILD_R_GET_COL_STRING	IldRequest::getColStringValue
ILD_R_PARSE	IldRequest::parse
ILD_R_SET_PARAM_VALUE	IldRequest::setParamValue
ILD_R_SET_PARAM_NULL	IldRequest::setParamNullInd
ILD_R_IS_PARAM_NULL	IldRequest::isParamNull
ILD_R_GET_PARAM_ADT	IldRequest::getParamADTValue
ILD_R_GET_PARAM_BINARY	IldRequest::getParamBinaryValue
ILD_R_GET_PARAM_BYTE	IldRequest::getParamByteValue
ILD_R_GET_PARAM_CURSOR	IldRequest::getParamCursorValue
ILD_R_GET_PARAM_DATE	IldRequest::getParamDateValue
ILD_R_GET_PARAM_DATETIME	IldRequest::getParamDateTimeValue
ILD_R_GET_PARAM_INTEGER	IldRequest::getParamIntegerValue
ILD_R_GET_PARAM_LONGTEXT	IldRequest::getParamLongTextValue
ILD_R_GET_PARAM_MONEY	IldRequest::getParamMoneyValue
ILD_R_GET_PARAM_NUMERIC	IldRequest::getParamNumericValue
ILD_R_GET_PARAM_REAL	IldRequest::getParamRealValue
ILD_R_GET_PARAM_REF	IldRequest::getParamRefValue
ILD_R_GET_PARAM_STRING	IldRequest::getParamStringValue
ILD_R_IS_NULL_INDICATOR_ON	IldRequest::isNullIndicatorOn
ILD_R_HAS_TUPLE	IldRequest::hasTuple
ILD_R_GET_STATUS	IldRequest::getStatus
ILD_R_GET_HOOK	IldRequest::getHook
ILD_R_GET_LARGE_OBJECT	IldRequest::getLargeObject
ILD_R_CLOSE_CURSOR	IldRequest::closeCursor
ILD_R_SET_REPORTER	IldRequest::setErrorReporter
ILD_R_SET_CURSOR_NAME	IldRequest::setCursorName
ILD_R_SET_READONLY	IldRequest::setReadOnly
ILD_R_SET_CURSOR_MODE_ON	IldRequest::setCursorModeOn
ILD_R_SET_SCROLLABLE	IldRequest::setScrollable
ILD_R_FETCH_SCROLL	IldRequest::fetchScroll
ILD_R_GET_ERROR_REPORTER	IldRequest::getErrorReporter
ILD_R_IS_COMPLETED	IldRequest::isCompleted

enum IldKeyType

The values of this enumeration indicate the type of the IldKey objects.

See Also

IldKey, IldFKey, IldTableIndex, IldRelation

Enumerator
IldPrimaryKey	It is a primary key.
IldForeignKey	It is a foreign key.
IldIndexKey	It is an index.
IldSpecialColumn	It is a special column.