List of Examples
List of Tables
Title and Copyright Information
Preface
- Audience
- Documentation Accessibility
- Related Documents
- Passwords in Code Examples
- Conventions
Changes in This Release for Oracle Data Provider for .NET
- Changes in Oracle Data Provider for .NET Release 19c (19.3)
  - New Features
- Changes in Oracle Data Provider for .NET in ODAC Release 18c (18.3)
  - New Features
- Changes in Oracle Data Provider for .NET Release 18c (18.3)
  - New Features
  - Desupported Features
- Changes in Oracle Data Provider for .NET in ODAC 12.2c Release 1
  - New Features
  - Deprecated Features
- Changes in Oracle Data Provider for .NET Release 12.2.0.1
  - New Features
  - Desupported Features
- Changes in Oracle Data Provider for .NET in ODAC 12c Release 4
  - New Features
- Changes in Oracle Data Provider for .NET in ODAC 12c Release 3
  - New Features
- Changes in Oracle Data Provider for .NET Release 12.1.0.2
  - New Features
- Changes in Oracle Data Provider for .NET in ODAC 12c Release 2
  - New Features
- Changes in Oracle Data Provider for .NET in ODAC 12c Release 1
  - New Features
- Changes in Oracle Data Provider for .NET Release 12.1
  - New Features
1 Introducing Oracle Data Provider for .NET
- .NET Data Access in Oracle: Products and Documentation
- Overview of Oracle Data Provider for .NET (ODP.NET)
- Oracle Data Provider for .NET Assemblies
- Differences between the ODP.NET Drivers
- Using ODP.NET Client Provider in a Simple Application
2 Installing and Configuring Oracle Data Provider for .NET
- System Requirements
- Entity Framework Requirements
- Oracle Data Provider for .NET Versioning Scheme
- Installing Oracle Data Provider for .NET, Unmanaged Driver
  - File Locations After Installation
  - Search Order for Unmanaged DLLs
    - ODP.NET and Dependent Unmanaged DLL Mismatch
- Installing Oracle Data Provider for .NET, Managed Driver
  - Platform-Dependent Assemblies and Their Search Order
  - File Locations After Installation
- Installing Oracle Data Provider for .NET Core
- Entity Framework Code First Assemblies and File Location
- Configuring Oracle Data Provider for .NET
- Oracle Data Provider for .NET, Unmanaged Driver Configuration
- Oracle Data Provider for .NET, Managed Driver Configuration
- Oracle Data Provider for .NET Core Configuration
- Distributed Transactions
- Configuration differences between ODP.NET, Managed Driver and ODP.NET, Unmanaged Driver
- Configuring for Entity Framework Code First
  - Entity Framework 6 Code-Based Registration
- Migrating from ODP.NET, Unmanaged Driver to ODP.NET, Managed Driver
- Configuring a Port to Listen for Database Notifications
- General .NET Programming Recommendations and Tips for ODP.NET
3 Features of Oracle Data Provider for .NET
- Base Classes and Provider Factory Classes
- Code Access Security
  - Configuring OraclePermission
  - Configuring OraclePermission for Web Applications with High or Medium Trust Levels
  - Configuring OraclePermission for Windows Applications Running in a Partial Trust Environment
