SqlConnection Class
 

Represents an open connection to a SQL Server database. This class cannot be inherited.

Namespace:   System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

Inheritance Hierarchy
SystemObject
   SystemMarshalByRefObject
     System.ComponentModelComponent
       System.Data.CommonDbConnection
        System.Data.SqlClientSqlConnection

Syntax
public sealed class SqlConnection : DbConnection, ICloneable
public ref class SqlConnection sealed : DbConnection, ICloneable
[<Sealed>]
type SqlConnection = 
    class
        inherit DbConnection
        interface ICloneable
    end
Public NotInheritable Class SqlConnection
	Inherits DbConnection
	Implements ICloneable
Constructors
NameDescription
System_CAPS_pubmethod SqlConnection

Initializes a new instance of the SqlConnection class.

System_CAPS_pubmethod SqlConnection

Initializes a new instance of the SqlConnection class when given a string that contains the connection string.

System_CAPS_pubmethod SqlConnection

Initializes a new instance of the SqlConnection class given a connection string, that does not use Integrated Security = true and a SqlCredential object that contains the user ID and password.

Properties
NameDescription
System_CAPS_pubproperty

Gets or sets the access token for the connection.

System_CAPS_pubproperty

The connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.

System_CAPS_pubproperty System_CAPS_static

Allows you to set a list of trusted key paths for a database server. If while processing an application query the driver receives a key path that is not on the list, the query will fail. This property provides additional protection against security attacks that involve a compromised SQL Server providing fake key paths, which may lead to leaking key store credentials.

System_CAPS_pubproperty

Gets or sets the string used to open a SQL Server database.(Overrides .)

System_CAPS_pubproperty

Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.(Overrides .)

System_CAPS_pubproperty

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubproperty

Gets or sets the SqlCredential object for this connection.

System_CAPS_pubproperty

Gets the name of the current database or the database to be used after a connection is opened.(Overrides .)

System_CAPS_pubproperty

Gets the name of the instance of SQL Server to which to connect.(Overrides .)

System_CAPS_pubproperty

Gets or sets the property.

System_CAPS_pubproperty

Gets the size (in bytes) of network packets used to communicate with an instance of SQL Server.

System_CAPS_pubproperty

Gets a string that contains the version of the instance of SQL Server to which the client is connected.(Overrides .)

System_CAPS_pubproperty

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubproperty

Indicates the state of the SqlConnection during the most recent network operation performed on the connection.(Overrides .)

System_CAPS_pubproperty

When set to true, enables statistics gathering for the current connection.

System_CAPS_pubproperty

Gets a string that identifies the database client.

Methods
NameDescription
System_CAPS_pubmethod BeginTransaction

Starts a database transaction.

System_CAPS_pubmethod BeginTransaction

Starts a database transaction with the specified isolation level.

System_CAPS_pubmethod BeginTransaction

Starts a database transaction with the specified isolation level and transaction name.

System_CAPS_pubmethod BeginTransaction

Starts a database transaction with the specified transaction name.

System_CAPS_pubmethod ChangeDatabase

Changes the current database for an open SqlConnection.(Overrides DbConnectionChangeDatabase.)

System_CAPS_pubmethod System_CAPS_static ChangePassword

Changes the SQL Server password for the user indicated in the SqlCredential object.

System_CAPS_pubmethod System_CAPS_static ChangePassword

Changes the SQL Server password for the user indicated in the connection string to the supplied new password.

System_CAPS_pubmethod System_CAPS_static ClearAllPools

Empties the connection pool.

System_CAPS_pubmethod System_CAPS_static ClearPool

Empties the connection pool associated with the specified connection.

System_CAPS_pubmethod Close

Closes the connection to the database. This is the preferred method of closing any open connection.(Overrides DbConnectionClose.)

System_CAPS_pubmethod CreateCommand

Creates and returns a SqlCommand object associated with the SqlConnection.

System_CAPS_pubmethod CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Dispose

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethod EnlistDistributedTransaction

Enlists in the specified transaction as a distributed transaction.

System_CAPS_pubmethod EnlistTransaction

