SqlConnection クラス

定義

SQL Server データベースへの接続を表します。Represents a connection to a SQL Server database. このクラスは継承できません。This class cannot be inherited.

public ref class SqlConnection sealed : System::Data::Common::DbConnection, ICloneable, IDisposable
public sealed class SqlConnection : System.Data.Common.DbConnection, ICloneable, IDisposable
type SqlConnection = class
    inherit DbConnection
    interface IDbConnection
    interface ICloneable
    interface IDisposable
Public NotInheritable Class SqlConnection
Inherits DbConnection
Implements ICloneable, IDisposable
継承
実装

次の例では、SqlCommandSqlConnectionを作成します。The following example creates a SqlCommand and a SqlConnection. SqlConnection が開き、SqlCommandConnection として設定されます。The SqlConnection is opened and set as the Connection for the SqlCommand. この例では、ExecuteNonQueryを呼び出します。The example then calls ExecuteNonQuery. これを実現するために、ExecuteNonQuery には Transact-SQLTransact-SQL INSERT ステートメントである接続文字列とクエリ文字列が渡されます。To accomplish this, the ExecuteNonQuery is passed a connection string and a query string that is a Transact-SQLTransact-SQL INSERT statement. コードが using ブロックを終了すると、接続は自動的に閉じられます。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

注釈

SqlConnection オブジェクトは、SQL Server データソースへの一意のセッションを表します。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 は、Microsoft SQL Server データベースに接続するときのパフォーマンスを向上させるために、SqlDataAdapter および SqlCommand と共に使用されます。SqlConnection is used together with SqlDataAdapter and SqlCommand to increase performance when connecting to a Microsoft SQL Server database. すべてのサードパーティ SQL Server 製品、およびその他の OLE DB サポートされるデータソースについては、OleDbConnectionを使用します。For all third-party SQL Server products and other OLE DB-supported data sources, use OleDbConnection.

SqlConnectionのインスタンスを作成すると、すべてのプロパティが初期値に設定されます。When you create an instance of SqlConnection, all properties are set to their initial values. これらの値の一覧については、SqlConnection コンストラクターを参照してください。For a list of these values, see the SqlConnection constructor.

接続文字列のキーワードの一覧については、「ConnectionString」を参照してください。See ConnectionString for a list of the keywords in a connection string.

SqlConnection がスコープ外に出ると、閉じられません。If the SqlConnection goes out of scope, it won't be closed. そのため、Close または Disposeを呼び出すことによって、接続を明示的に閉じる必要があります。Therefore, you must explicitly close the connection by calling Close or Dispose. CloseDispose は機能的には同等です。Close and Dispose are functionally equivalent. Pooling 接続プールの値が true または yesに設定されている場合は、基になる接続が接続プールに返されます。If the connection pooling value Pooling is set to true or yes, the underlying connection is returned back to the connection pool. 一方、Poolingfalse または noに設定されている場合、サーバーへの基になる接続は実際に閉じられます。On the other hand, if Pooling is set to false or no, the underlying connection to the server is actually closed.

注意

接続が接続プールからフェッチされたり接続プールに返されたりしたとき、ログイン イベントとログアウト イベントはサーバーで発生しません。これは、接続プールに返されても接続は実際には終了していないためです。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. 詳しくは、「SQL Server の接続プール (ADO.NET)」をご覧ください。For more information, see SQL Server Connection Pooling (ADO.NET).

接続が常に閉じられるようにするには、次のコードに示すように、using ブロック内で接続を開きます。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.  
    }  

注意

高パフォーマンスのアプリケーションを展開するには、接続プールを使用する必要があります。To deploy high-performance applications, you must use connection pooling. SQL Server に .NET Framework Data Provider を使用する場合、プロバイダーはこれを自動的に管理するため、接続プールを有効にする必要はありません。ただし、一部の設定は変更できます。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. 詳しくは、「SQL Server の接続プール (ADO.NET)」をご覧ください。For more information, see SQL Server Connection Pooling (ADO.NET).

SqlCommandを実行しているメソッドによって SqlException が生成された場合、重大度レベルが19以下の場合、SqlConnection は開いたままになります。If a SqlException is generated by the method executing a SqlCommand, the SqlConnection remains open when the severity level is 19 or less. 重大度レベルが20以上の場合、サーバーは通常、SqlConnectionを閉じます。When the severity level is 20 or greater, the server ordinarily closes the SqlConnection. ただし、ユーザーは接続を再び開き、続行できます。However, the user can reopen the connection and continue.