- Connecting to Oracle Database
  - Connecting to Oracle Database Cloud Service
  - Connection String Attributes
  - Connection String Builder
  - Specifying the Data Source Attribute
    - Using the TNS Alias
    - Using the Connect Descriptor
    - Easy Connect and Easy Connect Plus Naming Methods
    - Using LDAP
    - Data Source Enumerator
  - Using Transport Layer Security and Secure Sockets Layer
    - Secure Sockets Layer and Transport Layer Security Differences
    - ODP.NET Secure Sockets Layer Configuration
    - Troubleshooting TLS/SSL Setup
    - HTTPS Proxy for Cloud Connections
  - Using Secure External Password Store
    - Configuring Secure External Password Store (SEPS)
  - Using Kerberos
    - File Based Credential Cache and MSLSA
    - ODP.NET, Managed Driver Dependency on MIT Kerberos
    - Configuring Kerberos Authentication with ODP.NET
  - Using Windows Native Authentication (NTS)
    - Configuring Windows Native Authentication (NTS) for the ODP.NET Client
  - Network Data Encryption and Integrity
    - Using Data Encryption
    - Using Data Integrity
  - Schema Discovery
    - User Customization of Metadata
  - Connection Pooling
    - Using Connection Pooling
  - Connection Pool Management
  - Connection Performance Counters
    - Registering Performance Counters
    - Enabling Performance Counters
    - Setting Performance Counters in .NET Configuration Files
    - Setting Performance Counters in Windows Registry
    - Publishing Performance Counters
  - Database Resident Connection Pooling
  - Oracle Multitenant and Pluggable Databases
  - Edition-Based Redefinition
  - Operating System Authentication
  - Privileged Connections
  - Connection Pooling with OracleCredential
  - Password Expiration
  - Proxy Authentication
  - Dynamic Distributed Transaction Enlistment
  - Client Identifier and End-to-End Tracing
  - Transparent Application Failover (TAF) Callback Support
    - TAF Notification
    - When Failover Occurs
    - Registering an Event Handler for Failover
- Real Application Clusters and Global Data Services
  - Fast Application Notification
  - Runtime Connection Load Balancing
  - Fast Connection Failover (FCF)
  - Using FCF Planned Outage to Minimize Service Disruption
  - Pool Behavior in an Oracle RAC Database
- Using Transaction Guard to Prevent Logical Corruption
  - ODP.NET and Transaction Guard
- Application Continuity
  - ODP.NET and Application Continuity
- Database Sharding
  - ODP.NET Sharding
- OracleCommand Object
  - Transactions
  - System.Transactions and Promotable Transactions
  - Parameter Binding
  - Batch Processing
  - Statement Caching
  - Self-Tuning
- ODP.NET Types Overview
- Obtaining Data from an OracleDataReader Object
  - Typed OracleDataReader Accessors
    - .NET Type Accessors
    - ODP.NET Type Accessors
  - Obtaining LONG and LONG RAW Data
    - Setting InitialLONGFetchSize to Zero or a Value Greater than Zero
    - Setting InitialLONGFetchSize to -1
  - Obtaining LOB Data
  - Controlling the Number of Rows Fetched in One Database Round-Trip
- PL/SQL REF CURSOR and OracleRefCursor
  - Obtaining an OracleRefCursor Object
  - Obtaining a REF CURSOR Data Type
  - Populating an OracleDataReader from a REF CURSOR
  - Populating the DataSet from a REF CURSOR
  - Populating an OracleRefCursor from a REF CURSOR
  - Updating a DataSet Obtained from a REF CURSOR
  - Behavior of ExecuteScalar Method for REF CURSOR
  - Passing a REF CURSOR to a Stored Procedure
- Implicit REF CURSOR Binding
  - Specifying REF CURSOR Bind and Metadata Information in the .NET Configuration File
  - Sample Configuration File and Application
  - Usage Considerations
- LOB Support
  - Large Character and Large Binary Data Types
  - Oracle Data Provider for .NET LOB Objects
  - Updating LOBs Using a DataSet
  - Updating LOBs Using OracleCommand and OracleParameter
  - Updating LOBs Using ODP.NET LOB Objects
  - Temporary LOBs
- ODP.NET XML Support
  - Supported XML Features
  - XQuery Support
  - OracleXmlType and Connection Dependency
  - Updating XMLType Data in the Database
    - Updating with DataSet, OracleDataAdapter, and OracleCommandBuilder
    - Updating with OracleCommand and OracleParameter
  - Updating XML Data in OracleXmlType
  - Characters with Special Meaning in XML
  - Retrieving Query Result Set as XML
  - Data Manipulation Using XML
- Oracle User-Defined Types (UDTs) and .NET Custom Types
  - Oracle User-Defined Types (UDTs)
  - Custom Types
    - Required Custom Type Implementations
    - Optional Custom Type Implementations
  - Specifying Custom Type Mappings
  - Converting Between Custom Types and Oracle UDTs
  - Oracle UDT Attribute Mappings
  - Oracle UDT Retrieval from OracleDataReader
  - Oracle UDT Metadata Retrieval from OracleDataReader
  - Oracle UDT Parameter Binding with OracleParameter
  - Populating the DataSet with Oracle UDTs
  - UDT Method Invocation
  - Configuration Settings for Oracle UDTs
    - StatementCacheWithUdts
    - UdtCacheSize
- Bulk Copy
  - Data Types Supported by Bulk Copy
  - Restrictions on Oracle Bulk Copy of a Single Partition
  - Integrity Constraints Affecting Oracle Bulk Copy
  - Database Insert Triggers
  - Field Defaults
- Oracle Database Advanced Queuing Support
  - Using ODP.NET for Advanced Queuing
    - Enqueuing and Dequeuing Example
- Continuous Query Notification Support
  - Continuous Query Notification Classes
  - Supported Operations
  - Requirements of Notification Registration
  - Using Continuous Query Notification
    - Application Steps
    - Flow of Notification Process
  - Best Practice Guidelines and Performance Considerations
- OracleDataAdapter Safe Type Mapping
  - Comparison Between Oracle Data Types and .NET Types
  - SafeMapping Property
    - Using Safe Type Mapping
- OracleDataAdapter Requery Property
- Guaranteeing Uniqueness in Updating DataSet to Database
  - What Constitutes Uniqueness in DataRow Objects?
  - Configuring PrimaryKey and Constraints Properties
  - Updating Without PrimaryKey and Constraints Configuration
- Globalization Support
  - Globalization Settings
  - Globalization-Sensitive Operations
  - ODP.NET Drivers Differences
- Debug Tracing
- Database Application Migration: SQL Translation Framework
  - The SQL Translation Profile
4 ADO.NET Entity Framework and LINQ to Entities
- Overview of Entity Framework
- Language Integrated Query and Entity SQL
- Mapping Oracle Data Types to EDM Types
  - EDM Type Facets
- Oracle Number Default Data Type Mapping and Customization
- Migrating Existing Entity Framework 5 Applications to Entity Framework 6
- Code First
- Unsupported Entity Framework Features
5 Oracle Data Provider for .NET Stored Procedures
- Introducing .NET Stored Procedure Execution Using ODP.NET
- Limitations and Restrictions on ODP.NET Within .NET Stored Procedure
- Porting Client Application to .NET Stored Procedure
6 Oracle Data Provider for .NET Classes
- OracleClientFactory Class
  - OracleClientFactory Members
  - OracleClientFactory Field
    - Instance
  - OracleClientFactory Constructor
  - OracleClientFactory Public Properties
    - CanCreateDataSourceEnumerator
  - OracleClientFactory Public Methods
- OracleCommand Class
  - OracleCommand Members
  - OracleCommand Constructors
  - OracleCommand Static Methods
  - OracleCommand Properties
  - OracleCommand Public Methods
- OracleCommandBuilder Class
  - OracleCommandBuilder Members
  - OracleCommandBuilder Constructors
    - OracleCommandBuilder()
    - OracleCommandBuilder(OracleDataAdapter)
  - OracleCommandBuilder Static Methods
    - DeriveParameters
  - OracleCommandBuilder Properties
  - OracleCommandBuilder Public Methods
  - OracleCommandBuilder Events
- OracleConfiguration Class
  - OracleConfiguration Members
  - OracleConfiguration Connection Properties
  - OracleConfiguration Secure Connection Properties
  - OracleConfiguration Command Properties
    - BindByName
    - CommandTimeout
  - OracleConfiguration Directories Properties
  - OracleConfiguration High Availability Properties
  - OracleConfiguration Performance Properties
  - OracleConfiguration Debug Tracing Properties
