readme.txt 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. Oracle.ManagedDataAccess NuGet Package 19.18.0 README
  2. =====================================================
  3. Release Notes: Oracle Data Provider for .NET, Managed Driver
  4. January 2023
  5. This document provides information that supplements the Oracle Data Provider for .NET (ODP.NET) documentation.
  6. You have downloaded Oracle Data Provider for .NET. The license agreement is available here:
  7. https://www.oracle.com/downloads/licenses/distribution-license.html
  8. TABLE OF CONTENTS
  9. *New Features
  10. *Bug Fixes
  11. *Installation and Configuration Steps
  12. *Installation Changes
  13. *Documentation Corrections and Additions
  14. *ODP.NET, Managed Driver Tips, Limitations, and Known Issues
  15. Note: The 32-bit "Oracle Developer Tools for Visual Studio" download from https://otn.oracle.com/dotnet is
  16. required for Entity Framework design-time features and for other Visual Studio designers such as the
  17. TableAdapter Wizard. This NuGet download does not enable design-time tools; it only provides run-time support.
  18. This version of ODP.NET supports Oracle Database version 11.2.0.4 and higher.
  19. Bug Fixes since Oracle.ManagedDataAccess.Core NuGet Package 19.17.0
  20. ===================================================================
  21. Bug 31456063 ORA-03111 IS ENCOUNTERED WHILE CANCELLING THE CURRENT COMMAND EXECUTION
  22. Bug 31793997 INCORRECT UDTS ARE RETURNED BY DATAREADER AFTER A NULL UDT IS FETCHED
  23. Bug 34431232 CURRENT DATABASE EDITION NAME IS NOT RETURNED BY ORACLECONNECTION
  24. Bug 34617083 RESOLVE CVE-2023-21893
  25. Installation and Configuration Steps
  26. ====================================
  27. The downloads are NuGet packages that can be installed with the NuGet Package Manager. These instructions apply
  28. to install ODP.NET, Managed Driver.
  29. 1. Un-GAC and un-configure any existing assembly (i.e. Oracle.ManagedDataAccess.dll) and policy DLL
  30. (i.e. Policy.4.122.Oracle.ManagedDataAccess.dll) for the ODP.NET, Managed Driver, version 4.122.19.1
  31. that exist in the GAC. Remove all references of Oracle.ManagedDataAccess from machine.config file, if any exists.
  32. 2. In Visual Studio, open NuGet Package Manager from an existing Visual Studio project.
  33. 3. Install the NuGet package from NuGet Gallery (nuget.org).
  34. From Local Package Source
  35. -------------------------
  36. A. Click on the Settings button in the lower left of the dialog box.
  37. B. Click the "+" button to add a package source. In the Source field, enter in the directory location where the
  38. NuGet package(s) were downloaded to. Click the Update button, then the Ok button.
  39. C. On the left side, under the Online root node, select the package source you just created. The ODP.NET NuGet
  40. packages will appear.
  41. From Nuget.org
  42. --------------
  43. A. In the Search box in the upper right, search for the package with id, "Oracle.ManagedDataAccess". Verify
  44. that the package uses this unique ID to ensure it is the official Oracle Data Provider for .NET, Managed Driver
  45. download.
  46. B. Select the package you wish to install.
  47. 4. Click on the Install button to select the desired NuGet package(s) to include with the project. Accept the
  48. license agreement and Visual Studio will continue the setup.
  49. 5. Open the app/web.config file to configure the ODP.NET connection string and connect descriptors.
  50. Below is an example of configuring the net service aliases and connect descriptors parameters:
  51. <oracle.manageddataaccess.client>
  52. <version number="*">
  53. <dataSources>
  54. <!-- Customize these connection alias settings to connect to Oracle DB -->
  55. <dataSource alias="MyDataSource" descriptor="(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=ORCL))) " />
  56. </dataSources>
  57. </version>
  58. </oracle.manageddataaccess.client>
  59. After following these instructions, ODP.NET is now configured and ready to use.
  60. IMPORTANT: Oracle recommends configuring net service aliases and connect descriptors in a .NET config file to
  61. have the application configuration be self-contained rather than using tnsnames.ora or TNS_ADMIN.
  62. NOTE: ODP.NET, Managed Driver comes with one set of platform specific assemblies for Kerberos support: Oracle.ManagedDataAccessIOP.dll.
  63. The Oracle.ManagedDataAccessIOP.dll assembly is ONLY needed if you are using Kerberos5 based external
  64. authentication. Kerberos5 users will need to download MIT Kerberos for Windows version 4.0.1 from
  65. https://web.mit.edu/kerberos/dist/
  66. to utilize ODP.NET, Managed Driver's support of Kerberos5.
  67. The asssemblies are located under
  68. packages\Oracle.ManagedDataAccess.<version>\bin\x64
  69. and
  70. packages\Oracle.ManagedDataAccess.<version>\bin\x86
  71. depending on the platform.
  72. If these assemblies are required by your application, your Visual Studio project requires additional changes.
  73. Use the following steps for your application to use the 64-bit version of Oracle.ManagedDataAccessIOP.dll:
  74. 1. Right click on the Visual Studio project.
  75. 2. Select Add -> New Folder.
  76. 3. Name the folder x64.
  77. 4. Right click on the newly created x64 folder.
  78. 5. Select Add -> Existing Item.
  79. 6. Browse to packages\Oracle.ManagedDataAccess.<version>\bin\x64 under your project solution directory.
  80. 7. Choose Oracle.ManagedDataAccessIOP.dll.
  81. 8. Click the 'Add' button.
  82. 9. Left click the newly added Oracle.ManagedDataAccessIOP.dll in the x64 folder.
  83. 10. In the properties window, set 'Copy To Output Directory' to 'Copy Always'.
  84. For x86 targeted applications, name the folder x86 and add assemblies from the
  85. packages\Oracle.ManagedDataAccess.<version>\bin\x86 folder.
  86. To make your application platform independent even if it depends on Oracle.ManagedDataAccessIOP.dll, create both x64 and x86 folders with the necessary assemblies added to them.
  87. Installation Changes
  88. ====================
  89. The following app/web.config entries are added by including the ODP.NET, Managed Driver NuGet package to your application:
  90. 1) Configuration Section Handler
  91. The following entry is added to the app/web.config to enable applications to add an <oracle.manageddataaccess.client>
  92. section for ODP.NET, Managed Driver-specific configuration:
  93. <configuration>
  94. <configSections>
  95. <section name="oracle.manageddataaccess.client" type="OracleInternal.Common.ODPMSectionHandler, Oracle.ManagedDataAccess, Version=4.122.19.1, Culture=neutral, PublicKeyToken=89b483f429c47342" />
  96. </configSections>
  97. </configuration>
  98. Note: If your application is a web application and the above entry was added to a web.config and the same config
  99. section handler for "oracle.manageddataaccess.client" also exists in machine.config but the "Version" attribute values
  100. are different, an error message of "There is a duplicate 'oracle.manageddataaccess.client' section defined." may be
  101. observed at runtime. If so, the config section handler entry in the machine.config for
  102. "oracle.manageddataaccess.client" has to be removed from the machine.config for the web application to not encounter
  103. this error. But given that there may be other applications on the machine that depended on this entry in the
  104. machine.config, this config section handler entry may need to be moved to all of the application's .NET config file on
  105. that machine that depend on it.
  106. 2) DbProviderFactories
  107. The following entry is added for applications that use DbProviderFactories and DbProviderFactory classes. Also, any
  108. DbProviderFactories entry for "Oracle.ManagedDataAccess.Client" in the machine.config will be ignored with the following
  109. entry:
  110. <configuration>
  111. <system.data>
  112. <DbProviderFactories>
  113. <remove invariant="Oracle.ManagedDataAccess.Client" />
  114. <add name="ODP.NET, Managed Driver" invariant="Oracle.ManagedDataAccess.Client" description="Oracle Data Provider for .NET, Managed Driver" type="Oracle.ManagedDataAccess.Client.OracleClientFactory, Oracle.ManagedDataAccess, Version=4.122.19.1, Culture=neutral, PublicKeyToken=89b483f429c47342" />
  115. </DbProviderFactories>
  116. </system.data>
  117. </configuration>
  118. 3) Dependent Assembly
  119. The following entry is created to ignore policy DLLs for Oracle.ManagedDataAccess.dll and always use the
  120. Oracle.ManagedDataAccess.dll version that is specified by the newVersion attribute in the <bindingRedirect> element.
  121. The newVersion attribute corresponds to the Oracle.ManagedDataAccess.dll version which came with the NuGet package
  122. associated with the application.
  123. <configuration>
  124. <runtime>
  125. <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
  126. <dependentAssembly>
  127. <publisherPolicy apply="no" />
  128. <assemblyIdentity name="Oracle.ManagedDataAccess" publicKeyToken="89b483f429c47342" culture="neutral" />
  129. <bindingRedirect oldVersion="4.122.0.0 - 4.65535.65535.65535" newVersion="4.122.19.1" />
  130. </dependentAssembly>
  131. </assemblyBinding>
  132. </runtime>
  133. </configuration>
  134. 4) Data Sources
  135. The following entry is added to provide a template on how a data source can be configured in the app/web.config.
  136. Simply rename "MyDataSource" to an alias of your liking and modify the PROTOCOL, HOST, PORT, SERVICE_NAME as required
  137. and un-comment the <dataSource> element. Once that is done, the alias can be used as the "data source" attribute in
  138. your connection string when connecting to an Oracle Database through ODP.NET, Managed Driver.
  139. <configuration>
  140. <oracle.manageddataaccess.client>
  141. <version number="*">
  142. <dataSources>
  143. <dataSource alias="SampleDataSource" descriptor="(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=ORCL))) " />
  144. </dataSources>
  145. </version>
  146. </oracle.manageddataaccess.client>
  147. </configuration>
  148. Documentation Corrections and Additions
  149. =======================================
  150. None
  151. ODP.NET, Managed Driver Tips, Limitations, and Known Issues
  152. ===========================================================
  153. None
  154. Copyright (c) 2021, 2023, Oracle and/or its affiliates.