ServerConnection クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
public sealed class ServerConnection : Microsoft.SqlServer.Management.Common.ConnectionManager, Microsoft.SqlServer.Management.Common.ISfcConnection
type ServerConnection = class
inherit ConnectionManager
interface ISfcConnection
Public NotInheritable Class ServerConnection
Inherits ConnectionManager
Implements ISfcConnection
- 継承
- 実装
コンストラクター
| 名前 | 説明 |
|---|---|
| ServerConnection() | |
| ServerConnection(IRenewableToken) |
トークンを取り込む ServerConnection オブジェクトを作成します。 余分なブール値は、文字列を持つ別のコンストラクターが存在するため、このコンストラクターをオーバーロードするために使用されます。 |
| ServerConnection(SqlConnection, IRenewableToken) |
新しい ServerConnection オブジェクトを構築します。 |
| ServerConnection(SqlConnection, IRenewableToken) |
新しい ServerConnection オブジェクトを構築します。 |
| ServerConnection(SqlConnection) |
指定された SqlConnection から新しい ServerConnection オブジェクトを構築します。 |
| ServerConnection(SqlConnection) |
指定された SqlConnection から新しい ServerConnection オブジェクトを構築します。 |
| ServerConnection(SqlConnectionInfo) | |
| ServerConnection(String, String, SecureString) | |
| ServerConnection(String, String, String) | |
| ServerConnection(String) | |
フィールド
| 名前 | 説明 |
|---|---|
| NoConnectionTimeout |
無限待機 (継承元 ConnectionSettings) |
プロパティ
| 名前 | 説明 |
|---|---|
| AcceptsLogin |
LoginSecure と Authentication の現在の値が Login プロパティを使用する場合は true を返します。 (継承元 ConnectionSettings) |
| AccessToken | (継承元 ConnectionSettings) |
| ApplicationIntent |
接続の有効な値のアプリケーションの意図は、ReadWrite と ReadOnly です。 (継承元 ConnectionSettings) |
| ApplicationName |
アプリケーションの名前。 アプリケーション名が指定されていない場合は 'SQL Management' です。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| Authentication |
接続の認証の種類 (継承元 ConnectionSettings) |
| AutoDisconnectMode | (継承元 ConnectionManager) |
| BatchSeparator |
ExecuteNonQuery メソッドで使用されるバッチ区切り記号を定義します。 既定値は "GO" です。 バッチ区切り記号では、大文字と小文字が区別されません。 |
| CachedQueries |
ServerConnection インスタンスがクエリ結果をキャッシュする必要があるかどうかを示す値を取得または設定します。 |
| CapturedSql | (継承元 ConnectionManager) |
| ConnectAsUser |
true に設定すると、指定したユーザーの資格情報を使用して接続が確立されます。 これは偽装を前提としますが、LoginSecure フラグと Login フィールドと Password フィールドは影響を受けなくなります。 この設定は、Windowsでのみ使用できます。 (継承元 ConnectionSettings) |
| ConnectAsUserName |
偽装された接続を作成するときに使用するWindows ユーザーを指定します。 ユーザーは対話型ログオン特権を持っている必要があります。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (継承元 ConnectionSettings) |
| ConnectAsUserPassword |
偽装された接続を作成するときに使用するWindows ユーザーのパスワードを指定します。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (継承元 ConnectionSettings) |
| ConnectionProtocol |
接続プロトコル。 (継承元 ConnectionManager) |
| ConnectionString |
このプロパティは、ユーザーが指定した接続文字列を返すか、オブジェクト設定に基づいて計算された接続文字列を返します。 明示的に設定すると、渡された接続文字列を反映するように ServerConnection オブジェクト内のすべてのプロパティが設定されます。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| ConnectionType | |
| ConnectTimeout |
試行を終了して例外をスローする前に、サーバーへの接続を待機する時間 (秒単位)。 既定値は 30 秒です (Shiloh と同じです)。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| CurrentDatabase |
現在のデータベース コンテキストを返します。 (継承元 ConnectionManager) |
| DatabaseEngineEdition |
データベース エンジンのエディション (継承元 ConnectionManager) |
| DatabaseEngineType |
SQL Serverのデータベース エンジンの種類を返します。 例外: ConnectionFailureException (継承元 ConnectionManager) |
| DatabaseName |
TBD (継承元 ConnectionSettings) |
| EncryptConnection |
接続文字列で "encrypt=true" が指定されているかどうか (継承元 ConnectionSettings) |
| FixedServerRoles |
ログインがメンバーになっている固定サーバー ロールを指定した列挙型を返します。 |
| HostNameInCertificate |
証明書の検証に使用する証明書に指定されたホスト名。 (継承元 ConnectionSettings) |
| HostPlatform |
サーバーのホスト プラットフォーム (Linux/Windows/etc) (継承元 ConnectionManager) |
| InUse |
オブジェクトがサーバーに少なくとも 1 回接続されている場合は true を返します。 true の場合、プロパティの変更はそれ以上許可されず、プロパティが変更されたときに ConnectionCannotBeChangedException がスローされます。 (継承元 ConnectionManager) |
| IsContainedAuthentication |
包含認証を使用してデータベース エンジンが認証を行う場合は true を返します。 例外: ConnectionFailureException (継承元 ConnectionManager) |
| IsForceDisconnected |
接続が強制的に切断されたことを示します (継承元 ConnectionManager) |
| IsOpen |
SqlConnection オブジェクトがサーバーに接続されている場合は true を返します。 これは、プールされた接続が操作の直後に常に閉じられるため、プールされていない接続の場合にのみ true を返すことができます。 (継承元 ConnectionManager) |
| LockTimeout |
LockTimeout は、ロック タイムアウト (秒単位) です。 既定の -1 は無期限です。 InvalidPropertyValueException は、他のすべての負の数値に対してスローされます。 正の LockTimeout には 1000 が乗算され、"SET LOCK_TIMEOUT" 設定に使用されます。 (継承元 ConnectionManager) |
| Login |
サーバーへの接続に使用するSQL Server ログイン名。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (継承元 ConnectionSettings) |
| LoginSecure |
true に設定すると、統合セキュリティWindows使用され、ログインとパスワードは無視されます。 設定されていない場合は、Sql Server 認証が使用されます。 例外: ConnectionCannotBeChangedException (継承元 ConnectionSettings) |
| MaxPoolSize |
プールに格納できる最大接続数。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| MinPoolSize |
プールで維持できる最小接続数。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| MultipleActiveResultSets |
接続から MARS を有効にします。 既定値は falseです。 (継承元 ConnectionSettings) |
| NetworkProtocol |
SQL Serverへの接続に使用されるクライアント ネットワーク プロトコルを識別します。 ネットワークを指定せず、ローカル サーバーを使用する場合は、共有メモリが使用されます。 ネットワークを指定せず、リモート サーバーを使用する場合は、構成されているクライアント プロトコルのいずれかが使用されます。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| NonPooledConnection |
既定では、SQL Serverへのすべての接続は ADO.NET 接続プールから取得されます。true に設定すると、ユーザーはプールされていない接続を作成できます (閉じたときに再利用されません)。 例外: ConnectionCannotBeChangedException (継承元 ConnectionSettings) |
| PacketSize |
SQL Server のインスタンスとの通信に使用されるネットワーク パケットのサイズ (バイト単位)。 既定値は 8192 です。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| ParameterizationMode |
すべての ServerConnection インスタンスで使用 QueryParameterizationMode QueryParameterizationMode を示す値を取得または設定します。 |
| Password |
ログインでサーバーに接続するために使用されるパスワード。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (継承元 ConnectionSettings) |
| PooledConnectionLifetime |
プールに接続が返されると、その作成時刻が現在の時刻と比較され、その期間 (秒単位) が接続の有効期間で指定された値を超えると、接続は破棄されます。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| ProcessID |
ProcessID プロパティは、ServerConnection オブジェクトによって使用される接続のSQL Serverプロセス識別子を返します。 |
| ProductVersion |
この接続の ProductVersion サーバー プロパティを取得します。 (継承元 ConnectionManager) |
| RequiresLogin |
LoginSecure と認証の現在の値に Login プロパティを設定する必要がある場合は true を返します。 (継承元 ConnectionSettings) |
| ResetConnectionString |
ConnectionManager の SqlConnectionObject プロパティで ConnectionString をリセットする必要があるかどうかを示します。 (継承元 ConnectionSettings) |
| SecureConnectionString |
このプロパティは、ユーザーが指定した接続文字列の SecureString バージョンを返すか、オブジェクト設定に基づいて計算された接続文字列を返します。 明示的に設定すると、渡された接続文字列を反映するように ServerConnection オブジェクト内のすべてのプロパティが設定されます。 例外: ConnectionCannotBeChangedException (継承元 ConnectionSettings) |
| SecurePassword |
ログインでサーバーに接続するために使用されるパスワード。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (継承元 ConnectionSettings) |
| ServerCertificate |
証明書の検証に使用するサーバー証明書のパス。 (継承元 ConnectionSettings) |
| ServerInstance |
オブジェクトが接続するSQL Serverの名前。 設定されていない場合、ローカル サーバーは暗黙的に指定されます。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
| ServerVersion |
SQL Serverのメジャー バージョン番号を返します。 つまり、SQL Server 2000 の場合は 8 です。 例外: ConnectionFailureException (継承元 ConnectionManager) |
| SqlConnectionObject |
ConnectionContext オブジェクトによって使用される SqlConnection オブジェクトへの参照を返します。 これは常に、有効な最新の ConnectionString セットを持つ有効な sqlConnection オブジェクトを返す必要があります。 例外: PropertyNotAvailableException (継承元 ConnectionManager) |
| SqlExecutionModes |
SQL ステートメントがキャプチャされるか、サーバーに送信されるかを判断します。 |
| StatementTimeout |
これは、ステートメントがサーバーに送信されてから失敗するまでの秒数です。 既定値は 600 秒です (Shiloh と同じです)。 例外: InvalidPropertyValueException |
| StrictEncryption |
接続文字列で "encrypt=strict" が指定されているかどうか。 true の場合、 EncryptConnection の値は無視されます。 (継承元 ConnectionSettings) |
| TransactionDepth |
オブジェクト モデルによってカウントされるトランザクションの深さを提供します。 これには、サーバーで開始された可能性があるトランザクションや、ExecuteNonQuery メソッドを使用して BEGIN TRAN を発行したトランザクションは含まれません。 |
| TrueLogin |
TrueLogin プロパティは、現在の接続で使用されるログイン レコード名を返します。 |
| TrueName |
TrueName プロパティは、グローバル関数@@INSTANCENAME SQL Server Microsoft ®の結果セットを返します。 |
| TrustServerCertificate |
クライアントがサーバー証明書を信頼するかどうかを示す (継承元 ConnectionSettings) |
| UseMode |
すべての ServerConnection インスタンスで使用 DeferredUseMode UseMode を取得または設定します。 |
| UserProfile |
UserProfile プロパティは、現在の接続で使用されるMicrosoft SQL Server ログインの概要ロールの説明を返します。 |
| WorkstationId |
SQL Server に接続するワークステーションの名前。 例外: ConnectionCannotBeChangedException InvalidPropertyValueException (継承元 ConnectionSettings) |
メソッド
| 名前 | 説明 |
|---|---|
| BeginTransaction() |
新しいトランザクションを開始します。 CaptureMode が true の場合、トランザクション ステートメントがキャプチャ バッファーに追加されます。トランザクションを入れ子にすることができます。 開かれたすべてのトランザクションをコミットまたはロールバックするのはユーザーの責任です。 オブジェクト モデルによって出力されるすべての T-SQL がトランザクションによってカプセル化されるとは限りません。 さらに、変更されたオブジェクトの状態は、トランザクションがコミットされるまで、またはトランザクションがロールバックされるまで、実際のデータベースの状態を反映しません。 ユーザーは、影響を受けるオブジェクトを更新する必要があります。 慎重に使用してください。 |
| Cancel() | |
| ChangePassword(SecureString) | |
| ChangePassword(String) | |
| CheckServerVersion(ServerVersion) |
サポートされているサーバー バージョンに接続しているかどうかを確認します。 block off <= 7.0 in ServerConnection. (継承元 ConnectionManager) |
| CommitTransaction() |
トランザクションをコミットします。 CaptureMode が true の場合、トランザクション コマンドがキャプチャ バッファーに追加されます。 例外: NotInTransactionException |
| Connect() |
SQL Serverへの実際の接続を作成します。 既に接続されている場合は無視されます。 必要に応じて接続が開かれるため、このメソッドの呼び出しは省略可能です。 例外: ConnectionFailureException (継承元 ConnectionManager) |
| Copy() |
この関数は、ディープ コピーを実行します。 |
| Disconnect() |
SQL Serverを使用して接続を閉じます。 既に切断されている場合は無視されます。 例外: ConnectionFailureException (継承元 ConnectionManager) |
| ExecuteNonQuery(String, ExecutionTypes, Boolean) |
T-SQL ステートメントを実行します。 コマンド の副音子 ('GO') は ExecuteNonQuery によって認識されます。 バッチは個別に送信および実行されます。 CaptureMode が true に設定されている場合、ステートメントは記録され、実行されません。 影響を受ける行数を含む int 値が返されます。 複数のバッチが実行されると、すべてのバッチの影響を受ける行の合計数が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteNonQuery(String, ExecutionTypes) |
T-SQL ステートメントを実行します。 コマンド の副音子 ('GO') は ExecuteNonQuery によって認識されます。 バッチは個別に送信および実行されます。 CaptureMode が true に設定されている場合、ステートメントは記録され、実行されません。 影響を受ける行数を含む int 値が返されます。 複数のバッチが実行されると、すべてのバッチの影響を受ける行の合計数が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteNonQuery(String) | |
| ExecuteNonQuery(StringCollection, ExecutionTypes, Boolean) |
StringCollection で T-SQL ステートメントを実行します。 コマンド の副音子 ('GO') は ExecuteNonQuery によって認識されます。 GO ステートメントで区切られたバッチが個別に送信され、実行されます。 CaptureMode が true に設定されている場合、ステートメントは記録され、実行されません。 StringCollection の各ステートメントで影響を受ける行数を含む int 値の配列が返されます。 複数のバッチが実行されると、すべてのバッチの影響を受ける行の合計数が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteNonQuery(StringCollection, ExecutionTypes) |
StringCollection で T-SQL ステートメントを実行します。 コマンド の副音子 ('GO') は ExecuteNonQuery によって認識されます。 GO ステートメントで区切られたバッチが個別に送信され、実行されます。 CaptureMode が true に設定されている場合、ステートメントは記録され、実行されません。 StringCollection の各ステートメントで影響を受ける行数を含む int 値の配列が返されます。 複数のバッチが実行されると、すべてのバッチの影響を受ける行の合計数が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteNonQuery(StringCollection) | |
| ExecuteReader(String, SqlCommand) |
T-SQL ステートメントを実行します。 SQL Serverによって返される行のストリームを読み取るために使用できる SqlDataReader オブジェクトが返されます。 実行時間の長いクエリの中止が必要な場合は、データ リーダー パイプを取り消すために使用できる SqlCommand オブジェクトも返されます。 例外が自動的に切断されない: ConnectionFailureException ExecutionFailureExeception |
| ExecuteReader(String, SqlCommand) |
T-SQL ステートメントを実行します。 SQL Serverによって返される行のストリームを読み取るために使用できる SqlDataReader オブジェクトが返されます。 実行時間の長いクエリの中止が必要な場合は、データ リーダー パイプを取り消すために使用できる SqlCommand オブジェクトも返されます。 例外が自動的に切断されない: ConnectionFailureException ExecutionFailureExeception |
| ExecuteReader(String) |
T-SQL ステートメントを実行します。 SQL Serverによって返される行のストリームを読み取るために使用できる SqlDataReader オブジェクトが返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外が自動的に切断されない: ConnectionFailureException ExecutionFailureExeception |
| ExecuteScalar(String) |
T-SQL ステートメントを実行します。 結果セットの最初の行の最初の列を含むオブジェクトが返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteScalar(StringCollection) |
StringCollection で T-SQL ステートメントを実行します。 実行された各ステートメントの結果セットの最初の行の最初の列を含むオブジェクトの配列が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteTSql(ConnectionManager+ExecuteTSqlAction, Object, DataSet, Boolean) |
パラメーターとして渡されるアクション情報に応じて、適切なメソッドを使用して T-SQL を実行します。 (継承元 ConnectionManager) |
| ExecuteWithResults(String, Boolean) |
sqlCommand で T-SQL ステートメントを実行します。 結果を含む DataSet が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteWithResults(String) |
sqlCommand で T-SQL ステートメントを実行します。 結果を含む DataSet が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ExecuteWithResults(StringCollection) |
StringCollection で T-SQL ステートメントを実行します。 StringCollection 内の各ステートメントの結果を含む DataSet の配列が返されます。 サーバーとの接続が開かっていない場合は、Connect() メソッドが呼び出されます。 例外: ConnectionFailureException ExecutionFailureExeception |
| ForceDisconnected() |
切断を強制し、接続を再度開くことができないことを確認します (継承元 ConnectionManager) |
| GetDatabaseConnection(String, Boolean, IRenewableToken) |
接続文字列で指定されたデータベース名を持つ接続を返します。現在の接続が既に指定されたデータベースを参照している場合は、現在の接続が返されます。 |
| GetDatabaseConnection(String, Boolean) |
接続文字列で指定されたデータベース名を持つ接続を返します。 現在の接続が既に指定されたデータベースを参照している場合は、現在の接続が返されます。 |
| IsInFixedServerRole(FixedServerRoles) |
ログインが指定されたサーバー ロールのメンバーであるかどうかをテストします。 |
| NormalizeQuery(String, Boolean) |
リテラルが埋め込まれたクエリを正規化された形式に変換する (すべてのリテラルが標準トークンに置き換えられます) |
| NormalizeQuery(String) |
上記の関数のオーバーロード -- 詳細については、それを参照してください |
| RollBackTransaction() |
トランザクションを中止します (行われたすべての変更はデータベースに保存されません)。 CaptureMode が true の場合、トランザクション コマンドがキャプチャ バッファーに追加されます。 例外: NotInTransactionException |
| ThrowIfPropertyNotSet(String, String, Boolean) | (継承元 ConnectionSettings) |
| ThrowIfPropertyNotSet(String, String) | (継承元 ConnectionSettings) |
| ToString() | (継承元 ConnectionSettings) |
イベント
| 名前 | 説明 |
|---|---|
| InfoMessage |
SQL Serverが警告または情報メッセージを返したときに発生します。 SqlClient.SqlInfoMessageEventHandler を使用します。 (継承元 ConnectionManager) |
| RemoteLoginFailed |
サーバーがリモート サーバーに接続する必要があり、ログインに失敗したときに呼び出されます (継承元 ConnectionManager) |
| ServerMessage |
SQL Serverが警告または情報メッセージを返したときに発生します。 SqlClient.SqlInfoMessageEventHandler を使用します。 (継承元 ConnectionManager) |
| StateChange |
接続の状態が変更されたときに発生します。 System.Data.StateChangeEventHandler を使用します。 (継承元 ConnectionManager) |
| StatementExecuted | (継承元 ConnectionManager) |
明示的なインターフェイスの実装
| 名前 | 説明 |
|---|---|
| ISfcConnection.Connect() | |
| ISfcConnection.Copy() | |
| ISfcConnection.Disconnect() | |
| ISfcConnection.ServerVersion | |
| ISfcConnection.ToEnumeratorObject() | |