- OracleConnection Class
  - OracleConnection Members
  - OracleConnection Constructors
  - OracleConnection Static Properties
    - IsAvailable
  - OracleConnection Static Methods
    - ClearPool
    - ClearAllPools
  - OracleConnection Properties
  - OracleConnection Public Methods
  - OracleConnection Events
- OracleConnectionOpenEventArgs Class
  - OracleConnectionOpenEventArgs Members
  - OracleConnectionOpenEventArgs Properties
    - Connection
- OracleConnectionOpenEventHandler Delegate
- OracleConnectionStringBuilder Class
  - OracleConnectionStringBuilder Members
  - OracleConnectionStringBuilder Constructors
    - OracleConnectionStringBuilder()
    - OracleConnectionStringBuilder(string)
  - OracleConnectionStringBuilder Public Properties
  - OracleConnectionStringBuilder Public Methods
    - Clear
    - ContainsKey
    - Remove
    - TryGetValue
- OracleCredential Class
  - OracleCredential Members
  - OracleCredential Constructors
  - OracleCredential Properties
- OracleDataAdapter Class
  - OracleDataAdapter Members
  - OracleDataAdapter Constructors
  - OracleDataAdapter Static Methods
  - OracleDataAdapter Properties
  - OracleDataAdapter Public Methods
  - OracleDataAdapter Events
    - RowUpdated
    - RowUpdating
- OracleDatabase Class
  - OracleDatabase Members
  - OracleDatabase Constructors
    - OracleDatabase Constructor(string)
    - OracleDatabase Constructor(string, OracleCredential)
  - OracleDatabase Properties
    - ServerVersion
  - OracleDatabase Public Methods
- OracleDataReader Class
  - OracleDataReader Members
  - OracleDataReader Static Methods
  - OracleDataReader Properties
  - OracleDataReader Public Methods
- OracleDataSourceCollection Class
  - OracleDataSourceCollection Members
  - OracleDataSourceCollection Methods
    - Add
    - Remove
  - OracleDataSourceCollection Properties
    - Count
    - This
- OracleDataSourceEnumerator Class
  - OracleDataSourceEnumerator Members
  - OracleDataSourceEnumerator Constructor
  - OracleDataSourceEnumerator Public Methods
    - GetDataSources
- OracleError Class
  - OracleError Members
  - OracleError Static Methods
  - OracleError Properties
    - ArrayBindIndex
    - DataSource
    - Message
    - Number
    - Procedure
    - Source
  - OracleError Methods
    - ToString
- OracleErrorCollection Class
  - OracleErrorCollection Members
  - OracleErrorCollection Static Methods
  - OracleErrorCollection Properties
  - OracleErrorCollection Public Methods
- OracleException Class
  - OracleException Members
  - OracleException Static Methods
  - OracleException Properties
  - OracleException Methods
    - GetObjectData
    - ToString
- OracleInfoMessageEventArgs Class
  - OracleInfoMessageEventArgs Members
  - OracleInfoMessageEventArgs Static Methods
  - OracleInfoMessageEventArgs Properties
    - Errors
    - Message
    - Source
  - OracleInfoMessageEventArgs Public Methods
    - ToString
- OracleInfoMessageEventHandler Delegate
- OracleLogicalTransaction Class
  - OracleLogicalTransaction Members
  - OracleLogicalTransaction Public Read-Only Properties
  - OracleLogicalTransaction Methods
    - Dispose
    - GetOutcome
- OracleOnsServerCollection Class
  - OracleOnsServerCollection Members
  - OracleOnsServerCollection Methods
    - Add
    - Remove
  - OracleOnsServerCollection Properties
    - Count
    - This
