SqlConnection Class

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.9.0

Source:: System.Data.SqlClient.notsupported.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use the Microsoft.Data.SqlClient package instead.

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

public ref class SqlConnection sealed : System::Data::Common::DbConnection, ICloneable

public ref class SqlConnection sealed : System::Data::Common::DbConnection

public ref class SqlConnection sealed : System::ComponentModel::Component, ICloneable, IDisposable, System::Data::IDbConnection

public sealed class SqlConnection : System.Data.Common.DbConnection, ICloneable

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlConnection : System.Data.Common.DbConnection, ICloneable

public sealed class SqlConnection : System.Data.Common.DbConnection

public sealed class SqlConnection : System.ComponentModel.Component, ICloneable, IDisposable, System.Data.IDbConnection

type SqlConnection = class
    inherit DbConnection
    interface ICloneable

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlConnection = class
    inherit DbConnection
    interface ICloneable

type SqlConnection = class
    inherit DbConnection

type SqlConnection = class
    inherit Component
    interface IDbConnection
    interface IDisposable
    interface ICloneable

Public NotInheritable Class SqlConnection
Inherits DbConnection
Implements ICloneable

Public NotInheritable Class SqlConnection
Inherits DbConnection

Public NotInheritable Class SqlConnection
Inherits Component
Implements ICloneable, IDbConnection, IDisposable

Inheritance: Object

DbConnection
SqlConnection

Inheritance: Object

MarshalByRefObject

Component

DbConnection
SqlConnection

Inheritance: Object

MarshalByRefObject

Component
SqlConnection

Attributes: ObsoleteAttribute

Implements: ICloneable IDbConnection IDisposable

Examples

The following example creates a SqlCommand and a SqlConnection. The SqlConnection is opened and set as the Connection for the SqlCommand. The example then calls ExecuteNonQuery. To accomplish this, the ExecuteNonQuery is passed a SqlConnection 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

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

Note

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

Note

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 .NET. 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. For more information about SQL Server engine errors and error messages, see Database Engine Events and Errors.

Caution

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.

Constructors

SqlConnection()	Initializes a new instance of the SqlConnection class.
SqlConnection(String, SqlCredential)	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.
SqlConnection(String)	Initializes a new instance of the SqlConnection class when given a string that contains the connection string.

Properties

AccessToken	Gets or sets the access token for the connection.
CanCreateBatch	Gets a value that indicates whether this DbConnection instance supports the DbBatch class. (Inherited from DbConnection)
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
ClientConnectionId	The connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.
ColumnEncryptionKeyCacheTtl	Gets or sets the time-to-live for column encryption key entries in the column encryption key cache for the Always Encrypted feature. The default value is 2 hours. 0 means no caching at all.
ColumnEncryptionQueryMetadataCacheEnabled	Gets or sets a value that indicates whether query metadata caching is enabled (true) or not (false) for parameterized queries running against Always Encrypted enabled databases. The default value is true.
ColumnEncryptionTrustedMasterKeyPaths	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.
ConnectionString	Gets or sets the string used to open a SQL Server database.
ConnectionTimeout	Gets the time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.
Container	Gets the IContainer that contains the Component. (Inherited from Component)
Credential	Gets or sets the SqlCredential object for this connection.
Database	Gets the name of the current database or the database to be used after a connection is opened.
DataSource	Gets the name of the instance of SQL Server to which to connect.
DbProviderFactory	Gets the DbProviderFactory for this DbConnection. (Inherited from DbConnection)
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
FireInfoMessageEventOnUserErrors	Gets or sets the FireInfoMessageEventOnUserErrors property.
PacketSize	Gets the size (in bytes) of network packets used to communicate with an instance of SQL Server.
ServerVersion	Gets a string that contains the version of the instance of SQL Server to which the client is connected.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
State	Indicates the state of the SqlConnection during the most recent network operation performed on the connection.
StatisticsEnabled	When set to `true`, enables statistics gathering for the current connection.
WorkstationId	Gets a string that identifies the database client.

Methods

