DB2 Data Provider Classes

The DB2 data provider supports the public classes, properties, and methods as described in the Microsoft .NET Framework SDK documentation. The DB2 data provider attaches the provider-specific prefix "DB2" to the public .NET classes, for example, DB2Command.

This section describes the provider-specific properties and methods of the DB2 data provider.

Note: This section applies to both DB2 data providers. See Supported Properties and Methods for information on the differences for the DB2 Entity Framework data provider.

DB2BulkCopy Class

The DB2BulkCopy class uses an API pattern similar to the ADO.NET Bulk API patterns, and has no provider-specific public properties or methods. For information about the properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2BulkCopyColumnMapping Class

The DB2BulkCopyColumnMapping class uses an API pattern similar to the ADO.NET Bulk API patterns, and has no provider-specific public properties or methods. For information about the properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2BulkCopyColumnMappingCollection Class

The DB2BulkCopyColumnMappingCollection class follows an API pattern similar to the Microsoft SqlBulkCopyColumnMappingCollection class, and has no provider-specific public properties or methods. For information about the properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2Command Class

The following table lists the provider-specific public properties of the DB2Command class. The table includes the generic public properties of the Command class when provider-specific information supplements the standard descriptions. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

In this section, DB2Command instances are referred to as statements.

Public Properties of the DB2Command Class

The following table lists the generic public methods of the Command class when provider-specific information supplements the standard descriptions. For a description of the other methods supported, refer to the online help and the Microsoft .NET Framework SDK documentation.

Public Methods of the DB2Command Class

DB2CommandBuilder Class

Using a CommandBuilder class can have a negative effect on performance. Because of concurrency restrictions, the CommandBuilder can generate highly inefficient SQL statements. The end user can often write more efficient UPDATE and DELETE statements than those that the CommandBuilder generates (refer to the DataDirect Connect Series for ADO.NET Reference for more information).

The DB2CommandBuilder class has no provider-specific public properties or methods. For information about the properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2Connection Class

The following table) lists the provider-specific public constructors of the DB2Connection class.

Public Constructors of the DB2Connection Class

The following table lists the provider-specific public properties of the DB2Connection class. The table includes the generic public properties of the Connection class when provider-specific information supplements the standard descriptions.

Public Properties of the DB2Connection Class

The following table lists the provider-specific public methods of the DB2Connection class. The table includes the generic public methods when provider-specific information supplements the standard descriptions. For information about other methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Methods of the DB2Connection Class

DB2ConnectionStringBuilder Class

TheDB2ConnectionStringBuilder class has no provider-specific public methods. For information about the methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2ConnectionStringBuilder property names are the same as the connection string option names of the DB2Connection class. However, the connection string option name has spaces between the words. For example, the connection string option name Alternate Servers is equivalent to the property name AlternateServers.

See DB2 Data Provider Connection String Options for the connection option descriptions, which are listed alphabetically by the connection string option name. The ConnectionStringBuilder property name is listed immediately underneath the GUI name.

DB2Credential Class

DB2Credential provides a more secure way to specify the password for a login attempt using DB2 Server Authentication. DB2Credential is comprised of a user id and a password that will be used for DB2 Server Authentication.

The password in a DB2Credential object is of type SecureString, unlike Connection String where password remains unsecure till the point where provider reads it and converts it to SecureString. The password is converted to string/ byte array in a secured way so that the conversion logic does not write the password in the memory. Any string where password is stored is cleaned after use.

Note: DB2Credential should not be used when the Authentication Method does not need user id and password. So, if you are using Kerberos or Client, you should not use DB2Credential.

Note: The Connection String should not have the User id and password when the Credential object is being used.

The following code snippet shows how the DB2Credential class can be used:

DB2Connection con = null;DB2Credential lobjCredential = null;string userId = "ABCD";SecureString password = ConvertToSecureString("XYXYX");

