SQL Server Data Provider Classes

The SQL Server data provider supports the public classes, properties, and methods as described in the Microsoft .NET Framework SDK documentation. The SQL Server data provider attaches the provider-specific prefix SQLServer to the public .NET class, for example, SQLServerCommand.

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

SQLServerBulkCopy Class

The SQLServerBulkCopy class uses a model similar to the ADO.NET Bulk API patterns, and has no provider-specific 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.

SQLServerBulkCopyColumnMapping Class

The SQLServerBulkCopyColumnMapping class uses an API pattern similar to the Microsoft SqlBulkCopyMapping class, and has no provider-specific 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.

SQLServerBulkCopyColumnMappingCollection Class

The SQLServerBulkCopyColumnMapping class follows an API pattern similar to the Microsoft SqlBulkCopyColumnMappingCollection class, and has no provider-specific 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.

SQLServerCommand Class

The following table lists the provider-specific public properties of the SQLServerCommand 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.

Public Properties of the SQLServerCommand Class

SQLServerCommandBuilder 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.

The SQLServerCommandBuilder class has no provider-specific 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.

SQLServerConnection Class

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

Public Constructors of the SQLServerConnection Class

The following table lists the provider-specific public properties of the SQLServerConnection class. Some properties return the values specified for the corresponding connection string option. See Connection String Options for more information. For a description of other properties supported, refer to the data provider’s online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the SQLServerConnection Class

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

Public Methods Supported by the SQLServerConnection Class

SQLServerConnectionStringBuilder Class:

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

SQLServerConnectionStringBuilder property names are the same as the connection string option names of the SybaseConnection 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 SQL Server 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.

SQLServerCredential Class

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

The password in a SQLServerCredential 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: SQLServerCredential should not be used when the Authentication Method does not need user id and password. So, if you are using NTLM or Kerberos, you should not use SQLServerCredential.

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 SQLServerCredential class can be used:

SQLServerConnection con = null;
SQLServerCredential 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 SQLServerCredential(userId, password);
con = new SQLServerConnection("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 SQLServerConnection class.

Public Properties of the SQLServerCredential Class

Note: If you are using Credential objects 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)

SQLServerDataAdapter Class

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

Public Properties of the SQLServerDataAdapter Class

SQLServerDataReader Class

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

SQLServerError Class

The following table lists the provider-specific public properties of the SQLServerError 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 SQLServerError Class

SQLServerErrorCollection Class

The following table lists the provider-specific public properties of the SQLServerErrorCollection 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 SQLServerErrorCollection Class

SQLServerException 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.

The following table lists the provider-specific public properties of the SQLServerException 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 SQLServerException Class

SQLServerFactory Class

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

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

Methods of the SQLServerFactory Class

SQLServerInfoMessageEventArgs Class

The SQLServerInfoMessageEventArgs object is passed as an input to the SQLServerInfoMessageEventHandler and contains information relevant to a warning generated by the SQL Server server.

The SQLServerInfoMessageEventArgs object has no provider-specific 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.

SQLServerParameter Class

The following table lists the provider-specific public properties of the SQLServerParameter 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 SQLServerParameter object are ignored.

Public Properties of the SQLServerParameter Class

SQLServerParameterCollection

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

Public Properties of the SQLServerParameterCollection Class

SQLServerTrace Class

The SQLServerTrace class is created by the application to debug problems during development. Setting the properties in the SQLServerTrace class overrides the settings of the environment variables (see Connection String Options). For your final application, be sure to remove references to the SQLServerTrace class.

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

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

The following table lists the public properties for the SQLServerTrace class.

Public Properties of the SQLServerTrace Class

¹ Setting EnableTrace starts the tracing process. Therefore, you must define the property values for the trace file before setting EnableTrace. Once the trace processing starts, the values of TraceFile and RecreateTrace cannot be changed

The following table lists the public methods for the SQLServerTrace class.

Public Methods of the SQLServerTrace Class

SQLServerTransaction Class

The SQLServerTransaction 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.