Export (0) Print
Expand All
Expand Minimize

Microsoft.SqlServer.Management.Common Namespace

The [Microsoft.SqlServer.Management.Common] namespace contains classes that represent a connection to an instance of SQL Server from an SMO or RMO application.

The Microsoft.SqlServer.Management.Common namespace contains the classes that are used to establish a connection to an instance of SQL Server. The classes are accessible by using the Server class in the Microsoft.SqlServer.Management.Smo namespace. The most important class in this namespace is the ServerConnection class. The ServerConnection object is referenced by the ConnectionContext property of the Server class, and lets you manage the connection to the instance of SQL Server.

The Microsoft.SqlServer.Management.Common namespace resides in the Microsoft.SqlServer.ConnectionInfo.dll assembly file.

By using the Microsoft.SqlServer.Management.Common namespace, you can do the following:

  • Connect to an instance of SQL Server.

  • Control the connection settings.

  • Run Transact-SQL statements directly.

  • Capture the Transact-SQL statements that are generated by the SMO program.

  • Manage transactions.

  ClassDescription
Public classCapturedSqlThe CapturedSql class represents the Transact-SQL commands that are sent to the instance of SQL Server by way of the referenced connection. However, they are then redirected to a buffer instead of running immediately on the instance of SQL Server.
Public classChangePasswordFailureExceptionThe ChangePasswordFailureException class is an exception that is raised when an unsuccessful attempt is made to change the password of the login that establishes a connection with the instance of SQL Server by using SQL Server Authentication.
Public classConnectionCannotBeChangedExceptionThe ConnectionCannotBeChangedException class is an exception that is raised when an unsuccessful attempt is made to change the connection to the instance of Microsoft SQL Server.
Public classConnectionExceptionThe ConnectionException class is an exception that is raised when an error occurs on the connection to the instance of SQL Server.
Public classConnectionFailureExceptionThe ConnectionFailureException class is an exception that is raised when an unsuccessful attempt is made to establish a connection with the instance of SQL Server.
Public classConnectionInfoBaseThe ConnectionInfoBase object is a base class that is used in the construction of the SqlOlapConnectionInfoBase class and it represents information used to connect to an instance of SQL Server.
Public classConnectionManagerThe ConnectionManager class manages the connection to an instance of SQL Server.
Public classConnectionSettingsThe ConnectionSettings class represents the settings used by a connection to an instance of a server, such as SQL Server. The ServerConnection class inherits ConnectionSettings class.
Public classDataTransferEventArgsThe DataTransferEventArgs class represents the arguments used when a data transfer event is raised.
Public classDataTransferProgressEventArgsThe DataTransferProgressEventArgs class represents the arguments used when a data transfer progress event is raised.
Public classExecutionFailureExceptionThe ExecutionFailureException class is an exception that is raised when an execution failure is encountered on the connection to the server.
Public classInvalidArgumentExceptionThe exception that is raised when a parameter that is not valid is passed to a method on the referenced connection to the server.
Public classInvalidPropertyValueExceptionThe exception that is raised when a property is set to a value that is not valid on the referenced connection to the server.
Public classNotInTransactionExceptionThe exception that is raised when an error occurs within a transaction on the referenced connection to the server.
Public classOlapConnectionInfoThis class supports the SMO infrastructure and is not intended to be used directly from your code.
Public classPropertyNotAvailableExceptionThe exception that is raised when an unavailable property is requested on the connection to the server.
Public classPropertyNotSetExceptionThe exception that is raised when a process requests a property that has not been set on the connection to the server.
Public classServerComparerRepresents the comparer class.
Public classServerConnectionThe ServerConnection object represents a connection to a server.
Public classServerMessageEventArgsThe ServerMessageEventArgs class represents the arguments used when a server message event is raised.
Public classServerVersionThe ServerVersion class represents the version information for the server.
Public classSqlConnectionInfoThe SqlConnectionInfo object represents information that is required to establish a connection to an instance of SQL Server.
Public classSqlOlapConnectionInfoBaseThe SqlOlapConnectionInfoBase class represents information used to connect to the instance of SQL Server.
Public classSqlServerManagementExceptionThe SqlServerManagementException class is an exception that is raised when a SQL Server management error is encountered on the connection to the server.
Public classStatementEventArgsThe StatementEventArgs class represents the arguments used when a statement event is raised.
Public classTransferExceptionThe TransferException class is an exception that is raised when a SQL Server transfer error is encountered on the connection to the server.

  InterfaceDescription
Public interfaceIAlterableDefines a method to alter an object on the referenced connection.
Public interfaceICreatableDefines a method to create an object on the referenced connection.
Public interfaceIDataTransferProviderDefines methods and events for data transfers on the referenced connection.
Public interfaceIDroppableDefines a method to Drop an object on the referenced connection.
Public interfaceIMarkForDropDefines a method that marks an object to be dropped.
Public interfaceIRefreshable
Public interfaceIRenamableDefines the Rename method on the referenced connection.
Public interfaceIRestrictedAccessRepresents an interface that implements single-user access to the server for the referenced connection.
Public interfaceISfcConnectionDefines high-level properties and methods for server connections.
Public interfaceITransferMetadataProviderDefines methods that are required for transferring metadata on the referenced connection.

  DelegateDescription
Public delegateDataTransferEventHandlerThe DataTransferEventHandler class represents the method that handles the event raised by the data transfer process.
Public delegateDataTransferProgressEventHandlerRepresents the method that handles events raised by the data transfer progress reporting process.
Public delegateServerMessageEventHandlerThe ServerMessageEventHandler class represents the method that handles the event raised by a server message.
Public delegateStatementEventHandlerThe StatementEventHandler class represents the method that handles the event raised by a statement.

  EnumerationDescription
Public enumerationAutoDisconnectModeContains values that are used to specify the automatic disconnection options for a connection to an instance of SQL Server.
Public enumerationConnectionTypeThe ConnectionType enumeration contains values that are used to specify the type of server with which the connection is established.
Public enumerationDataTransferEventTypeThe DataTransferEventType enumeration contains values that are used to specify the type of data transfer event.
Public enumerationDataTransferProgressEventTypeThe DataTransferProgressEventType enumeration contains values that are used to specify the type of data transfer progress event.
Public enumerationDeferredUseModeThe DeferredUseMode enumeration contains values that specify how that deferred use can be instructed to handle Transact-SQL statements on the server connection. 
Public enumerationExecutionTypesThe ExecutionTypes enumeration contains values that are used to specify execution options for the Transact-SQL commands sent to the server using the referenced connection.
Public enumerationFixedServerRolesThe FixedServerRoles enumeration contains values that are used to specify fixed server roles that can be assigned to logons.
Public enumerationNetworkProtocolContains values that are used to specify network protocols used on the network where the referenced connection is established.
Public enumerationQueryParameterizationModeThe QueryParameterizationMode enumeration contains values that are used to specify the way that queries with parameters are handled by the server connection.
Public enumerationServerCaseSensitivityContains values that are used to specify whether the server is sensitive to the case (lower or upper) of text.
Public enumerationServerTypeThe ServerType enumeration contains values that specify the different types of SQL Server services.
Public enumerationServerUserProfilesThe ServerUserProfiles enumeration contains values that are used to specify user profiles on the server.
Public enumerationSqlExecutionModesThe SqlExecutionModes enumeration contains values that are used to specify whether the commands sent to the referenced connection to the server are executed immediately or saved in a buffer.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft