ServerConnection 类
ServerConnection 对象表示到服务器的一个连接。
继承层次结构
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 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
ServerConnection() | 初始化 ServerConnection 类的新实例。 | |
ServerConnection(SqlConnection) | 使用指定的连接参数初始化 ServerConnection 类的新实例。 | |
ServerConnection(String) | 使用指定的服务器实例初始化 ServerConnection 类的新实例。 | |
ServerConnection(SqlConnectionInfo) | 使用指定的连接信息初始化 ServerConnection 类的新实例。 | |
ServerConnection(String, String, SecureString) | 使用指定的服务器实例和登录凭据初始化 ServerConnection 类的新实例。 | |
ServerConnection(String, String, String) | 使用指定的服务器实例和登录凭据初始化 ServerConnection 类的新实例。 |
顶部
属性
名称 | 说明 | |
---|---|---|
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 | 获取或设置 Boolean 属性,该属性指定是使用 Windows 身份验证还是 SQL Server 身份验证建立到服务器的连接。 (从 ConnectionSettings 继承。) | |
MaxPoolSize | 获取或设置与服务器建立连接时指定的连接接受的连接池中的最大连接数。 (从 ConnectionSettings 继承。) | |
MinPoolSize | 获取或设置与服务器建立连接时指定的连接接受的连接池中的最小连接数。 (从 ConnectionSettings 继承。) | |
MultipleActiveResultSets | 获取或设置 Boolean 属性值,该值指定是否允许多个活动的结果集。 (从 ConnectionSettings 继承。) | |
NetworkProtocol | 获取或设置用于与服务器建立连接的网络协议。 (从 ConnectionSettings 继承。) | |
NonPooledConnection | 获取或设置 Boolean 属性值,该值指定连接是否可入池。 (从 ConnectionSettings 继承。) | |
PacketSize | 获取或设置通过网络在客户端和服务器之间发送的数据包大小(字节)。 (从 ConnectionSettings 继承。) | |
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) | 执行返回一个或多个结果集的 Transact-SQL 语句。 | |
ExecuteReader(String, SqlCommand%) | 使用包含一个或多个结果集的 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 继承。) |
顶部
事件
名称 | 说明 | |
---|---|---|
InfoMessage | SQL Server 实例生成信息性消息时发生的事件。 (从 ConnectionManager 继承。) | |
RemoteLoginFailed | 远程登录名无法连接到 SQL Server 实例时,发生此事件。 (从 ConnectionManager 继承。) | |
ServerMessage | SQL Server 返回当前连接的警告或信息性消息时发生的事件。 (从 ConnectionManager 继承。) | |
StateChange | SQL Server 实例更改状态时发生的事件。 (从 ConnectionManager 继承。) | |
StatementExecuted | SQL Server 实例在当前连接上执行语句时发生的事件。 (从 ConnectionManager 继承。) |
顶部
显式接口实现
名称 | 说明 | |
---|---|---|
ISfcConnection.Connect | 返回一个值,该值指示要使用 SFC 连接进行连接的服务器。 | |
ISfcConnection.Copy | 使用 SFC 连接来复制服务器连接。 | |
ISfcConnection.Disconnect | 断开连接。 | |
ISfcConnection.ServerVersion | 获取服务器的版本。 | |
ISfcConnection.ToEnumeratorObject | 呈现服务器连接的枚举器对象。 |
顶部
注释
ServerConnection 类是 Server 类提供服务 , 并将 ReplicationServer 类 (例如类别。
通常 , 服务器对象 , 因为它将自动生成 , 您不必 DECLARE ServerConnection 对象的事例。 如果要存放重用的连接 , 请设置 DECLARE ServerConnection 对象变量。 服务器对象的 ConnectionContext 物产到目标点 ServerConnection 对象。 ServerConnection 对象包含与服务器对象和 SQL Server之间的连接物产相关的事例。 您可以使用它观看或修改连接的某些方面 , 例如进程 ID, 处理事务 , 身份验证模式 , 执行方式和直接甚至跑 Transact-SQL 命令。
通过使用 ServerConnection 对象 , 您可以执行以下操作:
Transact-SQL 跑声明直接对事例与 SQL Server的连接。
更改连接设置 , 例如身份验证方法。
开始 , 并进行回滚事务。
夺取 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
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。
请参阅
参考
Microsoft.SqlServer.Management.Common 命名空间