Enlists in the specified transaction as a distributed transaction.(Overrides DbConnectionEnlistTransaction.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this SqlConnection. For more information about scheme, see SQL Server Schema Collections.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this SqlConnection using the specified string for the schema name.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this SqlConnection using the specified string for the schema name and the specified string array for the restriction values.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Open

Opens a database connection with the property settings specified by the .(Overrides DbConnectionOpen.)

System_CAPS_pubmethod OpenAsync

An asynchronous version of Open, which opens a database connection with the settings specified by the . This method invokes the virtual method OpenAsync with CancellationToken.None.(Inherited from DbConnection.)

System_CAPS_pubmethod OpenAsync

An asynchronous version of Open, which opens a database connection with the property settings specified by the . The cancellation token can be used to request that the operation be abandoned before the connection timeout elapses. Exceptions will be propagated via the returned Task. If the connection timeout time elapses without successfully connecting, the returned Task will be marked as faulted with an Exception. The implementation returns a Task without blocking the calling thread for both pooled and non-pooled connections.(Overrides DbConnectionOpenAsync.)

System_CAPS_pubmethod System_CAPS_static RegisterColumnEncryptionKeyStoreProviders

Registers the column encryption key store providers.

System_CAPS_pubmethod ResetStatistics

If statistics gathering is enabled, all values are reset to zero.

System_CAPS_pubmethod RetrieveStatistics

Returns a name value pair collection of statistics at the point in time the method is called.

System_CAPS_pubmethod ToString

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

Events
NameDescription
System_CAPS_pubevent Disposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubevent InfoMessage

Occurs when SQL Server returns a warning or informational message.

System_CAPS_pubevent StateChange

Occurs when the state of the event changes.(Inherited from DbConnection.)

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionBeginTransaction

Begins a database transaction.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionBeginTransaction

Begins a database transaction with the specified IsolationLevel value.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionCreateCommand

Creates and returns a DbCommand object that is associated with the current connection.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod ICloneableClone

Creates a new object that is a copy of the current instance.

Remarks

A SqlConnection object represents a unique session to a SQL Server data source. With a client/server database system, it is equivalent to a network connection to the server. SqlConnection is used together with SqlDataAdapter and SqlCommand to increase performance when connecting to a Microsoft SQL Server database. For all third-party SQL Server products, and other OLE DB-supported data sources, use OleDbConnection.

When you create an instance of SqlConnection, all properties are set to their initial values. For a list of these values, see the SqlConnection constructor.

See for a list of the keywords in a connection string.

If the SqlConnection goes out of scope, it won't be closed. Therefore, you must explicitly close the connection by calling Close or Dispose. Close and Dispose are functionally equivalent. If the connection pooling value Pooling is set to true or yes, the underlying connection is returned back to the connection pool. On the other hand, if Pooling is set to false or no, the underlying connection to the server is actually closed.

System_CAPS_noteNote

Login and logout events will not be raised on the server when a connection is fetched from or returned to the connection pool, because the connection is not actually closed when it is returned to the connection pool. For more information, see SQL Server Connection Pooling (ADO.NET).

To ensure that connections are always closed, open the connection inside of a using block, as shown in the following code fragment. Doing so ensures that the connection is automatically closed when the code exits the block.

Using connection As New SqlConnection(connectionString)
    connection.Open()
    ' Do work here; connection closed on following line.
End Using
using (SqlConnection connection = new SqlConnection(connectionString))
    {
        connection.Open();
        // Do work here; connection closed on following line.
    }
System_CAPS_noteNote

To deploy high-performance applications, you must use connection pooling. When you use the .NET Framework Data Provider for SQL Server, you do not have to enable connection pooling because the provider manages this automatically, although you can modify some settings. For more information, see SQL Server Connection Pooling (ADO.NET).

If a SqlException is generated by the method executing a SqlCommand, the SqlConnection remains open when the severity level is 19 or less. When the severity level is 20 or greater, the server ordinarily closes the SqlConnection. However, the user can reopen the connection and continue.

An application that creates an instance of the SqlConnection object can require all direct and indirect callers to have sufficient permission to the code by setting declarative or imperative security demands. SqlConnection makes security demands using the SqlClientPermission object. Users can verify that their code has sufficient permissions by using the SqlClientPermissionAttribute object. Users and administrators can also use the Caspol.exe (Code Access Security Policy Tool) to modify security policy at the machine, user, and enterprise levels. For more information, see Security in the .NET Framework. For an example demonstrating how to use security demands, see Code Access Security and ADO.NET.

For more information about handling warning and informational messages from the server, see Connection Events. SQL Server engine errors and error messages are documented in SQL Server Books Online.

System_CAPS_cautionCaution

You can force TCP instead of shared memory. You can do that by prefixing tcp: to the server name in the connection string or you can use localhost.

Examples

The following example creates a SqlCommand and a SqlConnection. The SqlConnection is opened and set as the for the SqlCommand. The example then calls ExecuteNonQuery. To accomplish this, the ExecuteNonQuery is passed a connection string and a query string that is a Transact-SQL INSERT statement. The connection is closed automatically when the code exits the using block.

private static void CreateCommand(string queryString,
    string connectionString)
{
    using (SqlConnection connection = new SqlConnection(
               connectionString))
    {
        SqlCommand command = new SqlCommand(queryString, connection);
        command.Connection.Open();
        command.ExecuteNonQuery();
    }
}
Public Sub CreateCommand(ByVal queryString As String, _
  ByVal connectionString As String)
    Using connection As New SqlConnection(connectionString)
        Dim command As New SqlCommand(queryString, connection)
        command.Connection.Open()
        command.ExecuteNonQuery()
    End Using
End Sub
Version Information
Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top