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.

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:
  • Added text to the Remarks section.

ClassDescription
CapturedSqlThe 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.
ChangePasswordFailureExceptionThe 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.
ConnectionCannotBeChangedExceptionThe 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.
ConnectionExceptionThe ConnectionException class is an exception that is raised when an error occurs on the connection to the instance of Microsoft SQL Server.
ConnectionFailureExceptionThe 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.
ConnectionInfoBaseThe 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.
ConnectionManagerThe ConnectionManager class manages the connection to an instance of SQL Server.
ConnectionSettingsThe 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.
DataTransferEventArgsThe DataTransferEventArgs class represents the arguments used when a data transfer event is raised.
DataTransferProgressEventArgsThe DataTransferProgressEventArgs class represents the arguments used when a data transfer progress event is raised.
ExecutionFailureExceptionThe ExecutionFailureException class is an exception that is raised when an execution failure is encountered on the connection to the server.
InvalidArgumentExceptionThe 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.
InvalidPropertyValueExceptionThe 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.
NotInTransactionExceptionThe NotInTransactionException class is an exception that is raised when an error occurs within a transaction on the referenced connection to the server.
OlapConnectionInfoThis class supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code.
PropertyNotAvailableExceptionThe PropertyNotAvailableException class is an exception that is raised when an unavailable property is requested on the connection to the server.
PropertyNotSetExceptionThe 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.
ServerConnectionThe ServerConnection object represents a connection to a server.
ServerMessageEventArgsThe ServerMessageEventArgs class represents the arguments used when a server message event is raised.
ServerVersionThe ServerVersion class represents the version information for the server.
SqlConnectionInfoThe SqlConnectionInfo object represents information that is required to establish a connection to an instance of SQL Server.
SqlOlapConnectionInfoBaseThe SqlOlapConnectionInfoBase class represents information used to connect to the instance of SQL Server.
SqlServerManagementExceptionThe SqlServerManagementException class is an exception that is raised when a Microsoft SQL Server management error is encountered on the connection to the server.
StatementEventArgsThe StatementEventArgs class represents the arguments used when a statement event is raised.
TransferExceptionThe TransferException class is an exception that is raised when a Microsoft SQL Server transfer error is encountered on the connection to the server.

InterfaceDescription
IAlterableThe IAlterable class represents an interface that implements the Alter method on the referenced connection.
ICreatableThe ICreatable class represents an interface that implements the Create method on the referenced connection.
IDataTransferProviderThe IDataTransferProvider class represents an interface that implements data transfers on the referenced connection.
IDroppableThe IDroppable class represents an interface that implements the Drop method on the referenced connection.
IMarkForDropThe IMarkForDrop class represents an interface that implements the IMarkForDrop method on the referenced connection.
IRenamableThe IRenamable class represents an interface that implements the Rename method on the referenced connection.
IRestrictedAccessThe IRestrictedAccess class represents an interface that implements single-user access to the server for the referenced connection.
ITransferMetadataProviderThe ITransferMetadataProvider class represents an interface that implements the transfer metadata process on the referenced connection.

DelegateDescription
DataTransferEventHandlerThe DataTransferEventHandler class represents the method that handles the event raised by the data transfer process.
DataTransferProgressEventHandlerThe DataTransferProgressEventHandler class represents the method that handles the event raised by the data transfer progress reporting process.
ServerMessageEventHandlerThe ServerMessageEventHandler class represents the method that handles the event raised by a server message.
StatementEventHandlerThe StatementEventHandler class represents the method that handles the event raised by a statement.

EnumerationDescription
AutoDisconnectModeThe AutoDisconnectMode enumeration contains values that are used to specify the automatic disconnection options for a connection to an instance of Microsoft SQL Server.
ConnectionTypeThe ConnectionType enumeration contains values that are used to specify the type of server with which the connection is established.
DataTransferEventTypeThe DataTransferEventType enumeration contains values that are used to specify the type of data transfer event.
DataTransferProgressEventTypeThe DataTransferProgressEventType enumeration contains values that are used to specify the type of data transfer progress event.
ExecutionTypesThe ExecutionTypes enumeration contains values that are used to specify execution options for the Transact-SQL commands sent to the server using the referenced connection.
FixedServerRolesThe FixedServerRoles enumeration contains values that are used to specify fixed server roles that can be assigned to logons.
NetworkProtocolThe NetworkProtocol enumeration contains values that are used to specify network protocols used on the network where the referenced connection is established.
ServerCaseSensitivityThe ServerCaseSensitivity enumeration contains values that are used to specify whether the server is sensitive to the case (lower or upper) of text.
ServerUserProfilesThe ServerUserProfiles enumeration contains values that are used to specify user profiles on the server.
SqlExecutionModesThe 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.

Community Additions

ADD
Show:
© 2014 Microsoft