BeginDbTransaction(IsolationLevel)	When overridden in a derived class, starts a database transaction. (Inherited from DbConnection)
BeginDbTransactionAsync(IsolationLevel, CancellationToken)	Asynchronously starts a database transaction. (Inherited from DbConnection)
BeginTransaction()	Starts a database transaction.
BeginTransaction(IsolationLevel, String)	Starts a database transaction with the specified isolation level and transaction name.
BeginTransaction(IsolationLevel)	Starts a database transaction with the specified isolation level.
BeginTransaction(String)	Starts a database transaction with the specified transaction name.
BeginTransactionAsync(CancellationToken)	Asynchronously begins a database transaction. (Inherited from DbConnection)
BeginTransactionAsync(IsolationLevel, CancellationToken)	Asynchronously begins a database transaction. (Inherited from DbConnection)
ChangeDatabase(String)	Changes the current database for an open SqlConnection.
ChangeDatabaseAsync(String, CancellationToken)	Asynchronously changes the current database for an open connection. (Inherited from DbConnection)
ChangePassword(String, SqlCredential, SecureString)	Changes the SQL Server password for the user indicated in the SqlCredential object.
ChangePassword(String, String)	Changes the SQL Server password for the user indicated in the connection string to the specified new password.
ClearAllPools()	Empties the connection pool.
ClearPool(SqlConnection)	Empties the connection pool associated with the specified connection.
Close()	Closes the connection to the database. This is the preferred method of closing any open connection.
CloseAsync()	Asynchronously closes the connection to the database. (Inherited from DbConnection)
CreateBatch()	Returns a new instance of the provider's class that implements the DbBatch class. (Inherited from DbConnection)
CreateCommand()	Creates and returns a SqlCommand object associated with the SqlConnection.
CreateDbBatch()	When overridden in a derived class, returns a new instance of the provider's class that implements the DbBatch class. (Inherited from DbConnection)
CreateDbCommand()	When overridden in a derived class, creates and returns a DbCommand object associated with the current connection. (Inherited from DbConnection)
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DbConnection)
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the DbConnection and optionally releases the managed resources. (Inherited from DbConnection)
Dispose(Boolean)	Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component)
DisposeAsync()	Asynchronously disposes the connection object. (Inherited from DbConnection)
EnlistDistributedTransaction(ITransaction)	Enlists in the specified transaction as a distributed transaction.
EnlistTransaction(Transaction)	Enlists in the specified transaction as a distributed transaction.
EnlistTransaction(Transaction)	Enlists in the specified transaction. (Inherited from DbConnection)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetSchema()	Returns schema information for the data source of this SqlConnection. For more information about scheme, see SQL Server Schema Collections.
GetSchema()	Returns schema information for the data source of this DbConnection. (Inherited from DbConnection)
GetSchema(String, String[])	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.
GetSchema(String, String[])	Returns schema information for the data source of this DbConnection using the specified string for the schema name and the specified string array for the restriction values. (Inherited from DbConnection)
GetSchema(String)	Returns schema information for the data source of this SqlConnection using the specified string for the schema name.
GetSchema(String)	Returns schema information for the data source of this DbConnection using the specified string for the schema name. (Inherited from DbConnection)
GetSchemaAsync(CancellationToken)	This is an asynchronous version of GetSchema(). Providers should override with an appropriate implementation. The `cancellationToken` can optionally be honored. The default implementation invokes the synchronous GetSchema() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled `cancellationToken`. Exceptions thrown by GetSchema() will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetSchemaAsync(String, CancellationToken)	This is the asynchronous version of GetSchema(String). Providers should override with an appropriate implementation. The `cancellationToken` can optionally be honored. The default implementation invokes the synchronous GetSchema(String) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled `cancellationToken`. Exceptions thrown by GetSchema(String) will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetSchemaAsync(String, String[], CancellationToken)	This is the asynchronous version of GetSchema(String, String[]). Providers should override with an appropriate implementation. The `cancellationToken` can optionally be honored. The default implementation invokes the synchronous GetSchema(String, String[]) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled `cancellationToken`. Exceptions thrown by GetSchema(String, String[]) will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService()	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
OnStateChange(StateChangeEventArgs)	Raises the StateChange event. (Inherited from DbConnection)
Open()	Opens a database connection with the property settings specified by the ConnectionString.
OpenAsync()	An asynchronous version of Open(), which opens a database connection with the settings specified by the ConnectionString. This method invokes the virtual method OpenAsync(CancellationToken) with CancellationToken.None. (Inherited from DbConnection)
OpenAsync(CancellationToken)	An asynchronous version of Open(), which opens a database connection with the property settings specified by the ConnectionString. 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.
OpenAsync(CancellationToken)	This is the asynchronous version of Open(). Providers should override with an appropriate implementation. The cancellation token can optionally be honored. The default implementation invokes the synchronous Open() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Open will be communicated via the returned Task Exception property. Do not invoke other methods and properties of the `DbConnection` object until the returned Task is complete. (Inherited from DbConnection)
RegisterColumnEncryptionKeyStoreProviders(IDictionary<String,SqlColumnEncryptionKeyStoreProvider>)	Registers the column encryption key store providers.
ResetStatistics()	If statistics gathering is enabled, all values are reset to zero.
RetrieveStatistics()	Returns a name value pair collection of statistics at the point in time the method is called.
ToString()	Returns a string that represents the current object. (Inherited from Object)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)

Events

Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)
InfoMessage	Occurs when SQL Server returns a warning or informational message.
StateChange	Occurs when the state of the connection changes.
StateChange	Occurs when the state of the connection changes. (Inherited from DbConnection)

Explicit Interface Implementations

ICloneable.Clone()	Creates a new object that is a copy of the current instance.
IDbConnection.BeginTransaction()	Begins a database transaction.
IDbConnection.BeginTransaction()	Begins a database transaction. (Inherited from DbConnection)
IDbConnection.BeginTransaction(IsolationLevel)	Begins a database transaction with the specified IsolationLevel value.
IDbConnection.BeginTransaction(IsolationLevel)	Begins a database transaction with the specified isolation level. (Inherited from DbConnection)
IDbConnection.CreateCommand()	Creates and returns a Command object that is associated with the connection.
IDbConnection.CreateCommand()	Creates and returns a DbCommand object that is associated with the current connection. (Inherited from DbConnection)

Applies to

Partager via