../E23174-03.epub /> ../E23174-03.mobi />

Oracle Data Provider for .NET Assembly

The Oracle.DataAccess.dll assembly provides two namespaces:

  • The Oracle.DataAccess.Client namespace contains ODP.NET classes and enumerations for the client-side provider.

  • The Oracle.DataAccess.Types namespace contains the Oracle Data Provider for .NET data types (ODP.NET Types).

Oracle.DataAccess.Client Namespace

The Oracle.DataAccess.Client namespace contains implementations of core ADO.NET classes and enumerations for ODP.NET, as well as ODP.NET specific classes.

The following tables list ODP.NET classes, enumerations, and types that are supported by the Oracle.DataAccess.Client namespace. The tables also indicated which classes are not supported in .NET stored procedures.

Oracle.DataAccess.Client

Table 1-1 lists the client classes.

Table 1-1 Oracle.DataAccess.Client

Class Description

OnChangeEventHandler Delegate

The OnChangedEventHandler event delegate represents the signature of the method that handles the notification.

Not Supported in a .NET Stored Procedure

OracleAQAgent Class

The OracleAQAgent class represents agents that may be senders or recipients of a message.

OracleAQDequeueOptions Class

An OracleAQDequeueOptions object represents the options available when dequeuing a message from an OracleAQQueue object.

OracleAQEnqueueOptions Class

The OracleAQEnqueueOptions class represents the options available when enqueuing a message to an OracleAQQueue.

OracleAQMessage Class

An OracleAQMessage object represents a message to be enqueued and dequeued.

OracleAQMessageAvailableEventArgs Class

The OracleAQMessageAvailableEventArgs class provides event data for the OracleAQQueue.MessageAvailable event.

OracleAQMessageAvailableEventHandler Delegate

The OracleAQMessageAvailableEventHandler delegate represents the signature of the method that handles the OracleAQQueue.MessageAvailable event.

OracleAQQueue Class

An OracleAQQueue object represents a queue.

OracleBulkCopy Class

An OracleBulkCopy object efficiently bulk loads or copies data into an Oracle table from another data source.

OracleBulkCopyColumnMapping Class

The OracleBulkCopyColumnMapping class defines the mapping between a column in the data source and a column in the destination database table.

OracleBulkCopyColumnMappingCollection Class

The OracleBulkCopyColumnMappingCollection class represents a collection of OracleBulkCopyColumnMapping objects that are used to map columns in the data source to columns in a destination table.

OracleClientFactory Class

An OracleClientFactory object allows applications to instantiate ODP.NET classes in a generic way.

OracleCommand Class

An OracleCommand object represents a SQL command, a stored procedure or function, or a table name.

OracleCommandBuilder Class

An OracleCommandBuilder object provides automatic SQL generation for the OracleDataAdapter when the database is updated.

OracleConnection Class

An OracleConnection object represents a connection to Oracle Database.

OracleConnectionStringBuilder Class

An OracleConnectionStringBuilder object allows applications to create or modify connection strings.

OracleDataAdapter Class

An OracleDataAdapter object represents a data provider object that communicates with the DataSet.

OracleDataReader Class

An OracleDataReader object represents a forward-only, read-only, in-memory result set.

OracleDataSourceEnumerator Class

An OracleDataSourceEnumerator object allows applications to generically obtain a collection of data sources to connect to.

OracleDependency Class

An OracleDependency class represents a dependency between an application and an Oracle database.

Not Supported in a .NET Stored Procedure

OracleError Class

The OracleError object represents an error reported by an Oracle database.

OracleErrorCollection Class

An OracleErrorCollection object represents a collection of OracleErrors.

OracleException Class

The OracleException object represents an exception that is thrown when Oracle Data Provider for .NET encounters an error.

OracleFailoverEventArgs Class

The OracleFailoverEventArgs class provides event data for the OracleConnection.Failover event.

Not Supported in a .NET Stored Procedure

OracleFailoverEventHandler Delegate

The OracleFailoverEventHandler represents the signature of the method that handles the OracleConnection.Failover event.

Not Supported in a .NET Stored Procedure

OracleGlobalization Class

The OracleGlobalization class is used to obtain and set the Oracle globalization settings of the session, thread, and local computer (read-only).

OracleHAEventArgs Class

The OracleHAEventArgs class provides event data for the OracleConnection.HAEvent event.

OracleHAEventHandler Delegate

The OracleHAEventHandler delegate represents the signature of the method that handles the OracleConnection.HAEvent event.

OracleInfoMessageEventArgs Class

The OracleInfoMessageEventArgs object provides event data for the OracleConnection.InfoMessage event.

OracleInfoMessageEventHandler Delegate

The OracleInfoMessageEventHandler delegate represents the signature of the method that handles the OracleConnection.InfoMessage event.

OracleNotificationEventArgs Class

The OracleNotificationEventArgs class provides event data for a notification.

OracleNotificationRequest Class

An OracleNotificationRequest class represents a notification request to be subscribed in the database.

Not Supported in a .NET Stored Procedure

OracleParameter Class

An OracleParameter object represents a parameter for an OracleCommand.

OracleParameterCollection Class

An OracleParameterCollection object represents a collection of OracleParameters.

OraclePermission Class

An OraclePermission object enables ODP.NET to enforce imperative security and helps ensure that a user has a security level adequate for accessing data.

OraclePermissionAttribute Class

An OraclePermissionAttribute object enables ODP.NET to enforce declarative security and helps ensure that a user has a security level adequate for accessing data.

OracleRowsCopiedEventHandler Delegate

The OracleRowsCopiedEventHandler delegate represents the method that handles the OracleRowsCopied event of an OracleBulkCopy object.

OracleRowsCopiedEventArgs Class

The OracleRowsCopiedEventArgs class represents the set of arguments passed as part of event data for the OracleRowsCopied event.

OracleRowUpdatedEventArgs Class

The OracleRowUpdatedEventArgs object provides event data for the OracleDataAdapter.RowUpdated event.

OracleRowUpdatedEventHandler Delegate

The OracleRowUpdatedEventHandler delegate represents the signature of the method that handles the OracleDataAdapter.RowUpdated event.

OracleRowUpdatingEventArgs Class

The OracleRowUpdatingEventArgs object provides event data for the OracleDataAdapter.RowUpdating event.

OracleRowUpdatingEventHandler Delegate

The OracleRowUpdatingEventHandler delegate represents the signature of the method that handles the OracleDataAdapter.RowUpdating event.

OracleTransaction Class

An OracleTransaction object represents a local transaction.

Not Supported in a .NET Stored Procedure

OracleXmlQueryProperties Class

An OracleXmlQueryProperties object represents the XML properties used by the OracleCommand class when the XmlCommandType property is Query.

OracleXmlSaveProperties Class

An OracleXmlSaveProperties object represents the XML properties used by the OracleCommand class when the XmlCommandType property is Insert, Update, or Delete.


Oracle.DataAccess.Client Enumerations

Table 1-2 lists the client enumerations.

Table 1-2 Oracle.DataAccess.Client Enumerations

Enumeration Description

FailoverEvent Enumeration

FailoverEvent enumerated values are used to specify the state of the failover.

Not Supported in a .NET Stored Procedure

FailoverReturnCode Enumeration

FailoverReturnCode enumerated values are passed back by the application to the ODP.NET provider to request a retry in case of a failover error, or to continue in case of a successful failover.

Not Supported in a .NET Stored Procedure

FailoverType Enumeration

FailoverType enumerated values are used to indicate the type of failover event that was raised.

Not Supported in a .NET Stored Procedure

OracleAQDequeueMode Enumeration

The OracleAQDequeueMode enumeration type specifies the dequeue mode.

OracleAQMessageDeliveryMode Enumeration

The OracleAQMessageDeliveryMode enumeration type specifies the delivery mode of the message.

OracleAQMessageState Enumeration

The OracleAQMessageState enumeration type identifies the state of the message at the time of dequeue.

OracleAQMessageType Enumeration

The OracleAQMessageType enumeration type specifies the message payload type.

OracleAQNavigationMode Enumeration

The OracleAQNavigationMode enumeration type specifies the navigation mode.

OracleAQNotificationGroupingType Enumeration

The OracleAQNotificationGroupingType enumeration type specifies the notification grouping type.

OracleAQNotificationType Enumeration

The OracleAQNotificationType enumeration type specifies the notification type of the received notification.

OracleAQVisibilityMode Enumeration

The OracleAQVisibilityMode enumeration type specifies whether the enqueue or dequeue operation is part of the current transaction.

OracleBulkCopyOptions Enumeration

The OracleBulkCopyOptions enumeration specifies the values that can be combined with an instance of the OracleBulkCopy class and used as options to determine its behavior and the behavior of the WriteToServer methods for that instance.

OracleCollectionType Enumeration

OracleCollectionType enumerated values specify whether or not the OracleParameter object represents a collection, and if so, specifies the collection type.

Not Supported in a .NET Stored Procedure

OracleDBShutdownMode Enumeration

OracleDBShutdownMode enumerated values specify the database shutdown options.

OracleDBStartupMode Enumeration

OracleDBStartupMode enumerated values specify the database startup options.

OracleDbType Enumeration

OracleDbType enumerated values are used to explicitly specify the OracleDbType of an OracleParameter.

OracleHAEventSource Enumeration

The OracleHAEventSource enumeration indicates the source of the HA event.

OracleHAEventStatus Enumeration

The OracleHAEventStatus enumeration indicates the status of the HA event source.

OracleNotificationInfo Enumeration

OracleNotificationInfo enumerated values specify the database event that causes the notification.

Not Supported in a .NET Stored Procedure

OracleNotificationSource Enumeration

OracleNotificationSource enumerated values specify the different sources that cause notification.

Not Supported in a .NET Stored Procedure

OracleNotificationType Enumeration

OracleNotificationType enumerated values specify the different types that cause the notification.

Not Supported in a .NET Stored Procedure

OracleParameterStatus Enumeration

The OracleParameterStatus enumeration type indicates whether a NULL value is fetched from a column, or truncation has occurred during the fetch, or a NULL value is to be inserted into a database column.

OracleRowidInfo Enumeration

The OracleRowidInfo enumeration values specify whether ROWID information is included as part of the ChangeNotificationEventArgs or not

OracleXmlCommandType Enumeration

The OracleXmlCommandType enumeration specifies the values that are allowed for the OracleXmlCommandType property of the OracleCommand class.


Oracle.DataAccess.Types Namespace

The Oracle.DataAccess.Types namespace provides classes, structures, and exceptions for Oracle native types that can be used with Oracle Data Provider for .NET.

Oracle.DataAccess.Types Structures

Table 1-3 lists the type structures.

Table 1-3 Oracle.DataAccess.Types Structures

Structure Description

OracleBinary Structure

The OracleBinary structure represents a variable-length stream of binary data.

OracleDate Structure

The OracleDate structure represents the Oracle DATE data type.

OracleDecimal Structure

The OracleDecimal structure represents an Oracle NUMBER in the database or any Oracle numeric value.

OracleIntervalDS Structure

The OracleIntervalDS structure represents the Oracle INTERVAL DAY TO SECOND data type.

OracleIntervalYM Structure

The OracleIntervalYM structure represents the Oracle INTERVAL YEAR TO MONTH data type.

OracleString Structure

The OracleString structure represents a variable-length stream of characters.

OracleTimeStamp Structure

