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.
Updated text:17 July 2006
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.
Release |
History |
17 July 2006 |
Changed content:
|
Classes
| Class | Description |
|---|---|
| CapturedSql | The CapturedSql class represents the Transact-SQL commands that are sent to the instance of Microsoft SQL Server by way of the referenced connection but then redirected to a buffer rather than run immediately on the instance of SQL Server. |
| ChangePasswordFailureException | The ChangePasswordFailureException class is an exception that is raised when an unsuccessful attempt is made to change the password of the logon used to establish a connection with the instance of Microsoft SQL Server by using SQL Server Authentication. |
| 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. |
| ConnectionException | The ConnectionException class is an exception that is raised when an error occurs on the connection to the instance of Microsoft SQL Server. |
| ConnectionFailureException | The ConnectionFailureException class is an exception that is raised when an unsuccessful attempt is made to establish a connection with the instance of Microsoft SQL Server. |
| 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. |
| ConnectionManager | The ConnectionManager class manages the connection to an instance of SQL Server. |
| ConnectionSettings | The ConnectionSettings class represents the settings used by a connection to an instance of a server, such as Microsoft SQL Server. The ServerConnection class inherits ConnectionSettings class. |
| DataTransferEventArgs | The DataTransferEventArgs class represents the arguments used when a data transfer event is raised. |
| DataTransferProgressEventArgs | The DataTransferProgressEventArgs class represents the arguments used when a data transfer progress event is raised. |
| ExecutionFailureException | The ExecutionFailureException class is an exception that is raised when an execution failure is encountered on the connection to the server. |
| InvalidArgumentException | The InvalidArgumentException class is an exception that is raised when a parameter that is not valid is passed to a method on the referenced connection to the server. |
| InvalidPropertyValueException | The InvalidPropertyValueException class is an exception that is raised when a property is set to a value that is not valid on the referenced connection to the server. |
| NotInTransactionException | The NotInTransactionException class is an exception that is raised when an error occurs within a transaction on the referenced connection to the server. |
| OlapConnectionInfo | This class supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. |
| PropertyNotAvailableException | The PropertyNotAvailableException class is an exception that is raised when an unavailable property is requested on the connection to the server. |
| PropertyNotSetException | The PropertyNotSetException class is an exception that is raised when a process requests a property that has not been set on the connection to the server. |
| ServerConnection | The ServerConnection object represents a connection to a server. |
| ServerMessageEventArgs | The ServerMessageEventArgs class represents the arguments used when a server message event is raised. |
| ServerVersion | The ServerVersion class represents the version information for the server. |
| SqlConnectionInfo | The SqlConnectionInfo object represents information that is required to establish a connection to an instance of SQL Server. |
| SqlOlapConnectionInfoBase | The SqlOlapConnectionInfoBase class represents information used to connect to the instance of SQL Server. |
| SqlServerManagementException | The SqlServerManagementException class is an exception that is raised when a Microsoft SQL Server management error is encountered on the connection to the server. |
| StatementEventArgs | The StatementEventArgs class represents the arguments used when a statement event is raised. |
| TransferException | The TransferException class is an exception that is raised when a Microsoft SQL Server transfer error is encountered on the connection to the server. |
Interfaces
| Interface | Description |
|---|---|
| IAlterable | The IAlterable class represents an interface that implements the Alter method on the referenced connection. |
| ICreatable | The ICreatable class represents an interface that implements the Create method on the referenced connection. |
| IDataTransferProvider | The IDataTransferProvider class represents an interface that implements data transfers on the referenced connection. |
| IDroppable | The IDroppable class represents an interface that implements the Drop method on the referenced connection. |
| IMarkForDrop | The IMarkForDrop class represents an interface that implements the IMarkForDrop method on the referenced connection. |
| IRenamable | The IRenamable class represents an interface that implements the Rename method on the referenced connection. |
| IRestrictedAccess | The IRestrictedAccess class represents an interface that implements single-user access to the server for the referenced connection. |
| ITransferMetadataProvider | The ITransferMetadataProvider class represents an interface that implements the transfer metadata process on the referenced connection. |
Delegates
| Delegate | Description |
|---|---|
| DataTransferEventHandler | The DataTransferEventHandler class represents the method that handles the event raised by the data transfer process. |
| DataTransferProgressEventHandler | The DataTransferProgressEventHandler class represents the method that handles the event raised by the data transfer progress reporting process. |
| ServerMessageEventHandler | The ServerMessageEventHandler class represents the method that handles the event raised by a server message. |
| StatementEventHandler | The StatementEventHandler class represents the method that handles the event raised by a statement. |
Enumerations
| Enumeration | Description |
|---|---|
| AutoDisconnectMode | The AutoDisconnectMode enumeration contains values that are used to specify the automatic disconnection options for a connection to an instance of Microsoft SQL Server. |
| ConnectionType | The ConnectionType enumeration contains values that are used to specify the type of server with which the connection is established. |
| DataTransferEventType | The DataTransferEventType enumeration contains values that are used to specify the type of data transfer event. |
| DataTransferProgressEventType | The DataTransferProgressEventType enumeration contains values that are used to specify the type of data transfer progress event. |
| 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. |
| FixedServerRoles | The FixedServerRoles enumeration contains values that are used to specify fixed server roles that can be assigned to logons. |
| NetworkProtocol | The NetworkProtocol enumeration contains values that are used to specify network protocols used on the network where the referenced connection is established. |
| ServerCaseSensitivity | The ServerCaseSensitivity enumeration contains values that are used to specify whether the server is sensitive to the case (lower or upper) of text. |
| ServerUserProfiles | The ServerUserProfiles enumeration contains values that are used to specify user profiles on the server. |
| 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. |