• Article

Microsoft.SqlServer.Management.Common Namespace

The [Microsoft.SqlServer.Management.Common] namespace contains classes that provide connection functionality to the other SQL Server management namespaces.

The Microsoft.SqlServer.Management.Common namespace contains the classes that are used to establish a connection to an instance of SQL Server Database Engine. The most important class in this namespace is the ServerConnection class. The ServerConnection object lets you manage the connection to the instance of the Database Engine. It is referenced by various classes in the other manageability namespaces.

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.

Classes

  Class Description
Public class CapturedSql The 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 class ChangePasswordFailureException The 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 class ConnectionCannotBeChangedException The 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 class ConnectionException The ConnectionException class is an exception that is raised when an error occurs on the connection to the instance of SQL Server.
Public class ConnectionFailureException The 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 class ConnectionInfoBase The 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 class ConnectionManager The ConnectionManager class manages the connection to an instance of SQL Server.
Public class ConnectionSettings The 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 class DataTransferEventArgs The DataTransferEventArgs class represents the arguments used when a data transfer event is raised.
Public class DataTransferProgressEventArgs The DataTransferProgressEventArgs class represents the arguments used when a data transfer progress event is raised.
Public class DisconnectedConnectionException The DisconnectedConnectionException class is an exception that is raised when a connection is closed.
Public class ExecutionFailureException The ExecutionFailureException class is an exception that is raised when an execution failure is encountered on the connection to the server.
Public class InvalidArgumentException The exception that is raised when a parameter that is not valid is passed to a method on the referenced connection to the server.
Public class InvalidPropertyValueException The exception that is raised when a property is set to a value that is not valid on the referenced connection to the server.
Public class NotInTransactionException The exception that is raised when an error occurs within a transaction on the referenced connection to the server.
Public class OlapConnectionInfo This class supports the SMO infrastructure and is not intended to be used directly from your code.
Public class PropertyNotAvailableException The exception that is raised when an unavailable property is requested on the connection to the server.
Public class PropertyNotSetException The exception that is raised when a process requests a property that has not been set on the connection to the server.
Public class ServerComparer Represents the comparer class.
Public class ServerConnection The ServerConnection object represents a connection to a server.
Public class ServerMessageEventArgs The ServerMessageEventArgs class represents the arguments used when a server message event is raised.
Public class ServerVersion The ServerVersion class represents the version information for the server.
Public class SqlConnectionInfo The SqlConnectionInfo object represents information that is required to establish a connection to an instance of SQL Server.
Public class SqlOlapConnectionInfoBase The SqlOlapConnectionInfoBase class represents information used to connect to the instance of SQL Server.
Public class SqlServerManagementException The SqlServerManagementException class is an exception that is raised when a SQL Server management error is encountered on the connection to the server.
Public class StatementEventArgs The StatementEventArgs class represents the arguments used when a statement event is raised.
Public class TransferException The TransferException class is an exception that is raised when a SQL Server transfer error is encountered on the connection to the server.

Interfaces

  Interface Description
Public interface IAlterable Defines a method to alter an object on the referenced connection.
Public interface ICreatable Defines a method to create an object on the referenced connection.
Public interface IDataTransferProvider Defines methods and events for data transfers on the referenced connection.
Public interface IDroppable Defines a method to Drop an object on the referenced connection.
Public interface IMarkForDrop Defines a method that marks an object to be dropped.
Public interface IRefreshable Defines a method to refresh an object from the server on the referenced connection.
Public interface IRenamable Defines the Rename method on the referenced connection.
Public interface IRestrictedAccess Represents an interface that implements single-user access to the server for the referenced connection.
Public interface ISfcConnection Defines high-level properties and methods for server connections.
Public interface ITransferMetadataProvider Defines methods that are required for transferring metadata on the referenced connection.

Delegates

  Delegate Description
Public delegate DataTransferEventHandler The DataTransferEventHandler class represents the method that handles the event raised by the data transfer process.
Public delegate DataTransferProgressEventHandler Represents the method that handles events raised by the data transfer progress reporting process.
Public delegate ServerMessageEventHandler The ServerMessageEventHandler class represents the method that handles the event raised by a server message.
Public delegate StatementEventHandler The StatementEventHandler class represents the method that handles the event raised by a statement.

Enumerations

  Enumeration Description
Public enumeration AutoDisconnectMode Contains values that are used to specify the automatic disconnection options for a connection to an instance of SQL Server.
Protected enumeration ConnectionManager.ExecuteTSqlAction Execute a Transact-SQL action.
Public enumeration ConnectionType The ConnectionType enumeration contains values that are used to specify the type of server with which the connection is established.
Public enumeration DatabaseEngineType Database engine type of stand-alone instance of SQL Server or SQL Azure Database.
Public enumeration DataTransferEventType The DataTransferEventType enumeration contains values that are used to specify the type of data transfer event.
Public enumeration DataTransferProgressEventType The DataTransferProgressEventType enumeration contains values that are used to specify the type of data transfer progress event.
Public enumeration DeferredUseMode The DeferredUseMode enumeration contains values that specify how that deferred use can be instructed to handle Transact-SQL statements on the server connection. 
Public enumeration ExecutionTypes The 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 enumeration FixedServerRoles The FixedServerRoles enumeration contains values that are used to specify fixed server roles that can be assigned to logons.
Public enumeration NetworkProtocol Contains values that are used to specify network protocols used on the network where the referenced connection is established.
Public enumeration QueryParameterizationMode The QueryParameterizationMode enumeration contains values that are used to specify the way that queries with parameters are handled by the server connection.
Public enumeration ServerCaseSensitivity Contains values that are used to specify whether the server is sensitive to the case (lower or upper) of text.
Public enumeration ServerType The ServerType enumeration contains values that specify the different types of SQL Server services.
Public enumeration ServerUserProfiles The ServerUserProfiles enumeration contains values that are used to specify user profiles on the server.
Public enumeration SqlExecutionModes The 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.