Sybase Data Provider Classes

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

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

SybaseBulkCopy

The SybaseBulkCopy class uses a model similar to the Microsoft SqlBulkCopy 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.

SybaseBulkCopyColumnMapping

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

SybaseBulkCopyColumnMappingCollection

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

SybaseCommand Class

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

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

SybaseConnection Class

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

Public Constructors of the SybaseConnection Class

The following table lists the provider-specific public properties of the SybaseConnection class. The table includes the generic public properties of the Connection class when provider-specific information supplements the standard descriptions. Some properties return the values specified for the corresponding connection string option. See Sybase Data Provider Connection String Options for more information.

Public Properties of the SybaseConnection Class

The following table lists the provider-specific public methods supported for the SybaseConnection class. 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 SybaseConnection Class

SybaseConnectionStringBuilder Class

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

TheSybaseConnectionStringBuilder 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 Sybase 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.

SybaseCredential Class

SybaseCredential provides a more secure way to specify the password for connecting to Sybase server. SybaseCredential is comprised of a user id and a password that will be used for connecting to Sybase Server.

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

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

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

Public Properties of the SybaseCredential 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)

SybaseDataAdapter Class

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

Supported Properties of the SybaseDataAdapter Class

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

Public Methods of the SybaseDataAdapter Class

SybaseDataReader Class

The SybaseDataReader class has no provider-specific properties or methods. For a description of the properties and methods supported, refer to the data provider’s online help.

SybaseError Class

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

Public Properties of the SybaseError Class

SybaseErrorCollection Class

The following table describes the provider-specific public properties supported by the SybaseErrorCollection class. For a description of other properties and methods supported, refer to the online help and the Microsoft .NET Framework SDK documentation.

Public Properties of the SybaseErrorCollection Class

SybaseException 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 Sybase 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 SybaseException 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 SybaseException Class

SybaseFactory Class

Provider Factory classes allow users to program to generic classes. 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 Sybase data provider and instantiating its DbProviderFactory.

Methods of the SybaseFactory Class

SybaseInfoMessageEventArgs Class

The SybaseInfoMessageEventArgs class is passed as an input to the SybaseInfoMessageEventHandler and contains information relevant to a warning generated by the Sybase server.

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

SybaseParameter Class

The following table lists the provider-specific public properties of the SybaseParameter class. The table includes the generic public properties of the Parameter class when provider-specific information supplements the standard descriptions. For a description of other properties and methods supported, refer to the 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 SybaseParameter class are ignored.

Public Properties of the SybaseParameter Class

SybaseParameterCollection

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

Public Properties of the SybaseParameterCollection Class

SybaseTrace Class

The SybaseTrace class is created by the application to debug problems during development. Setting the properties in the SybaseTrace class overrides the settings of the environment variables. See Connection String Options for more information. For your final application, be sure to remove references to the SybaseTrace class.

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

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

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

Public Properties of the SybaseTrace Class

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

Public Methods of the SybaseTrace Class

SybaseTransaction Class

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