private static SecureString ConvertToSecureString(string value){var securePassword = new SecureString();foreach (char c in value.ToCharArray())securePassword.AppendChar(c);securePassword.MakeReadOnly();return securePassword;}try{lobjCredential = new DB2Credential(userId, password);con = new DB2Connection("Host=nc-xxx;Port=xxxx;Database Name=xxxx"", lobjCredential);con.Open();Console.WriteLine("Connection Successfully Opened...");con.Close();}catch (Exception e){Console.Write(e.Message)}finally{if (null != con){con.Close();con = null;}if (null != lobjCredential)lobjCredential = null;}

Note: The method followed to convert a string into a SecureString in this example is one of many possible methods you can use.

The following table lists the provider-specific implementation of the public properties of the DB2Connection class.

Public Properties of the DB2Credential Class

Note: If you are using Credential object while opening the connection and want to use the same pooled connection, you need to use the same Credential object (Reference equal). Only then the same connection will be fetched from the available connection pool.

If you create a new Credential object for each connection, the driver will treat them as separate connection and put them into different connection pools. (Even if you use the same user id and password)

DB2DataAdapter Class

The following table lists the provider-specific implementation of the public properties of the DB2DataAdapter class. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the DB2DataAdapter Class

The DB2ConnectionStringBuilder class has no provider-specific public methods. For a description of the methods supported by the ConnectionStringBuilder class, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2DataReader Class

The DB2DataReader class has no provider-specific public properties. For information about the properties supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

The following table lists the public methods of the DB2DataReader class that have provider-specific information. For a description of the other methods supported, refer to the online help and the Microsoft .NET Framework SDK documentation.

Public Methods of the DB2DataReader Class

DB2Error Class

The following table lists the provider-specific public properties of the DB2Error class. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the DB2Error Class

DB2ErrorCollection Class

The following table lists the public, provider-specific properties of the DB2ErrorCollection class. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the DB2ErrorCollection Class

DB2Exception Class

Provider-specific exceptions are derived directly from the System.Data interface. Only the public properties and methods, for example, the Message property, are directly available on the System.Exception object in a generic sense. The SQLState and Number properties are only accessible through provider-specific code or by using reflection.

ADO.NET 2.0 introduced the Data property on the DbException class. This property returns a collection of key-value pair tuples that provide additional user-defined information about an exception. The DB2 data provider gets a collection of key/value pairs such as SQLState, Number, and ErrorPosition.

The DDTek prefix is applied to each key, for example:

DDTek.Data["SQLState"] = 28000;

The following table lists the provider-specific public properties of the DB2Exception class. The properties apply to the last error collected if multiple errors occurred. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the DB2Exception Class

DB2Factory Class

Factory classes allow users to program to generic classes for the data provider. Once instantiated from DbProviderFactory, the factory generates the proper type of concrete class.

The following table lists the static methods used to accommodate choosing a data provider and instantiating its DbProviderFactory.

Public Methods of the DB2Factory Class

DB2InfoMessageEventArgs Class

The DB2InfoMessageEventArgs class is passed as an input to the DB2InfoMessageEventHandler and contains information relevant to a warning generated by the DB2 server.

The DB2InfoMessageEventArgs class has no provider-specific public properties or methods. For information about the properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

DB2Parameter Class

The following table lists the provider-specific public properties of the DB2Parameter class. The table includes the generic public properties of the Parameter class when provider-specific information supplements the standard descriptions. For information about other properties and methods supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Note: When executing a stored procedure, the data provider by default assumes that the parameters supplied are in the same order as they were specified in the Create Procedure statement. The names of parameters supplied in the DB2Parameter class are ignored.

Public Properties of the DB2Parameter Class

DB2ParameterCollection

The following table lists the provider-specific public properties of the DB2Parameter class. For information about other properties supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the DB2ParameterCollection Class

DB2Trace Class

Setting the properties in the DB2Trace class overrides the settings of the environment variables (see Using Environment Variables). For your final application, be sure to remove references to the DB2Trace class.

The following code fragment creates a DB2Trace class named MyTrace.txt. All subsequent calls to the data provider will be traced to that file.

DB2Trace.TraceFile="C:\\MyTrace.txt";
DB2Trace.RecreateTrace = 1;
DB2Trace.EnableTrace = 1;

The following table lists the public properties of the DB2Trace class.

Public Properties of the DB2Trace Class

The following table lists the public methods of the DB2Trace class.

Public Methods of the DB2Trace Class

DB2Transaction Class

The DB2Transaction class has no provider-specific public properties or methods. For a description of the properties and methods supported, refer to the online help and the Microsoft .NET Framework SDK documentation.