- OracleParameter Class
  - OracleParameter Members
  - OracleParameter Constructors
  - OracleParameter Static Methods
  - OracleParameter Properties
    - ArrayBindSize
    - ArrayBindStatus
    - CollectionType
    - DbType
    - Direction
    - IsNullable
    - Offset
    - OracleDbType
    - OracleDbTypeEx
    - ParameterName
    - Precision
    - Scale
    - Size
    - SourceColumn
    - SourceColumnNullMapping
    - SourceVersion
    - Status
    - UdtTypeName
    - Value
  - OracleParameter Public Methods
- OracleParameterCollection Class
  - OracleParameterCollection Members
  - OracleParameterCollection Static Methods
  - OracleParameterCollection Properties
    - Count
    - Item
    - Item[int]
    - Item[string]
    - IsFixedSize
    - IsReadOnly
    - IsSynchronized
    - SyncRoot
  - OracleParameterCollection Public Methods
- OraclePermission Class
  - OraclePermission Members
  - OraclePermission Constructor
  - OraclePermission Static Methods
  - OraclePermission Public Properties
  - OraclePermission Public Methods
    - Add
    - Copy
    - IsSubsetOf
- OraclePermissionAttribute Class
  - OraclePermissionAttribute Members
  - OraclePermissionAttribute Constructor
  - OraclePermissionAttribute Static Methods
  - OraclePermissionAttribute Public Properties
  - OraclePermissionAttribute Public Methods
    - CreatePermission
- OracleRowUpdatedEventArgs Class
  - OracleRowUpdatedEventArgs Members
  - OracleRowUpdatedEventArgs Constructor
  - OracleRowUpdatedEventArgs Static Methods
  - OracleRowUpdatedEventArgs Properties
    - Command
  - OracleRowUpdatedEventArgs Public Methods
- OracleRowUpdatedEventHandler Delegate
- OracleRowUpdatingEventArgs Class
  - OracleRowUpdatingEventArgs Members
  - OracleRowUpdatingEventArgs Constructor
  - OracleRowUpdatingEventArgs Static Methods
  - OracleRowUpdatingEventArgs Properties
    - Command
  - OracleRowUpdatingEventArgs Public Methods
- OracleRowUpdatingEventHandler Delegate
- OracleShardingKey Class
  - OracleShardingKey Members
  - OracleShardingKey Constructors
    - OracleShardingKey()
    - OracleShardingKey(OracleDbType, object)
  - OracleShardingKey Instance Methods
    - SetShardingKey(OracleDbType, object)
    - Dispose
- OracleTransaction Class
  - OracleTransaction Members
  - OracleTransaction Static Methods
  - OracleTransaction Properties
    - IsolationLevel
    - Connection
  - OracleTransaction Public Methods
    - Commit
    - Dispose
    - Rollback
    - Rollback()
    - Rollback(string)
    - Save
- OracleConnectionType Enumeration
- OracleCollectionType Enumeration
- OracleDBAPrivilege Enumeration
- OracleDBShutdownMode Enumeration
- OracleDBStartupMode Enumeration
- OracleDbType Enumeration
- OracleDRCPPurity Enumeration
- OracleIdentityType Enumeration
- OracleParameterStatus Enumeration
7 Oracle Data Provider for .NET XML-Related Classes
- OracleXmlCommandType Enumeration
- OracleXmlQueryProperties Class
- OracleXmlSaveProperties Class
- OracleXmlStream Class
- OracleXmlType Class
8 Oracle Data Provider for .NET HA Event Classes
- OracleHAEventArgs Class
  - OracleHAEventArgs Members
  - OracleHAEventArgs Properties
    - DatabaseDomainName
    - DatabaseName
    - DrainTimeout
    - HostName
    - InstanceName
    - Reason
    - ServiceName
    - Source
    - Status
    - Time