SqlConnection オブジェクトのインスタンスを作成するアプリケーションは、宣言または命令型のセキュリティ要求を設定することによって、すべての直接および間接呼び出し元に、コードに対する十分なアクセス許可を与える必要があります。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 は、SqlClientPermission オブジェクトを使用してセキュリティ要求を行います。SqlConnection makes security demands using the SqlClientPermission object. ユーザーは、SqlClientPermissionAttribute オブジェクトを使用して、コードに十分なアクセス許可があることを確認できます。Users can verify that their code has sufficient permissions by using the SqlClientPermissionAttribute object. また、ユーザーと管理者は、 caspol.exe (コードアクセスセキュリティポリシーツール)を使用して、コンピューター、ユーザー、およびエンタープライズレベルのセキュリティポリシーを変更することもできます。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. 詳細については、「.NET でのセキュリティ」を参照してください。For more information, see Security in .NET. セキュリティ要求の使用方法を示す例については、「コードアクセスセキュリティと ADO.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. SQL Server エンジンのエラーとエラーメッセージの詳細については、「イベントとエラーのデータベースエンジン」を参照してください。For more information about SQL Server engine errors and error messages, see Database Engine Events and Errors.

注意事項

共有メモリではなく TCP を強制することができます。You can force TCP instead of shared memory. これを行うには、tcp: のプレフィックスを接続文字列のサーバー名に付けるか、localhost を使用します。You can do that by prefixing tcp: to the server name in the connection string or you can use localhost.

コンストラクター

SqlConnection()

SqlConnection クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlConnection class.

SqlConnection(String)

接続文字列を示す文字列を指定して、SqlConnection クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlConnection class when given a string that contains the connection string.

SqlConnection(String, SqlCredential)

Integrated Security = true と、ユーザー ID とパスワードを含む SqlCredential オブジェクトを使用しない接続文字列を指定して、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.

プロパティ

AccessToken

接続のアクセス トークンを取得または設定します。Gets or sets the access token for the connection.

CanRaiseEvents

コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。Gets a value indicating whether the component can raise an event.

(継承元 Component)
ClientConnectionId

試行成功したか失敗したかにかかわらず、最新の接続試行の接続 ID。The connection ID of the most recent connection attempt, regardless of whether the attempt succeeded or failed.

ColumnEncryptionKeyCacheTtl

Always Encrypted 機能の列暗号化キーのキャッシュ内の、列暗号化キー エントリの有効期限を取得または設定します。Gets or sets the time-to-live for column encryption key entries in the column encryption key cache for the Always Encrypted feature. 既定値は 2 時間です。The default value is 2 hours. 0 は、キャッシュがまったくないことを意味します。0 means no caching at all.

ColumnEncryptionQueryMetadataCacheEnabled

Always Encrypted が有効であるデータベースに対して実行されるパラメーター化されたクエリについて、クエリ メタデータのキャッシュが有効 (true) か無効 (false) かを示す値を取得または設定します。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. 既定値は true です。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. このプロパティは、セキュリティが損なわれ偽のキー パスを提供する SQL Server が関係するセキュリティ攻撃に対する保護を強化します。この攻撃は、キー ストアの資格情報漏洩につながるおそれがあります。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

SQL Server データベースを開くために使用する文字列を取得または設定します。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

IContainer を格納している Component を取得します。Gets the IContainer that contains the Component.

(継承元 Component)
Credential

この接続の SqlCredential オブジェクトを取得または設定します。Gets or sets the SqlCredential object for this connection.

Credentials
Database

現在のデータベース、または接続が開いてから使用するデータベースの名前を取得します。Gets the name of the current database or the database to be used after a connection is opened.

DataSource

接続先となる SQL Server のインスタンスの名前を取得します。Gets the name of the instance of SQL Server to which to connect.

DesignMode

Component が現在デザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the Component is currently in design mode.

(継承元 Component)
Events

Component に結び付けられているイベント ハンドラーのリストを取得します。Gets the list of event handlers that are attached to this Component.

(継承元 Component)
FireInfoMessageEventOnUserErrors

FireInfoMessageEventOnUserErrors プロパティを取得または設定します。Gets or sets the FireInfoMessageEventOnUserErrors property.

PacketSize

SQL Server のインスタンスと通信するために使用するネットワーク パケットのサイズ (バイト単位) を取得します。Gets the size (in bytes) of network packets used to communicate with an instance of SQL Server.

ServerVersion

クライアントが接続している SQL Server のインスタンスのバージョンを示す文字列を取得します。Gets a string that contains the version of the instance of SQL Server to which the client is connected.

Site

ComponentISite を取得または設定します。Gets or sets the ISite of the Component.

(継承元 Component)
State

