ServerConnection クラス
ServerConnection オブジェクトは、サーバーへの接続を表します。
継承階層
System.Object
Microsoft.SqlServer.Management.Common.ConnectionSettings
Microsoft.SqlServer.Management.Common.ConnectionManager
Microsoft.SqlServer.Management.Common.ServerConnection
名前空間: Microsoft.SqlServer.Management.Common
アセンブリ: Microsoft.SqlServer.ConnectionInfo (Microsoft.SqlServer.ConnectionInfo.dll)
構文
'宣言
Public NotInheritable Class ServerConnection _
Inherits ConnectionManager _
Implements ISfcConnection
'使用
Dim instance As ServerConnection
public sealed class ServerConnection : ConnectionManager,
ISfcConnection
public ref class ServerConnection sealed : public ConnectionManager,
ISfcConnection
[<SealedAttribute>]
type ServerConnection =
class
inherit ConnectionManager
interface ISfcConnection
end
public final class ServerConnection extends ConnectionManager implements ISfcConnection
ServerConnection 型は、以下のメンバーを公開しています。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
ServerConnection() | ServerConnection クラスの新しいインスタンスを初期化します。 |
|
ServerConnection(SqlConnection) | 指定された接続パラメーターを使用して、ServerConnection クラスの新しいインスタンスを初期化します。 |
|
ServerConnection(String) | 指定されたサーバー インスタンスを使用して、ServerConnection クラスの新しいインスタンスを初期化します。 |
|
ServerConnection(SqlConnectionInfo) | 指定された接続情報を使用して、ServerConnection クラスの新しいインスタンスを初期化します。 |
|
ServerConnection(String, String, SecureString) | 指定されたサーバー インスタンスおよびログオン資格情報を使用して、ServerConnection クラスの新しいインスタンスを初期化します。 |
|
ServerConnection(String, String, String) | 指定されたサーバー インスタンスおよびログオン資格情報を使用して、ServerConnection クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
ApplicationName | サーバーとの接続を確立したアプリケーションの名前を取得または設定します。 (ConnectionSettings から継承されています。) |
|
AutoDisconnectMode | SQL Server のインスタンスへの参照された接続の自動切断モードを取得または設定します。 (ConnectionManager から継承されています。) |
|
BatchSeparator | 参照された接続でバッチを区切るために使用する文字列値を取得または設定します。 |
|
CapturedSql | キャプチャ モードで接続が実行されているときにキャプチャされた Transact-SQL ステートメントを取得します。 (ConnectionManager から継承されています。) |
|
ConnectAsUser | 接続が権限の借用を使用して確立されるかどうかを示す Boolean プロパティ値を取得または設定します。 (ConnectionSettings から継承されています。) |
|
ConnectAsUserName | 権限の借用を使用して接続する場合のユーザーの名前を取得または設定します。 (ConnectionSettings から継承されています。) |
|
ConnectAsUserPassword | 権限の借用を使用して接続する場合のユーザーのパスワードを取得または設定します。 (ConnectionSettings から継承されています。) |
|
ConnectionString | 指定されたデータ ソースに接続するための接続文字列を取得または設定します。 (ConnectionSettings から継承されています。) |
|
ConnectionType | サーバーで使用する接続の種類を取得します。 |
|
ConnectTimeout | 接続タイムアウト時間 (秒数) を取得または設定します。 (ConnectionSettings から継承されています。) |
|
DatabaseEngineType | データベース エンジンの種類を取得します。 (ConnectionManager から継承されています。) |
|
DatabaseName | 接続に必要なデータベースを取得または設定します。 (ConnectionSettings から継承されています。) |
|
EncryptConnection | 接続が暗号化されるかどうかを示す Boolean プロパティ値を取得または設定します。 (ConnectionSettings から継承されています。) |
|
FixedServerRoles | 参照された接続に関連付けられた固定サーバー ロールを取得します。 |
|
InUse | 接続が使用中であるかどうかを示す Boolean プロパティ値を取得または設定します。 (ConnectionManager から継承されています。) |
|
IsForceDisconnected | 接続が強制的に切断されたかどうかを示す Boolean 値を取得します。 (ConnectionManager から継承されています。) |
|
IsOpen | 現在、接続が開いているかどうかを示す Boolean プロパティ値を取得します。 (ConnectionManager から継承されています。) |
|
LockTimeout | 現在のトランザクションがロックされているとき、接続がタイムアウトするまでの時間を秒単位で取得または設定します。 (ConnectionManager から継承されています。) |
|
Login | サーバーのインスタンスとの接続を確立するために必要なログオンを取得または設定します。 (ConnectionSettings から継承されています。) |
|
LoginSecure | サーバーへの接続時に Windows 認証を使用するか、SQL Server 認証を使用するかを示す Boolean プロパティを取得または設定します。 (ConnectionSettings から継承されています。) |
|
MaxPoolSize | サーバーとの接続を確立する際に、指定した接続の接続プールに格納できる最大接続数を取得または設定します。 (ConnectionSettings から継承されています。) |
|
MinPoolSize | サーバーとの接続を確立する際に、指定した接続の接続プールに格納できる最小接続数を取得または設定します。 (ConnectionSettings から継承されています。) |
|
MultipleActiveResultSets | 複数のアクティブな結果セットが許可されるかどうかを示す Boolean プロパティ値を取得または設定します。 (ConnectionSettings から継承されています。) |
|
NetworkProtocol | サーバーへの接続を確立するためのネットワーク プロトコルを取得または設定します。 (ConnectionSettings から継承されています。) |
|
NonPooledConnection | 接続をプールできるかどうかを示す Boolean プロパティ値を取得または設定します。 (ConnectionSettings から継承されています。) |
|
PacketSize | クライアントとサーバーの間で、ネットワークを経由して送信されたデータのパケット (バイト数) を取得または設定します。 (ConnectionSettings から継承されています。) |
.gif "静的メンバー") |
ParameterizationMode | サーバー接続のパラメーター化モードを取得または設定します。 |
|
Password | SQL Server 認証を使用してサーバーへ接続するためのログオン パスワードを取得または設定します。 (ConnectionSettings から継承されています。) |
|
PooledConnectionLifetime | プールされた接続の有効期間を取得または設定します。 (ConnectionSettings から継承されています。) |
|
ProcessID | サーバーへの参照された接続に関連付けられたプロセスを一意に識別する ID 値を取得します。 |
|
SecureConnectionString | 暗号化された接続文字列を取得または設定します。 (ConnectionSettings から継承されています。) |
|
SecurePassword | SQL Server 認証を使用してサーバーへ接続する場合に、ログオンで使用するセキュリティで保護されたパスワードを取得または設定します。 (ConnectionSettings から継承されています。) |
|
ServerInstance | サーバーの名前を取得または設定します。 (ConnectionSettings から継承されています。) |
|
ServerVersion | 接続している SQL Server インスタンスのバージョンを取得します。 (ConnectionManager から継承されています。) |
|
SqlConnectionObject | 接続オブジェクトを取得します。 (ConnectionManager から継承されています。) |
|
SqlExecutionModes | サーバーへの参照された接続に関連付けられた実行モードを取得または設定します。 |
|
StatementTimeout | ステートメントの実行がタイムアウト エラーで失敗するまでの秒数を取得または設定します。 |
|
TransactionDepth | 参照された接続の現在のトランザクションの深さを取得します。 |
|
TrueLogin | 参照された接続で使用する現在のログオン レコード名を取得します。 |
|
TrueName | サーバーの名前を取得します。 |
|
UseMode | 指定されたモードを使用してサーバー接続を取得または設定します。 |
|
UserProfile | 参照された接続に関連付けられたユーザー プロファイルを取得します。 |
|
WorkstationId | ワークステーションを一意に識別する ID 値を取得または設定します。 (ConnectionSettings から継承されています。) |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
|
BeginTransaction | 参照された接続でトランザクションを開始します。 |
|
Cancel | 接続を取り消します。 |
|
ChangePassword(SecureString) | 標準認証で使用するログイン パスワードを変更します。 |
|
ChangePassword(String) | 標準認証で使用するログオン パスワードを変更します。 |
|
CommitTransaction | 参照された接続で現在のトランザクションをコミットします。 |
|
Connect | SQL Server のインスタンスに接続します。 (ConnectionManager から継承されています。) |
|
Copy | ServerConnection オブジェクトのコピーが返されます。 |
|
Disconnect | SQL Server のインスタンスとの接続を切断します。 (ConnectionManager から継承されています。) |
|
Equals | (Object から継承されています。) |
|
ExecuteNonQuery(StringCollection) | 結果セットを返さないステートメントのバッチを実行します。 |
|
ExecuteNonQuery(String) | 結果セットを返さないステートメントを実行します。 |
|
ExecuteNonQuery(StringCollection, ExecutionTypes) | 指定された実行オプションで、結果セットを返さないステートメントのバッチを実行します。 |
|
ExecuteNonQuery(String, ExecutionTypes) | 指定された実行オプションで、結果セットを返さないステートメントを実行します。 |
|
ExecuteReader(String) | 1 つ以上の結果セットを返す Transact-SQL ステートメントを実行します。 |
|
ExecuteReader(String, SqlCommand%) | 1 つ以上の結果セットを格納した SqlDataReader オブジェクト値を使用してリーダーを実行します。 |
|
ExecuteScalar(StringCollection) | Transact-SQL ステートメントのバッチを実行し、オブジェクトの値として先頭行の最初の列を返します。 |
|
ExecuteScalar(String) | Transact-SQL ステートメントを実行し、オブジェクトの値として先頭行の最初の列を返します。 |
|
ExecuteWithResults(StringCollection) | 複数の結果セットを返す Transact-SQL ステートメントのバッチを実行します。 |
|
ExecuteWithResults(String) | 結果セットを返す Transact-SQL ステートメントを実行します。 |
|
ForceDisconnected | SQL Server のインスタンスから強制的に切断します。 (ConnectionManager から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetType | (Object から継承されています。) |
|
IsInFixedServerRole | 参照された接続に関連付けられたログオンが、指定された固定サーバー ロールのメンバーであるかどうかをテストします。 |
|
NormalizeQuery(String) | クエリ テキストを表す文字列入力を使用します。 |
|
NormalizeQuery(String, Boolean) | サーバー接続を制御するクエリを正規化します。 |
|
RollBackTransaction | 現在のトランザクションをロールバックします。 |
|
ToString | 参照されたオブジェクトの名前を文字列として返します。 (ConnectionSettings から継承されています。) |
先頭に戻る
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
InfoMessage | SQL Server のインスタンスが情報メッセージを生成したときに発生するイベントです。 (ConnectionManager から継承されています。) |
|
RemoteLoginFailed | このイベントは、リモート ログインが SQL Server のインスタンスへの接続に失敗すると発生します。 (ConnectionManager から継承されています。) |
|
ServerMessage | SQL Server が現在の接続に関する警告または情報メッセージを返した場合に発生するイベントです。 (ConnectionManager から継承されています。) |
|
StateChange | SQL Server のインスタンスが状態を変更すると発生するイベントです。 (ConnectionManager から継承されています。) |
|
StatementExecuted | SQL Server のインスタンスが現在の接続でステートメントを実行したときに発生するイベントです。 (ConnectionManager から継承されています。) |
先頭に戻る
明示的なインターフェイスの実装
| 名前 | 説明 | |
|---|---|---|
.gif "明示的なインターフェイスの実装") .gif "プライベート メソッド") |
ISfcConnection.Connect | SFC 接続を使用して接続するサーバーを示す値を返します。 |
|
ISfcConnection.Copy | SFC 接続を使用してサーバー接続をコピーします。 |
|
ISfcConnection.Disconnect | 接続を切断します。 |
.gif "プライベート プロパティ") |
ISfcConnection.ServerVersion | サーバーのバージョンを取得します。 |
|
ISfcConnection.ToEnumeratorObject | サーバー接続の列挙子オブジェクトを表示します。 |
先頭に戻る
説明
ServerConnection クラスは、Server クラス、および ReplicationServer クラスなどのレプリケーション クラスによって処理されます。
ServerConnection オブジェクトのインスタンスは通常、サーバー オブジェクトを使用して自動的に作成されるので、宣言する必要はありません。 接続設定を再利用できるように保存する場合は、ServerConnection オブジェクト変数を宣言します。 サーバー オブジェクトの ConnectionContext プロパティは、ServerConnection オブジェクトを指します。 ServerConnection オブジェクトには、サーバー オブジェクトと SQL Server のインスタンス間の接続に関連するプロパティが含まれています。 プロセス ID、処理中のトランザクション、認証モード、実行モードなどの特定の接続設定を表示または変更したり、Transact-SQL コマンドを直接実行したりするために使用できます。
ServerConnection オブジェクトを使用すると、次のような操作を実行できます。
SQL Server のインスタンスへの接続に対して Transact-SQL ステートメントを直接実行する。
認証方法などの接続設定を変更する。
トランザクションを開始し、コミットしてロールバックする。
SMO アプリケーションによって生成された Transact-SQL ステートメントをキャプチャする。
使用例
Database オブジェクトを使用したこのメソッドの他の例については、「[M:Microsoft.SqlServer.Management.Smo.Database.ExecuteNonQuery(System.String]」を参照してください。
VB
'Declare a ServerConnection object variable to specify SQL authentication, login and password.
Dim conn As New ServerConnection
conn.LoginSecure = False
conn.Login = vlogin
conn.Password = vpassword
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server(conn)
'The actual connection is made when a property is retrieved.
Console.WriteLine(srv.Information.Version)
'The connection is automatically disconnected when the Server variable goes out of scope.
PowerShell
$conn = new-object Microsoft.SqlServer.Management.Common.ServerConnection
$conn.LoginSecure = $FALSE
$conn.Login = vlogin
$conn.Password = vpassword
#Connect to the local, default instance of SQL Server
$srv = new-object Microsoft.SqlServer.Management.Smo.Server($conn)
Write-Host $srv.Information.Version
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Common 名前空間