- OracleHAEventHandler Delegate
- OracleHAEventSource Enumeration
- OracleHAEventStatus Enumeration
9 Continuous Query Notification Classes
- OracleDependency Class
- OracleNotificationRequest Class
- OracleNotificationEventArgs Class
- OnChangeEventHandler Delegate
- OracleRowidInfo Enumeration
- OracleNotificationType Enumeration
- OracleNotificationSource Enumeration
- OracleNotificationInfo Enumeration
10 Oracle Data Provider for .NET Globalization Classes
- OracleGlobalization Class
11 Oracle Data Provider for .NET Failover Classes
- OracleFailoverEventArgs Class
- OracleFailoverEventHandler Delegate
- FailoverEvent Enumeration
- FailoverReturnCode Enumeration
- FailoverType Enumeration
12 Oracle Database Advanced Queuing Classes
- OracleAQAgent Class
- OracleAQDequeueOptions Class
- OracleAQEnqueueOptions Class
- OracleAQMessage Class
- OracleAQMessageAvailableEventArgs Class
- OracleAQMessageAvailableEventHandler Delegate
- OracleAQQueue Class
- OracleAQDequeueMode Enumeration
- OracleAQMessageDeliveryMode Enumeration
- OracleAQMessageState Enumeration
- OracleAQMessageType Enumeration
- OracleAQNavigationMode Enumeration
- OracleAQNotificationGroupingType Enumeration
- OracleAQNotificationType Enumeration
- OracleAQVisibilityMode Enumeration
13 Oracle Data Provider for .NET Types Classes
- OracleBFile Class
- OracleBlob Class
- OracleClob Class
- OracleRefCursor Class
14 Oracle Data Provider for .NET Types Structures
- OracleBinary Structure
- OracleBoolean Structure
- OracleDate Structure
- OracleDecimal Structure
- OracleIntervalDS Structure
- OracleIntervalYM Structure
- OracleString Structure
- OracleTimeStamp Structure
- OracleTimeStampLTZ Structure
- OracleTimeStampTZ Structure
- INullable Interface
  - INullable Interface Members
  - INullable Interface Properties
    - IsNull
15 Oracle Data Provider for .NET Types Exceptions
- OracleTypeException Class
- OracleNullValueException Class
- OracleTruncateException Class
16 Oracle Data Provider for .NET UDT-Related Classes
- OracleCustomTypeMappingAttribute Class
- OracleObjectMappingAttribute Class
- OracleArrayMappingAttribute Class
- IOracleCustomType Interface
  - IOracleCustomType Members
  - IOracleCustomType Interface Methods
    - FromCustomObject
    - ToCustomObject
- IOracleCustomTypeFactory Interface
  - IOracleCustomTypeFactory Members
  - IOracleCustomTypeFactory Interface Methods
    - CreateObject
- IOracleArrayTypeFactory Interface
  - IOracleArrayTypeFactory Members
  - IOracleArrayTypeFactory Interface Methods
    - CreateArray
    - CreateStatusArray
- OracleUdt Class
  - OracleUdt Members
  - OracleUDT Static Methods
- OracleRef Class
- OracleUdtFetchOption Enumeration
- OracleUdtStatus Enumeration
17 Oracle Data Provider for .NET Bulk Copy Classes
- OracleBulkCopy Class
- OracleBulkCopyColumnMapping Class
- OracleBulkCopyColumnMappingCollection Class
- OracleBulkCopyOptions Enumeration
- OracleRowsCopiedEventHandler Delegate
- OracleRowsCopiedEventArgs Class
A Oracle Schema Collections
- Common Schema Collections
- ODP.NET-Specific Schema Collection
  - Tables
  - Columns
  - Views
  - XMLSchema
  - Users
  - Synonyms
  - Sequences
  - Functions
  - Procedures
  - ProcedureParameters
  - Arguments
  - Packages
  - PackageBodies
  - JavaClasses
  - Indexes
  - IndexColumns
  - PrimaryKeys
  - ForeignKeys
  - ForeignKeyColumns
  - UniqueKeys
B Mapping LINQ Canonical Functions and Oracle Functions
Glossary
Index