接続で実行された最も新しいネットワーク操作時の SqlConnection の状態を示します。Indicates the state of the SqlConnection during the most recent network operation performed on the connection.

StatisticsEnabled

true に設定された場合、現在の接続について統計情報の収集が有効になります。When set to true, enables statistics gathering for the current connection.

WorkstationId

データベース クライアントを識別する文字列を取得します。Gets a string that identifies the database client.

メソッド

BeginTransaction()

データベース トランザクションを開始します。Starts a database transaction.

BeginTransaction(IsolationLevel)

分離レベルを指定して、データベース トランザクションを開始します。Starts a database transaction with the specified isolation level.

BeginTransaction(IsolationLevel, String)

分離レベルとトランザクション名を指定して、データベース トランザクションを開始します。Starts a database transaction with the specified isolation level and transaction name.

BeginTransaction(String)

トランザクション名を指定して、データベース トランザクションを開始します。Starts a database transaction with the specified transaction name.

ChangeDatabase(String)

開いている SqlConnection の現在のデータベースを変更します。Changes the current database for an open SqlConnection.

ChangePassword(String, SqlCredential, SecureString)

SqlCredential オブジェクトで指定されたユーザーの SQL Server のパスワードを変更します。Changes the SQL Server password for the user indicated in the SqlCredential object.

ChangePassword(String, String)

接続文字列で指定されているユーザーの SQL Server のパスワードを、指定された新しいパスワードに変更します。Changes the SQL Server password for the user indicated in the connection string to the supplied 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.

CreateCommand()

SqlConnection に関連付けられている SqlCommand オブジェクトを作成し、返します。Creates and returns a SqlCommand object associated with the SqlConnection.

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(継承元 MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。Releases all resources used by the Component.

(継承元 Component)
Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(継承元 Component)
EnlistDistributedTransaction(ITransaction)

分散トランザクションとして指定したトランザクションに参加します。Enlists in the specified transaction as a distributed transaction.

EnlistTransaction(Transaction)

分散トランザクションとして指定したトランザクションに参加します。Enlists in the specified transaction as a distributed transaction.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetLifetimeService()

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(継承元 MarshalByRefObject)
GetSchema()

この SqlConnection のデータ ソースのスキーマ情報を返します。Returns schema information for the data source of this SqlConnection. スキームの詳細については、「SQL Server スキーマ コレクション」を参照してください。For more information about scheme, see SQL Server Schema Collections.

GetSchema(String)

スキーマ名として指定した文字列を使用して、この SqlConnection のデータ ソースのスキーマ情報を返します。Returns schema information for the data source of this SqlConnection using the specified string for the schema name.

GetSchema(String, String[])

スキーマ名に指定した文字列と制限値に指定した文字列配列を使用して、この SqlConnection のデータ ソースのスキーマ情報を返します。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.

GetService(Type)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。Returns an object that represents a service provided by the Component or by its Container.

(継承元 Component)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
InitializeLifetimeService()

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。Obtains a lifetime service object to control the lifetime policy for this instance.

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。Creates a shallow copy of the current MarshalByRefObject object.

(継承元 MarshalByRefObject)
Open()

ConnectionString で指定したプロパティ設定を使用して、データベース接続を開きます。Opens a database connection with the property settings specified by the ConnectionString.

OpenAsync(CancellationToken)

ConnectionString で指定したプロパティ設定を使用してデータベース接続を開く Open() の非同期バージョン。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.

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()

Component の名前 (存在する場合) を格納する String を返します。Returns a String containing the name of the Component, if any. このメソッドはオーバーライドできません。This method should not be overridden.

(継承元 Component)

イベント

Disposed

Dispose() メソッドの呼び出しによってコンポーネントが破棄されると発生します。Occurs when the component is disposed by a call to the Dispose() method.

(継承元 Component)
InfoMessage

SQL Server が警告メッセージまたは情報メッセージを返したときに発生します。Occurs when SQL Server returns a warning or informational message.

StateChange

接続の状態が変化したときに発生します。Occurs when the state of the connection changes.

明示的なインターフェイスの実装

ICloneable.Clone()

現在のインスタンスのコピーである新しいオブジェクトを作成します。Creates a new object that is a copy of the current instance.

IDbConnection.BeginTransaction()

データベース トランザクションを開始します。Begins a database transaction.

IDbConnection.BeginTransaction(IsolationLevel)

指定した IsolationLevel 値を使用して、データベース トランザクションを開始します。Begins a database transaction with the specified IsolationLevel value.

IDbConnection.CreateCommand()

接続に関連付けられた Command オブジェクトを作成し、返します。Creates and returns a Command object that is associated with the connection.

適用対象

こちらもご覧ください