Microsoft.SqlServer.Management.Common Namespace

Classes

CapturedSql
ChangePasswordFailureException

TBD

CommonDisplayCategoryKeyAttribute

The key used to look up the localized property category

CommonDisplayDescriptionKeyAttribute

The key used to look up the localized description

CommonDisplayNameKeyAttribute

The key used to look up the localized property name

CommonLocalizableEnumConverter

The CommonLocalizableEnumConverter allows for the values of an Enum to be converted to localized strings based on the DisplayNameKey attribute applied to the individual items in the Enum.

CommonLocalizedPropertyResourcesAttribute

The name of the resources containing localized property category, name, and description strings

ConnectionCannotBeChangedException

TBD

ConnectionEnumsHelpers

Set of helper methods for use with the enums defined here

ConnectionException

TBD

ConnectionFailureException

TBD

ConnectionInfoBase
ConnectionInfoHelper
ConnectionManager

connection settings and creation

ConnectionSettings

connection settings and creation

DataTransferEventArgs
DataTransferProgressEventArgs
DisconnectedConnectionException

This exception is thrown when an attempt is made to use a connected that is forced in disconnected mode

ExecuteBatch
ExecutionFailureException

TBD

HostPlatformNames

Possible values for Server.HostPlatform property in SMO

InvalidArgumentException

TBD

InvalidPropertyValueException

TBD

NetCoreHelpers
NotInTransactionException

TBD

OlapConnectionInfo
PropertyNotAvailableException

TBD

PropertyNotSetException

TBD

ServerComparer
ServerConnection
ServerMessageEventArgs

Arguments for the event handler

ServerVersion

server version

SqlConnectionInfo
SqlConnectionInfoWithConnection
SqlOlapConnectionInfoBase
SqlServerManagementException
StatementEventArgs

This class contains the details of an executed Sql statement.

TransferException

This is the exception that will be thrown by the transfer operation

TypeConverters

Type converters to use to translate enum values to their string values and back

Interfaces

IAlterable
ICommonDynamicVisible

The ICommonDynamicVisible interface should be implemented by any class that wants to limit the visibility of certain Enum values based on state of the class at that moment.

If a class contains a property which exposes an Enum and that class implements the ICommonDynamicVisible interface then it will be called for each property that is of an Enum type.

The context param can be used to determine for which Enum this method is being called. If a class only has one Enum it is not necessary to make this check.

The way to limit the visibility of certain items is to simply remove the unwanted Enum values from the values ArrayList. This method is called on every drop down of the enum so it is possible to change the list on each and every drop down. If the list will not change once it has been initially determined caching the ArrayList and returning it would be helpful.

Care should be taken to ensure that you are not removing values that the Enum property is already set to. This will not cause any errors as all Enum values are still valid but when the user clicks on the dropdown they will not see the current choice as an option.

Also no new values should be added to the list since these values will not be convertable to valid Enum values and an error will be thrown at runtime. If more dynamic control is needed then consider using the DynamicValues design.

ICreatable
ICreateOrAlterable

Interface for CreateOrAlter method. All classes that support create or alter implement this interface.

IDataTransferProvider

This interface abstracts the data transfer mechanism

IDropIfExists

Interface for DropIfExists method. All classes that support drop with existence check implement this interface.

IDroppable
IMarkForDrop
IRefreshable
IRenamable
IRenewableToken

Simple interface to hide details of access token renewal. Consumers of this interface must defer retrieval of the token string until the point of SqlConnectionUsage

IRestrictedAccess
ISafeRenamable

Implemented by objects that may prefer to have the UI confirm the rename before proceeding

ISfcConnection

This interface is a high-level connection interface.

ITransferMetadataProvider

This interface abstracts the metadata provider - which is the component that computes the metadata needed in the transfer process

Enums

AutoDisconnectMode

regulates the disconnect policy

ConnectionManager.ExecuteTSqlAction

Defines all the Methods used to Execute T-SQL on a server in the ServerConnection object.

ConnectionType
DatabaseEngineEdition

the possible values of server edition - match SERVERPROPERTY('EngineEdition')

DatabaseEngineType

the possible values of server configuration

DataTransferEventType
DataTransferProgressEventType
DeferredUseMode
ExecutionTypes
FixedServerRoles
NetworkProtocol

Network protocols

QueryParameterizationMode
ServerCaseSensitivity
ServerType

Valid connection types

ServerUserProfiles
SqlConnectionInfo.AuthenticationMethod

The Authentication Method used to log in

SqlExecutionModes

Determines if SQL statements are captured or sent to the server.

Delegates

DataTransferEventHandler
DataTransferProgressEventHandler
ServerMessageEventHandler

the prototype of the callback method

StatementEventHandler

Event Handler for Statements