This tutorial describes how to connect to an Oracle server with dotConnect for Oracle - dotConnect for Oracle a high-performance ADO.NET provider from Devart with ORM support. This article consists of the following sections:
In order to connect to Oracle server you need the server itself running, dotConnect for Oracle installed and IDE running. If you have Oracle Client Software installed and want to use it, you need to know TNS alias name, login and password. If you do not wish to use OCI, you have to know host name or IP address, SID (or ServiceName), port, login and password.
Note that if you do not use design-time (specifically, if you do not place the OracleConnection component from the toolbox on a form designer), you have to embed licensing information manually. This is described in dotConnect for Oracle documentation.
To establish a connection to server you have to provide some connection parameters to dotConnect for Oracle. This information is used by the OracleConnection component to find the server and login with credentials of your account. The parameters are represented as connection string. You can compose the connection string manually or have dotConnect for Oracle construct it for you.
There are two ways to connect to server: with and without Oracle Client Interface. This is controlled by Direct property. It indicates whether the Oracle Client Interface will be used for connecting to server. By default Direct mode is disabled to preserve maximal functionality. Switch to Direct mode if you want to work in a system without Oracle Client Software installed.
Note: In order to use OCI mode, you must have the Oracle Client of the same bitness as your application. For 32bit application, you must have 32bit Oracle Client installed, and for 64bit application you must have 64bit Oracle Client installed.
Note that design-time connection creation, described here, is applicable only to Windows Forms applications for Full .NET Framework.
The following assumes that you have IDE running, and you are currently focused on a form designer.
Same operations performed in runtime look as follows (note that you have to add references to Devart.Data.Oracle.dll and Devart.Data.dll assemblies for Full .NET Framework or install the Devart.Data.Oracle NuGet package for .NET Core):[C#]
using Devart.Data.Oracle; ... OracleConnection oracleConnection1 = new OracleConnection(); oracleConnection1.Server = "OraServer"; oracleConnection1.UserId = "scott"; oracleConnection1.Password = "tiger";[Visual Basic]
Imports Devart.Data.Oracle ... Dim OracleConnection1 As OracleConnection = New OracleConnection() OracleConnection1.Server = "OraServer" OracleConnection1.UserId = "scott" OracleConnection1.Password = "tiger"
You can do this all in single assignment. It actually does not matter whether connection string is assigned directly or composed with particular properties. After you assign a value to ConnectionString property all other properties are populated with parsed values. So you can choose what is more convenient for you.[C#]
oracleConnection1.ConnectionString = "User Id=scott;Password=tiger;Server=OraServer;";[Visual Basic]
oracleConnection1.ConnectionString = "User Id=scott;Password=tiger;Server=OraServer;"
If you decide to setup a connection by assigning values to several properties, consider using the the OracleConnectionStringBuilder class. It has all of the possible connection settings exposed as properties, thus allowing you to customize the connection at full extent. The following example demonstrates how to compose a more complex connection string:[C#]
OracleConnectionStringBuilder(); oraCSB.Direct = true; oraCSB.Server = "192.168.0.1"; oraCSB.Port = 1251; oraCSB.Sid = "OracleSid"; oraCSB.UserId = "scott"; oraCSB.Password = "tiger"; oraCSB.MaxPoolSize = 150; oraCSB.ConnectionTimeout = 30; OracleConnection myConnection = new OracleConnection(oraCSB.ConnectionString);[Visual Basic]
oraCSB As OracleConnectionStringBuilder = New OracleConnectionStringBuilder oraCSB.Direct = true oraCSB.Server = "192.168.0.1" oraCSB.Port = 1251 oraCSB.Sid = "OracleSid" oraCSB.UserId = "scott" oraCSB.Password = "tiger" oraCSB.MaxPoolSize = 150 oraCSB.ConnectionTimeout = 30 Dim myConnection As OracleConnection = New OracleConnection(oraCSB.ConnectionString)
Note that in this example we used OracleConnection constructor that accepts connection string as argument.
For the information on arguments are allowed in the connection string, refer to the description of the OracleConnection.ConnectionString property in dotConnect for Oracle documentation.
Opening a connection is as simple as that:[C#]
Of course, OracleConnection1 must have a valid connection string assigned earlier. When you call Open, dotConnect for Oracle tries to find the host and connect to server. If any problem occurs it raises an exception with brief explanation on what is wrong. If no problem is encountered dotConnect for Oracle tries to establish the connection during ConnectionTimeout interval. Finally, when connection is established, the Open method returns and State property is changed to Open.
In design-time you can connect to server in few steps:
Or you can simply change the State property to Open in the Properties window to establish a connection using the current connection string.
To close a connection call its Close method, or set its State property to Closed.
The following example summarizes aforementioned information and shows how to create, setup, open, use and then close the connection.[C#]
OracleConnection myConn = new OracleConnection(); myConn.ConnectionString = "User Id=scott;Password=tiger;Server=OraServer;"; myConn.Open(); MessageBox.Show(myConn.ServerVersion); myConn.Close();[Visual Basic]
Dim myConn As OracleConnection = New OracleConnection() myConn.ConnectionString = "User Id=scott;Password=tiger;Server=OraServer;" myConn.Open() MessageBox.Show(myConn.ServerVersion) myConn.Close()
The sample code connects to a server, shows its version and then closes the connection. This actually is rare usage, because in real applications connections are used by other objects like OracleCommand, OracleDataTable and others. For more information on this, please see the corresponding tutorials or dotConnect for Oracle documentation.
You can modify connection by changing properties of OracleConnection object. Keep in mind that while some of the properties can be altered freely, most of them close connection when new value is assigned. For example, if you change Server property, it gets closed immediately, and you have to reopen it manually.
This tutorial describes how you can connect to an Oracle server with dotConnect for Oracle - an ADO.NET provider from Devart with ORM support. dotConnect for Oracle has wide set of features you can take advantage of. You may take a look at other dotConnect for Oracle tutorials to learn more about them or download dotConnect for Oracle and try it yourself.