The OracleTimeStamp structure represents the Oracle TimeStamp data type.

OracleTimeStampLTZ Structure

The OracleTimeStampLTZ structure represents the Oracle TIMESTAMP WITH LOCAL TIME ZONE data type.

OracleTimeStampTZ Structure

The OracleTimeStampTZ structure represents the Oracle TIMESTAMP WITH TIME ZONE data type.


Oracle.DataAccess.Types Exceptions

Type Exceptions are thrown only by ODP.NET type structures. Table 1-4 lists the type exceptions.

Table 1-4 Oracle.DataAccess.Types Exceptions

Exception Description

OracleTypeException Class

The OracleTypeException object is the base exception class for handling exceptions that occur in the ODP.NET Types classes.

OracleNullValueException Class

The OracleNullValueException represents an exception that is thrown when trying to access an ODP.NET Types structure that is null.

OracleTruncateException Class

The OracleTruncateException class represents an exception that is thrown when truncation in an ODP.NET Types class occurs.


Oracle.DataAccess.Types Classes

Table 1-5 lists the type classes.

Table 1-5 Oracle.DataAccess.Types Classes

Class Description

OracleArrayMappingAttribute Class

The OracleArrayMappingAttribute class is required to mark a custom class field or property with information that ODP.NET uses when a custom type represents an Oracle Collection type.

OracleBFile Class

An OracleBFile is an object that has a reference to BFILE data. It provides methods for performing operations on BFILE objects.

OracleBlob Class

An OracleBlob object is an object that has a reference to BLOB data. It provides methods for performing operations on BLOB objects.

OracleClob Class

An OracleClob is an object that has a reference to CLOB data. It provides methods for performing operations on CLOB objects.

OracleCustomTypeMappingAttribute Class

The OracleCustomTypeMappingAttribute class is used to mark a custom type factory class or struct with information that is used by ODP.NET when a custom type is used to represent an Oracle UDT.

OracleObjectMappingAttribute Class

The OracleObjectMappingAttribute class marks custom class fields or properties with information that ODP.NET uses when a custom type represents an Oracle Object type.

OracleRef Class

An OracleRef instance represents an Oracle REF, which references a persistent, standalone, referenceable object that resides in the database. The OracleRef object provides methods to insert, update, and delete the Oracle REF.

OracleRefCursor Class

An OracleRefCursor object represents an Oracle REF CURSOR.

OracleUdt Class

The OracleUdt class defines static methods that are used when converting between Custom Types and Oracle UDTs and vice-versa.

OracleXmlStream Class

An OracleXmlStream object represents a sequential read-only stream of XML data stored in an OracleXmlType object.

OracleXmlType Class

An OracleXmlType object represents an Oracle XmlType instance.


Oracle.DataAccess.Types Interfaces

Table 1-6 lists the type interfaces.

Table 1-6 Oracle.DataAccess.Types Interfaces

Interface Description

IOracleArrayTypeFactory Interface

The IOracleArrayTypeFactory interface is used by ODP.NET to create arrays that represent Oracle Collections.

IOracleCustomType Interface

IOracleCustomType is an interface for converting between a Custom Type and an Oracle Object or Collection Type.

IOracleCustomTypeFactory Interface

The IOracleCustomTypeFactory interface is used by ODP.NET to create custom objects that represent Oracle Objects or Collections.

INullable Interface

The INullable interface is used to determine whether or not an ODP.NET type has a NULL value.


Oracle.DataAccess.Types Enumerations

Table 1-7 lists the type enumerations.

Table 1-7 Oracle.DataAccess.Types Enumerations

Enumeration Description

OracleUdtFetchOption Enumeration

OracleUdtFetchOption enumeration values specify how to retrieve a copy of the referenceable object.

OracleUdtStatus Enumeration

OracleUdtStatus enumeration values specify the status of an object attribute or collection element. An object attribute or a collection element can be a valid value or a null value.