Microsoft.SqlServer.Management.Smo Namespace

The Microsoft.SqlServer.Management.Smo namespace contains classes that represent the core SQL Server Database Engine objects. These include instances, databases, tables, stored procedures, and views.

Classes

AbstractCollectionBase

The AbstractCollectionBase object is a base class object that is used in the construction of collection objects.

AffinityInfo

The AffinityInfo object represents the Affinity settings for all CPUs and NUMA nodes on an Instance of SQL Server. Access to the AffinityInfo object is provided though the Server object.

AffinityInfoBase

Represents a base class of AffinityInfo.

ApplicationRole

The ApplicationRole object represents a security role that is used to set access privileges from an application regardless of the user's permissions.

ApplicationRoleCollection

The ApplicationRoleCollectionclass represents a collection of ApplicationRole objects that represent all the application roles on the referenced database.

ApplicationRoleEvents

The ApplicationRoleEvents object represents the settings required for Microsoft SQL Server application role event notification.

ArrayListCollectionBase

The ArrayListCollectionBase object represents a base class that is used in the construction of collections that are based on array lists.

AsymmetricKey

The AsymmetricKey object represents a SQL Server asymmetric key.

AsymmetricKeyCollection

The AsymmetricKeyCollection class represents a collection of AsymmetricKey objects that represent all the asymmetric keys on the referenced database.

AsyncStatus

The AsyncStatus object represents the status of an asynchronous process.

Audit

The Audit object represents a SQL Server audit log.

AuditCollection

The AuditCollection class represents a collection of Audit objects that represent all the audits on the instance of SQL Server.

AuditExtender

Adds methods and properties to the Audit object.

AuditSpecification

The AuditSpecification class defines the audit groups and specifies the server audit that they belong to.

AvailabilityDatabase

Represents the availability database.

AvailabilityDatabaseCollection

Represents the collection of databases contained in the availability group.

AvailabilityGroup

Displays the availability group that contains the databases and replicas.

AvailabilityGroupCollection

Displays a collection of specified objects in the availability group.

AvailabilityGroupListener

Represents the object of the availability group listener.

AvailabilityGroupListenerCollection

Represents a collection of AvailabilityGroupListener objects.

AvailabilityGroupListenerIPAddress

Represents an availability group listener IP address.

AvailabilityGroupListenerIPAddressCollection

Represents a collection of AvailabilityGroupListenerIPAddress objects.

AvailabilityGroupListenerIPAddressCollectionBase

Represents a class that contains common features of all schema collection classes.

AvailabilityGroupState

Represents an adapter class that implements the IAvailabilityGroupState logical facet for an availability group.

AvailabilityReplica

Displays the availability replica and its properties.

AvailabilityReplicaCollection

Represents the AvailabilityReplicaCollection objects.

Backup

The Backup object provides programmatic access to Microsoft SQL Server backup operations.

BackupDevice

The BackupDevice object provides programmatic access to SQL Server backup devices.

BackupDeviceCollection

The BackupDeviceCollection class represents a collection of BackupDevice objects that represent all the backup devices on an instance of SQL Server.

BackupDeviceItem

The BackupDeviceItem object provides programmatic access to named SQL Server backup devices.

BackupDeviceList

The BackupDeviceList object provides programmatic access to a list backup devices.

BackupEncryptionOptions

Specifies backup encryption option.

BackupMedia

Represents a backup media.

BackupMediaSet

Represents a Backup media set.

BackupMediaSet.IncompleteBackupMediaSetException

The exception that is thrown when the backup media set is not complete.

BackupRestoreBase

The BackupRestoreBase class is a base class that represents functionality that is common to both backup and restore operations.

BackupSet

Represents the backup set.

BackupSetCollection

Represents a collection of backup set.

Certificate

The Certificate object represents a SQL Server certificate.

CertificateCollection

The CertificateCollection class represents a collection of Certificate objects that represent all the certificates on an instance of SQL Server.

CertificateEvents

The CertificateEvents object represents the settings that are required for SQL Server Certificate event notification.

Check

The Check object represents a SQL Server check constraint.

CheckCollection

The CheckCollection class represents a collection of Check objects that represent all the check constraints defined on the parent object.

CollectionNotAvailableException

The CollectionNotAvailableException class is an exception that is raised when an attempt is made to retrieve a collection that is not available.

Column

The Column object represents a SQL Server column.

ColumnCollection

The ColumnCollection class represents a collection of Column objects that represent all the columns defined on a table.

ColumnEncryptionKey

Represents the column encryption key.

ColumnEncryptionKeyCollection

Represents a collection of column encryption key.

ColumnEncryptionKeyValue

Represents the value of the column encryption key.

ColumnEncryptionKeyValueCollection

Represents a collection of column encryption key value.

ColumnEncryptionKeyValueCollectionBase

Represents the list of the column encryption key value collection base class.

ColumnMasterKey

Represents the column master key.

ColumnMasterKeyCollection

Represents a collection of column master key.

ConfigProperty

The ConfigProperty object contains information pertaining to a Microsoft SQL Server configuration option, such as maximum, minimum, current, and new values.

ConfigPropertyCollection

The ConfigPropertyCollection class represents a collection of ConfigProperty objects that represent all the configuration properties defined on the instance of SQL Server.

Configuration

Represents the Configuration class that contains the configuration information for the instance of SQL Server.

ConfigurationBase

The ConfigurationBase class is a base class that represents configuration information for the instance of SQL Server.

Cpu

The Cpu class contains information about one CPU on an instance of SQL Server.

CpuCollection

The CpuCollection class represents a collection of Cpu objects that represent all the CPUs that are defined on an instance of SQL Server.

CreateRestorePlanEventArgs

Provides data for the create restore plan event.

Credential

The Credential object represents a Microsoft SQL Server credential.

CredentialCollection

The CredentialCollection class represents a collection of Credential objects that represent all the credentials defined on the instance of Microsoft SQL Server.

CryptographicProvider

The CryptographicProvider object represents a SQL Server cryptographic provider.

CryptographicProviderCollection

A collection of type CryptographicProviderCollection that represents a collection of CryptographicProviderr objects.

Database

Represents an SQL Server database.

DatabaseActiveDirectory

The DatabaseActiveDirectory object provides programmatic access to the Active Directory settings for a database.

DatabaseAdapter

Database Adapter type to be used as a management facet.

DatabaseAdapterBase

Represents a database adapter base.

DatabaseAuditSpecification

The DatabaseAuditSpecification object represents an auditable event on the database.

DatabaseAuditSpecificationCollection

The DatabaseAuditSpecificationCollection class represents a collection of DatabaseAuditSpecification objects that represent all the audit specifications defined on the database.

DatabaseAuditSpecificationExtender

Adds methods and properties to the DatabaseAuditSpecification object.

DatabaseCollection

The DatabaseCollection class represents a collection of Database objects that represent all the databases defined on the instance of SQL Server.

DatabaseDdlTrigger

The DatabaseDdlTrigger object represents a SQL Server database data definition language (DDL) trigger.

DatabaseDdlTriggerCollection

The DatabaseDdlTriggerCollection class represents a collection of DatabaseDdlTrigger objects that represent all the database data definition language (DDL) triggers defined on a table.

DatabaseDdlTriggerEvent

Represents the DatabaseDdlTriggerEvent object represents the SQL Server database DDL trigger events that can be included in a database DDL trigger event set.

DatabaseDdlTriggerEventSet

The DatabaseDdlTriggerEventSet object represents a set of SQL Server database data definition language (DDL) trigger events.

DatabaseEncryptionKey

Creates a database encryption key.

DatabaseEncryptionKeyExtender

Extends the database encryption key class.

DatabaseEvent

The DatabaseEvent object represents the SQL Server database events that can be included in a database event set.

DatabaseEventArgs

The DatabaseEventArgs object represents the arguments passed by the event raised by the database.

DatabaseEvents

The DatabaseEvents object represents the settings required for Microsoft SQL Server database event notification.

DatabaseEventSet

The DatabaseEventSet object represents a SQL Server set of database events.

DatabaseFile

The DatabaseFile object is a base class used in the construction of DataFile objects and LogFile objects.

DatabaseFileMappingsDictionary

This class, which is inherited from Dictionary, maps database file paths from the source server to the corresponding target server location that the user specifies.

DatabaseMaintenanceAdapter

The Database Maintenance facet has logical properties. It inherits from the DatabaseAdapter class.

DatabaseMapping

The DatabaseMapping object represents a SQL Server database mapping.

DatabaseMirroringPayload

The DatabaseMirroringPayload object represents database mirroring payload settings.

DatabaseOptions

The DatabaseOptions object represents SQL Server database options.

DatabasePerformanceAdapter

The Database Performance facet implements logical properties relevant to database performance management.

DatabasePermission

The DatabasePermission object represents a SQL Server database permission. The database permission can be added to a database permission set, and then granted, revoked, or denied to a user.

DatabasePermissionInfo

The DatabasePermissionInfo object represents information about a SQL Server database permission.

DatabasePermissionSet

The DatabasePermissionSet object represents a SQL Server set of database permissions.

DatabaseReplicaState

Represents the runtime state of a database that’s participating in an availability group. This database may be located on any of the replicas that compose the availability group.

DatabaseReplicaStateCollection

Represents a collection of objects that represent all the database replica state defined on the parent database.

DatabaseReplicaStateCollectionBase

Represents a collection of DatabaseReplicaState objects that represent all the database replica states defined on the parent database.

DatabaseRestorePlanner

Represents the Database Restore Planner.

DatabaseRole

The DatabaseRole object represents a SQL Server database security role.

DatabaseRoleCollection

The DatabaseRoleCollection class represents a collection of DatabaseRole objects that represent all the database roles defined on the parent database.

DatabaseScopedCredential

Represents the database scoped credential.

DatabaseScopedCredentialCollection

Represents the database scoped credential collection.

DatabaseSecurityAdapter

Includes properties and methods that are used to expose the Database Security facet.

DatabaseSnapshotExtender

Adds methods and properties to the DatabaseSnapshot object.

DataFile

The DataFile object represents a SQL Server data file.

DataFileCollection

The DataFileCollection class represents a collection of DataFile objects that represent all the data files defined on the parent object.

DataTransferBase

Represents the data transfer base.

DataType

The DataType object represents a SQL Server data type.

DdlTriggerBase

The DdlTriggerBase is a base class that is inherited by the DatabaseDdlTrigger object. This represents a SQL Server database data definition language (DDL) trigger.

Default

The Default object represents a SQL Server default.

DefaultCollection

The DefaultCollection class represents a collection of Default objects.

DefaultConstraint

The DefaultConstraint object represents a SQL Server default constraint.

DefaultLanguage

Represents the list of all the default languages supported by Microsoft Search service.

DefaultRuleBase

The DefaultRuleBase class is a base class that is inherited by the Rule class and the Default class.

DependencyCollection

The DependencyCollection class represents a collection of Dependency objects that are used to derive the node classes in SMO scripting operations.

DependencyCollectionNode

The DependencyCollectionNode class represents a node in the dependency collection that is derived during scripting operations.

DependencyNode

The DependencyNode class represents a node that is defined by a URN address.

DependencyTree

The DependencyTree object represents a tree structure that contains SQL Server objects and their hierarchical relationships to each other.

DependencyTreeNode

The DependencyTreeNode class represents the child and sibling SQL Server objects within a DependencyTree object hierarchy.

DependencyWalker

The DependencyWalker object is a tool to perform scripting operations that involve dependencies such as identifying dependent relationships. The tool and converts this output to a list.

Endpoint

The Endpoint class represents an endpoint service that can listen natively for requests.

EndpointCollection

The EndpointCollection class represents a collection of Endpoint objects that represent all the HTTP endpoints.

EndpointPayload

The EndpointPayload object represents an endpoint payload.

EndpointProtocol

The EndpointProtocol object represents an HTTP endpoint protocol.

EnumToDisplayNameConverter

Represents an enumerator to display name converter.

EventProperty

The EventProperty class represents a property of an event.

EventPropertyCollection

The EventPropertyCollection object represents the properties of event objects.

EventSetBase

The EventSetBase class is a base class that is used to derive the event set objects.

ExecutionManager

The ExecutionManager object represents and manage the execution server.

ExtendedProperty

The ExtendedProperty object represents the extended properties that are defined for any object that has an ExtendedProperties collection property.

ExtendedPropertyCollection

The ExtendedPropertyCollection class represents a collection of ExtendedPropertyCollectionobjects that represent all the extended properties.

ExtendedStoredProcedure

The ExtendedStoredProcedure object represents an extended stored procedure on the instance of Microsoft SQL Server.

ExtendedStoredProcedureCollection

The ExtendedStoredProcedureCollection class represents a collection of ExtendedStoredProcedure objects that represent all the extended stored procedures defined on the parent database.

ExternalDataSource

Represents the external data source class.

ExternalDataSourceCollection

Represents a collection of external data source.

ExternalDataSourceTypeConverter

Provides a unified way of converting types of values to other types, as well as for accessing standard values and subproperties.

ExternalFileFormat

Represents the external file format.

ExternalFileFormatCollection

Represents the external file format collection.

ExternalFileFormatTypeConverter

Initializes External File Format Type Converter.

ExternalTableDistributionConverter

Represents the external table distribution converter.

ExternalTableRejectTypeConverter

Represents the external table reject type converter.

FailedOperationException

The FailedOperationException class represents the exception raised when an operation fails. Failed database operations include CREATE, DROP, ALTER, SCRIPT, REFRESH, RENAME. This exception can also be raised when some of the public methods in SMO fail.

Federation

Represents a federation object on the SQL Azure database.

FederationCollection

Represents a collection of federation objects.

FileGroup

The FileGroup object represents a SQL Server file group. For more information about file groups, see Using Filegroups and Files to Store Data.

FileGroupCollection

The FileGroupCollection class represents a collection of FileGroup objects that represent all the filegroups defined on the parent database.

ForeignKey

The ForeignKey object represents a SQL Server foreign key.

ForeignKeyCollection

The ForeignKeyCollection class represents a collection of ForeignKey objects that represent all the foreign keys defined on the parent object.

ForeignKeyColumn

The ForeignKeyColumn object represents a SQL Server foreign key column.

ForeignKeyColumnCollection

The ForeignKeyColumnCollection class represents a collection of ForeignKeyColumn objects that represent all the foreign key columns defined on the parent object.

FrequencyPair

The FrequencyPair object is a utility that measures frequency by storing count and duration information.

FullTextCatalog

The FullTextCatalog object represents a Microsoft Search full-text catalog.

FullTextCatalogCollection

The FullTextCatalogCollection class represents a collection of FullTextCatalog objects that represent all the full-text catalogs defined on the parent object.

FullTextIndex

The FullTextIndex object represents a Microsoft Search full-text index.

FullTextIndexColumn

The FullTextIndexColumn object represents a Microsoft Search full-text index column.

FullTextIndexColumnCollection

The FullTextIndexColumnCollection class represents a collection of FullTextIndexColumn objects that represent all the full-text index columns defined on the parent object.

FullTextService

The FullTextService object allows programmatic access to the Microsoft Search full-text settings.

FullTextStopList

The FullTextStopList object represents a full-text stop list.

FullTextStopListCollection

The FullTextStopListCollection class represents a collection of FullTextStopList objects that represent all the full-text stop lists that are defined on the parent database.

HttpProtocol

The HttpProtocol object represents an HTTP protocol on an instance of Microsoft SQL Server.

Index

The Index object represents a SQL Server index.

IndexCollection

The IndexCollection class represents a collection of Index objects that represent all the indexes defined on the instance of SQL Server.

IndexedColumn

The IndexedColumn object represents a SQL Server column that is participating in an index.

IndexedColumnCollection

The IndexedColumnCollection class represents a collection of IndexedColumn objects that represent all the indexed columns defined on the instance of SQL Server.

IndexedXmlPath

Represents an indexed XML path.

IndexedXmlPathCollection

Represents the collection of indexed XML paths.

IndexedXmlPathNamespace

Represents the indexed Xml path namespace.

IndexedXmlPathNamespaceCollection

Represents a collection of indexed XML path namespace.

IndexEvents

The IndexEvents object represents the settings that are required for SQL Server index event notification.

Information

The Information class contains nonconfigurable information about the instance of SQL Server. These include system information and options that are set during Setup, such as the collation.

InternalSmoErrorException

The InternalSmoErrorException class represents the exception raised when an error occurs during the internal phase of a SMO operation.

InvalidRestorePlanException

Exception thrown on trying to execute or verify an invalid Restore plan.

InvalidScriptingOptionException

The InvalidScriptingOptionException represents an exception due to an invalid scripting option.

InvalidSmoOperationException

The InvalidSmoOperationException class represents the exception raised when an SMO operation is not valid.

InvalidVersionSmoOperationException

The InvalidVersionSmoOperationException class represents the exception raised when the version is not valid on an SMO operation.

JobScheduleCollectionBase

The JobScheduleCollectionBase class represents a base class that is used in the construction of the JobScheduleCollection class.

Language

A Language object represents a language supported by SQL Server. The SQL Server language determines the date and time formats and the language in which the system messages are displayed.

LanguageCollection

The LanguageCollection class represents a collection of Language objects that represent all the languages which are defined on the instance of SQL Server.

LinkedServer

A LinkedServer object represents a database system other than SQL Server and is linked to the current instance of SQL Server by using an OLE DB driver.

LinkedServerCollection

The LinkedServerCollection class represents a collection of LinkedServer objects that represent all the linked servers registered on the instance of SQL Server.

LinkedServerLogin

The LinkedServerLogin object represents a SQL Server logon account that has permission to connect to the linked server.

LinkedServerLoginCollection

The LinkedServerLoginCollection class represents a collection of LinkedServerLogin objects that represent all the linked server logins defined on the linked server.

LogFile

The LogFile object represents a SQL Server log file.

LogFileCollection

The LogFileCollection class represents a collection of LogFile objects that represent all the log files defined on the instance of Microsoft SQL Server.

Login

The Login object represents a SQL Server login account that has been granted access to the instance of SQL Server through Windows Authentication or SQL Server Authentication.

LoginCollection

The LoginCollection class represents a collection of Login objects that represent all the login accounts defined on the instance of SQL Server.

LoginEvents

The LoginEvents object represents the settings required for SQL Server login event notification.

MasterKey

The MasterKey object represents a SQL Server database master key.

MessageCollectionBase

The MessageCollectionBase class is a base class that is used in the construction of message collection classes.

MessageObjectBase

The MessageObjectBase class is a base class that is inherited by message classes.

MissingObjectException

The MissingObjectException class represents the exception raised when an object is missing.

NamedSmoObject

Represents the NamedSmoObject object represents a named SMO object.

NextRestoreEventArgs

Represents the next restore event arguments.

NumaNode

The NumaNode object represents the settings for a NUMA node on an instance of SQL Server.

NumaNodeCollection

The NumaNodeCollection object contains information about one NUMA node on an instance of SQL Server.

NumberedObjectCollectionBase

The NumberedObjectCollectionBase class is a base class that represents common functionality for collections of numbered objects, such as the NumberedStoredProcedure object.

NumberedStoredProcedure

The NumberedStoredProcedure class represents a Microsoft SQL Server numbered stored procedure.

NumberedStoredProcedureCollection

The NumberedStoredProcedureCollection class represents a collection of NumberedStoredProcedure objects that represent all the numbered stored procedures defined on a table.

NumberedStoredProcedureParameter

The NumberedStoredProcedureParameter object represents a SQL Server numbered stored procedure parameter.

NumberedStoredProcedureParameterCollection

The NumberedStoredProcedureParameterCollection class represents a collection of NumberedStoredProcedure objects that represent all the numbered stored procedures defined on the parent object.

ObjectAlteredEventArgs

The ObjectAlteredEventArgs object represents the arguments that are passed by the event that is raised when an object is altered.

ObjectCreatedEventArgs

The ObjectCreatedEventArgs object represents the arguments that are passed by the event that is raised when an object is created.

ObjectDroppedEventArgs

The ObjectDroppedEventArgs object represents the arguments that are passed by the event that is raised when an object is dropped.

ObjectEvent

The ObjectEvent object represents the of SQL Server object events that can be included in an object event set.

ObjectEventSet

The ObjectEventSet object represents a SQL Server set of object events.

ObjectPermission

The ObjectPermission object represents a SQL Server object permission.

ObjectPermissionInfo

The ObjectPermissionInfo object represents information about a SQL Server object permission.

ObjectPermissionSet

The ObjectPermissionSet object represents a set of object permissions in Microsoft SQL Server.

ObjectRenamedEventArgs

The ObjectRenamedEventArgs object represents the arguments passed by the event raised when an object is renamed.

OleDbProviderSettings

Represents the settings for an SQL Server OLE DB provider.

OleDbProviderSettingsCollection

The OleDbProviderSettingsCollection class represents a collection of OleDbProviderSettings objects that represent all the OLE DB provider settings defined on the linked server.

OrderColumn

OrderColumn points to a column with an order that is specified within a table-valued function that was created by using CREATE FUNCTION and the ORDER BY clause.

OrderColumnCollection

Represents a collection of OrderColumn.

PageRestorePlanner

Represents the page restore planner.

Parameter

The Parameter class represents a parameter. It is a base class that is inherited by the StoredProcedureParameter class and the UserDefinedFunctionParameter class and contains common features of both classes.

ParameterBase

The ParameterBase class is a base class that is inherited by the Parameter class and the UserDefinedAggregate class. It contains common features of both classes.

ParameterCollectionBase

The ParameterCollectionBase class is a base class that is used in the construction of parameter collection classes.

PartitionFunction

The PartitionFunction object provides programmatic access to partition functions.

PartitionFunctionCollection

The PartitionFunctionCollection class represents a collection of PartitionFunction objects that represent all the partition functions defined on the instance of SQL Server.

PartitionFunctionEvents

The PartitionFunctionEvents object represents the settings required for SQL Server partition function event notification.

PartitionFunctionParameter

The PartitionFunctionParameter object provides programmatic access to partition function parameters.

PartitionFunctionParameterCollection

The PartitionFunctionParameterCollection class represents a collection of PartitionFunctionParameter objects that represent all the partition function parameters defined on the partition function.

PartitionNumberedObjectCollectionBase

The PartitionNumberedObjectCollectionBase is a base class that is inherited by the PhysicalPartitionCollection class.

PartitionScheme

The PartitionScheme object provides programmatic access to partition schemes.

PartitionSchemeCollection

The PartitionSchemeCollection class represents a collection of PartitionScheme objects that represent all the partition schemes defined on the instance of SQL Server.

PartitionSchemeEvents

The PartitionSchemeEvents object represents the settings required for Microsoft SQL Server partition scheme event notification.

PartitionSchemeParameter

The PartitionSchemeParameter object provides programmatic access to partition scheme parameters.

PartitionSchemeParameterCollection

The PartitionSchemeParameterCollection class represents a collection of PartitionSchemeParameter objects that represent all the partition scheme parameters defined on the partition scheme.

PathWrapper

Represents a path wrapper.

Payload

The Payload object represents a SQL Server HTTP endpoint payload.

PercentCompleteEventArgs

Represents the arguments passed by the event raised when a process reaches a percent complete marker.

PerformanceCounters

A PerformanceCounters object represents a performance counter that is used to trace the performance of the instance of SQL Server.

PermissionInfo

The PermissionInfo class represents information regarding granted or denied privileges.

PermissionSetBase

The PermissionSetBase class is a base class that is inherited by permission set classes.

PhysicalPartition

The PhysicalPartition object represents the physical partition where the data and meta data is stored for a SQL Server object.

PhysicalPartitionCollection

The PhysicalPartitionCollection class represents a collection of PhysicalPartition objects that represent all the physical partitions that are defined on an object.

PlanGuide

Creates a plan guide object: PlanGuide

PlanGuideCollection

Represents a collection of plan guide objects.

PlanGuideExtender

Extends the Property set for a Plan Guide

ProgressReportEventArgs

The ProgressReportEventArgs object provides programmatic access to the arguments used to report the progress of an operation that works through an object hierarchy, such as discovering dependencies in scripting operations.

Property

The Property object provides programmatic access to the properties of all the SMO objects.

PropertyCannotBeRetrievedException

The PropertyCannotBeRetrievedException class represents the exception raised when a property cannot be retrieved.

PropertyCollection

The PropertyCollection class represents a collection of Property objects that represent all the properties defined on the parent object.

PropertyNotSetException

The PropertyNotSetException class represents the exception that is raised when a property value has not been set.

PropertyReadOnlyException

The PropertyReadOnlyException class represents the exception that is raised when an attempt is made to set a read-only property.

PropertyTypeMismatchException

The PropertyTypeMismatchException class represents the exception raised when an attempt is made to set the property with a value that has the incorrect data type.

PropertyWriteException

The PropertyWriteException class represents the exception that is raised when an error occurs when setting the value of a property.

Protocol

The Protocol object provides programmatic access to the protocols supported by SQL Server.

QueryStoreOptions

Represents the query store options.

RelocateFile

The RelocateFile object is a programmatic tool that lets a file be relocated.

RemoteDataArchiveMigrationStatusReport

Represents the status report of the migration in remote data archive.

RemoteDatabaseMigrationStatistics

Initializes a new instance of RemoteDatabaseMigrationStatistics class.

RemoteTableMigrationStatistics

Represents a remote table migration statistics.

ResourceGovernor

Represents ResourceGovernor class.

ResourcePool

Resource Pool Class

ResourcePoolAffinityInfo

Represents information about the resource pool affinity.

ResourcePoolCollection

Represents a collection of Resource Pools.

Restore

The Restore object provides programmatic access to restore operations.

RestoreOptions

Represents the restore options.

RestorePlan

Represents a sequence of Database Restore operations which will recover a database to a particular state in a point in time.

Rule

The Rule object provides programmatic access to a SQL Server rule.

RuleCollection

The RuleCollection class represents a collection of Rule objects that represent all the rules defined on the instance of SQL Server.

Scheduler

Represents the scheduler associated with the Server Management Object.

SchedulerCollection

Represents a collection of scheduler.

Schema

The Schema object represents an ownership context for a SQL Server database object.

SchemaCollection

The SchemaCollection class represents a collection of Schema objects that represent all the schemas on the referenced database.

SchemaCollectionBase

The SchemaCollectionBase class is a base class that is inherited by the SchemaCollection class.

SchemaCustomResolver

Represents a diagram of a COM-based resolver.

SchemaEvents

The SchemaEvents object represents the settings required for SQL Server schema event notification.

Scripter

The Scripter object is the overall, top-level object for managing scripting operations.

ScriptingErrorEventArgs

The ScriptingErrorEventArgs object provides programmatic access to the arguments used to report the errors that occur during scripting operations.

ScriptingOptions

The ScriptingOptions object provides programmatic options to the options that can be set for scripting operations.

ScriptNameObjectBase

Represents a base class inherited by classes that can use an alternative name used in scripting operations.

ScriptOption

The ScriptOption object represents the SQL Server script options that can be included in scripting options that are set by using the ScriptingOptions object.

ScriptSchemaObjectBase

The ScriptSchemaObjectBase is a base class that is inherited by classes that can use an alternative name used in scripting operations.

ScriptWriterException

Represents an exception which occurred when trying to write a script.

SearchProperty

The SearchProperty object represents a search property on a SQL Server database object.

SearchPropertyCollection

The SearchPropertyCollection class represents a collection of search properties on a SQL Server database object.

SearchPropertyList

The SearchPropertyList represents a SearchPropertyCollection on a Database.

SearchPropertyListCollection

The SearchPropertyListCollection class represents a collection of type SearchPropertyList associated with a database.

SecurityPolicy

Represents the security policy.

SecurityPolicyCollection

Represents a collection of security policy.

SecurityPredicate

Represents the security predicate operation.

SecurityPredicateCollection

Represents the collection of the security predicate collection base objects.

SecurityPredicateCollectionBase

Represents the security predicate collection base.

SecurityPredicateOperationConverter

Represents the security predicate operation converter.

SecurityPredicateTypeConverter

Represents the security predicate type converter class.

Sequence

This class represents the SQL Server Sequence. A sequence is a user-defined schema bound object that generates a sequence of numeric values according to the specification with which the sequence was created. The sequence of numeric values is generated in an ascending or descending order at a defined interval and can be configured to restart (cycle) when exhausted. Sequences, unlike identity columns, are not associated with specific tables. Applications refer to a sequence object to retrieve its next value. The relationship between sequences and tables is controlled by the application. User applications can reference a sequence object and coordinate the values across multiple rows and tables.

SequenceCollection

The SequenceCollection class represents a collection of Sequence objects that represent all the Sequences on the referenced database.

SequenceEvents

The SequenceEvents object represents the settings required for Microsoft SQL Server Sequence event notification.

SequenceExtender

Contains additional functionality for the Sequence object.

Server

The Server object represents an instance of SQL Server.

ServerActiveDirectory

The ServerActiveDirectory object provides programmatic access to the Active Directory functionality.

ServerAdapter

This class aggregates otherwise hidden server properties.

ServerAdapterBase

A ServerAdapterBase object is a base class that is used in the construction of the ServerAdapter class.

ServerAuditSpecification

The ServerAuditSpecification object represents an auditable event on the instance of SQL Server.

ServerAuditSpecificationCollection

The ServerAuditSpecificationCollection class represents a collection of ServerAuditSpecification objects that represent all the audit specifications defined on the server.

ServerAuditSpecificationExtender

Adds methods and properties to the ServerAuditSpecification object.

ServerConfigurationAdapter

Exposes methods to refresh and alter server configuration properties.

ServerDdlTrigger

The ServerDdlTrigger object represents a SQL Server data definition language (DDL) trigger.

ServerDdlTriggerCollection

The ServerDdlTriggerCollection class represents a collection of ServerDdlTrigger objects that represent all the server data definition language (DDL) triggers defined on a table.

ServerDdlTriggerEvent

The ServerDdlTriggerEvent object represents the Microsoft SQL Server data definition language (DDL) trigger events that can be included in a server DDL trigger event set.

ServerDdlTriggerEventSet

The ServerDdlTriggerEventSet object represents a set of SQL Server server data definition language (DDL) trigger events.

ServerEvent

The ServerEvent object represents the SQL Server server events that can be included in a server event set.

ServerEventArgs

The ServerEventArgs object provides programmatic access to the arguments that are used to report all types of events that occur on an instance of SQL Server.

ServerEvents

The ServerEvents object represents the settings required for SQL Server server-level event notification.

ServerEventSet

The ServerEventSet object represents a set of server events on an instance of SQL Server.

ServerPermission

The ServerPermission object represents a SQL Server server-level permission.

ServerPermissionInfo

The ServerPermissionInfo object represents information about a SQL Server server-level permission.

ServerPermissionSet

The ServerPermissionSet object represents a set of server permissions.

ServerProxyAccount

The ServerProxyAccount class represents the implementation of a proxy account on an instance of SQL Server. The ProxyAccount object allows for impersonation of job step execution. Created by the system administrator, it can be further be assigned to a login or a server role or a database role and one of the subsystems, except for Transact-SQL.

ServerRole

The ServerRole object represents a Microsoft SQL Server security role.

ServerRoleCollection

The ServerRoleCollection class represents a collection of ServerRole objects that represent all the server roles that are defined on a table.

ServerRoleEvents

The ServerRoleEvents object represents the settings required for Microsoft SQL Server ServerRole event notification.

ServerRoleExtender

Adds methods and properties to the ServerRole object.

ServerSecurityAdapter

A security facet that extends ServerAdapterBase.

ServerSelectionAdapter

Provides selection options for an instance of SQL Server.

ServerSetupAdapter

A ServerSetupAdapter object represents a server setup adapter.

ServerSurfaceAreaAdapter

A ServerSurfaceAreaAdapter object represents a server surface area adapter.

ServerTraceEvent

The ServerTraceEvent object represents the SQL Server server trace events that can be included in a server trace event set.

ServerTraceEventSet

The ServerTraceEventSet object represents a set server trace events.

ServiceBrokerPayload

The ServiceBrokerPayload object represents a SQL Server Service Broker payload.

ServiceMasterKey

The ServiceMasterKey object represents a Microsoft SQL Server service master key.

ServiceQueueEvent

The ServiceQueueEvent object represents the Service Broker service queue events that can be included in a service queue event set.

ServiceQueueEventSet

The ServiceQueueEventSet object represents a set of SQL Server service queue events.

ServiceRequestException

The ServiceRequestException class represents the exception that is raised when an error occurs during a service request.

Settings

The Settings object represents a group of configurable settings on the instance of SQL Server.

SfcDependencyException

The SfcDependencyException class represents an exception thrown by an SFC dependency operation fails.

SimpleObjectCollectionBase

The SimpleObjectCollectionBase class is a base class that is used in the construction of collection objects.

SmartAdmin

Represents a class that handles Altering and Scripting the current state of smart admin.

SmartAdminState

This is an adapter class that implements the ISmartAdminState logical facet for an Availability Group.

SmoApplication

The SmoApplication class represents an SMO application with respect to event management.

SmoCollectionBase

Represents a base class that is used in the construction of SMO collection classes and contains members that are common to them.

SmoDmfAdapter

Implements Evaluate(FacetEvaluationContext)

SmoEventArgs

The SmoEventArgs object provides programmatic access to the arguments used to report the events that occur in SMO applications.

SmoException

The SmoException class represents the exception that is raised when an error occurs during an SMO operation.

SmoObjectBase

The SmoObjectBase is a base class that is inherited by the SqlSmoObject class.

SmoObjectExtender<T>

Represents the SmoObjectExtender<T> class that adds methods and properties to an SqlSmoObject class instance.

SoapMethodCollectionBase

The SoapMethodCollectionBase class is a base class that is inherited by SOAP method collection objects and provides programmatic access to the collection of SOAP methods that exist in the SOAP configuration.

SoapMethodObject

The SoapMethodObject class provides programmatic access to the referenced SOAP method.

SoapPayload

The SoapPayload object represents a SQL Server SOAP payload.

SoapPayloadMethod

The SoapPayloadMethod class represents a SOAP payload method for the referenced HTTP endpoint.

SoapPayloadMethodCollection

The SoapPayloadMethodCollection class represents a collection of SoapPayloadMethod objects that represent all the SOAP payload methods defined on a table.

SortedListCollectionBase

The SortedListCollectionBase class is a base class that is used in the construction of sorted list collection classes.

SqlAssembly

The SqlAssembly class represents an assembly in the Microsoft .NET environment.

SqlAssemblyCollection

The SqlAssemblyCollection class represents a collection of SqlAssembly objects that represent all the assemblies defined on a table.

SqlAssemblyEvent

The SqlAssemblyEvent object represents the SQL Server assembly events that can be included in an assembly event set.

SqlAssemblyEvents

The SqlAssemblyEvents object represents the settings that are required for SQL Server assembly event notification.

SqlAssemblyEventSet

The SqlAssemblyEventSet object represents a set of assembly events.

SqlAssemblyFile

The SqlAssemblyFile object represents an assembly file that stores an assembly.

SqlAssemblyFileCollection

The SqlAssemblyFileCollection class represents a collection of SqlAssemblyFile objects that represent all the assembly files that are defined on a table.

SqlPropertyCollection

The SqlPropertyCollection class is an abstract class that is used in the management of object properties.

SqlPropertyInfo

The SqlPropertyInfo class is an abstract class used to store information about properties.

SqlServerRegistrations

Represents registered instances of SQL Server.

SqlSmoObject

The SqlSmoObject object represents all SQL Server objects.

Statistic

The Statistic class represents a SQL Server statistic counter.

StatisticCollection

The StatisticCollection class represents a collection of Statistic objects that represent all the statistic counters defined on the table or view.

StatisticColumn

The StatisticColumn object represents a column defined in a SQL Server statistics counter.

StatisticColumnCollection

The StatisticColumnCollection class represents a collection of StatisticColumn objects that represent all the statistic columns defined on a table.

StatisticEvents

The StatisticEvents object represents the settings required for SQL Server statistic counter event notification.

StoredProcedure

The StoredProcedure object represents a SQL Server stored procedure.

StoredProcedureCollection

The StoredProcedureCollection class represents a collection of StoredProcedure objects that represent all the stored procedures that are defined on a table.

StoredProcedureEvent

The StoredProcedureEvent object represents the SQL Server stored procedure events that can be included in an stored procedure event set.

StoredProcedureEvents

The StoredProcedureEvents object represents the settings that are required for SQL Server stored procedure event notification.

StoredProcedureEventSet

The StoredProcedureEventSet object represents a set of stored procedure events.

StoredProcedureParameter

The StoredProcedureParameter object represents a SQL Server stored procedure parameter.

StoredProcedureParameterCollection

The StoredProcedureParameterCollection class represents a collection of StoredProcedureParameter objects that represent all the stored procedure parameters defined on a table.

SuspectPage

Represents the database page used for Page Restore.

SymmetricKey

The SymmetricKey object represents a SQL Server symmetric key.

SymmetricKeyCollection

The SymmetricKeyCollection class represents a collection of SymmetricKey objects that represent all the symmetric keys on the referenced database.

SymmetricKeyEncryption

The SymmetricKeyEncryption class represents the encryption type used when encrypting symmetric keys.

Synonym

The Synonym object represents a SQL Server synonym.

SynonymCollection

The SynonymCollection class represents a collection of Synonym objects that represent all the synonyms on the referenced database.

SynonymEvents

The SynonymEvents object represents the settings that are required for SQL Server synonym event notification.

SystemDataType

The SystemDataType object represents a supported system data type. The SystemDataTypeCollection represents all the supported system data types.

SystemDataTypeCollection

The SystemDataTypeCollection class represents a collection of SystemDataType objects that represent all the system data types on the referenced database.

SystemMessage

The SystemMessage object represents messages defined by the system.

SystemMessageCollection

The SystemMessageCollection class represents a collection of SystemMessage objects that represent all the system messages on the instance of SQL Server.

Table

The Table object represents a SQL Server table.

TableCollection

The TableCollection class represents a collection of Table objects that represent all the tables on the referenced database.

TableEvent

Represents the SQL Server table events that can be included in a table event set.

TableEvents

The TableEvents object represents the settings required for SQL Server table event notification.

TableEventSet

The TableEventSet object represents a set of table events.

TableViewBase

The TableViewBase class is a base class that is used in the construction of the Table class and View class. It contains functionality that is common to both classes.

TableViewTableTypeBase

Base class for table view types.

TcpProtocol

The TcpProtocol object provides programmatic access to the protocols supported by Microsoft SQL Server.

Transfer

The Transfer object is a tool object that provides programmatic control over copying of schemas and data to other instances of SQL Server.

TransferBase

Represents the base class for transfer.

Trigger

The Trigger object represents a SQL Server trigger.

TriggerCollection

The TriggerCollection class represents a collection of Trigger objects that represent all the triggers defined on a table.

TriggerEvents

The TriggerEvents object represents the settings that are required for SQL Server trigger event notification.

UnknownPropertyException

The UnknownPropertyException class represents the exception that is raised when an SMO operation encounters an unknown property.

UnsupportedCompatLevelException

The exception that is thrown when the compatible level is not supported.

UnsupportedEngineTypeException

The UnsupportedEngineTypeException class represents the exception raised when an SMO operation is attempted on a Database Engine type that does not support that operation. A Database Engine type is either an instance of the SQL Server Database Engine, or SQL Azure.

UnsupportedFeatureException

The UnsupportedFeatureException class represents the exception raised when an SMO operation encounters a request for an unsupported feature.

UnsupportedObjectNameException

The UnsupportedObjectNameException class represents the exception that is raised when an SMO operation encounters an unsupported object name.

UnsupportedVersionException

The UnsupportedVersionException class represents the exception raised when an SMO operation encounters an unsupported version of SQL Server.

UrnCollection

Represents a collection of Urn objects that represent Uniform Resource Name (URN) addresses.

User

The User object represents a SQL Server user.

UserCollection

The UserCollection class represents a collection of User objects that represent all the database users defined on a database.

UserDefinedAggregate

The UserDefinedAggregate object represents a SQL Server user-defined aggregate.

UserDefinedAggregateCollection

The UserDefinedAggregateCollection class represents a collection of UserDefinedAggregate objects that represent all the database user-defined aggregates that are defined on a database.

UserDefinedAggregateParameter

The UserDefinedAggregateParameter object represents the parameters that are used with a user-defined aggregate.

UserDefinedAggregateParameterCollection

The UserDefinedAggregateParameterCollection class represents a collection of UserDefinedAggregateParameter objects that represent all the user-defined aggregate parameters that are defined on a table.

UserDefinedDataType

The UserDefinedDataType object represents a SQL Server user-defined data type.

UserDefinedDataTypeCollection

The UserDefinedDataTypeCollection class represents a collection of UserDefinedDataType objects that represent all the user-defined data types defined on a table.

UserDefinedDataTypeResolver

Resolves objects of user-defined types.

UserDefinedFunction

The UserDefinedFunction object represents a SQL Server user-defined function.

UserDefinedFunctionCollection

The UserDefinedFunctionCollection class represents a collection of UserDefinedFunction objects that represent all the user-defined functions that are defined on a table.

UserDefinedFunctionEvent

Represents the SQL Server user-defined function events that can be included in a user-defined function event set.

UserDefinedFunctionEvents

The UserDefinedFunctionEvents object represents the settings that are required for SQL Server user-defined function event notification.

UserDefinedFunctionEventSet

The UserDefinedFunctionEventSet object represents a SQL Server set of user-defined function events.

UserDefinedFunctionParameter

The UserDefinedFunctionParameter object represents a SQL Server user-defined function parameter.

UserDefinedFunctionParameterCollection

The UserDefinedFunctionParameterCollection class represents a collection of UserDefinedFunctionParameter objects that represent all the user-defined function parameters that are defined on a table.

UserDefinedMessage

The UserDefinedMessage object represents a user-defined message.

UserDefinedMessageCollection

The UserDefinedMessageCollection class represents a collection of UserDefinedMessage objects that represent all the user-defined messages defined on a table.

UserDefinedTableType

The UserDefinedTableType object represents a SQL Server user-defined table type data type.

UserDefinedTableTypeCollection

The UserDefinedTableTypeCollection class represents a collection of UserDefinedTableType objects that represent all the user-defined table types that are defined on a database.

UserDefinedTableTypeResolver

Resolves the type of a user defined table to an Object.

UserDefinedType

The UserDefinedType represents an alias data type that is based on .NET data types.

UserDefinedTypeCollection

The UserDefinedTypeCollection class represents a collection of UserDefinedType objects that represent all the alias data types that are defined on a table.

UserDefinedTypeEvents

The UserDefinedTypeEvents object represents the settings required for SQL Server user-defined type event notification.

UserDefinedTypeResolver

Resolves user-defined data types.

UserEvents

The UserEvents object represents the settings that are required for SQL Server database user event notification.

UserOptions

The UserOptions object represents a set configurable server options that relate specifically to users.

VerifyCompleteEventArgs

The VerifyCompleteEventArgs object provides programmatic access to the arguments used to report the details of the event that occurs when a backup verification operation completes.

VersionSerializationAdapter

Adapts the serialization mode to the version of SQL Server in use.

VersionUtils

Represents the version of the database engine.

View

The View object represents a SQL Server view.

ViewCollection

The ViewCollection class represents a collection of View objects that represent all the views defined on a table.

ViewEvent

Represents the SQL Server view events that can be included in a view event set.

ViewEvents

The ViewEvents object represents the settings that are required for SQL Server view event notification.

ViewEventSet

Represents a set of view events.

WorkloadGroup

The WorkloadGroup class is represents a SQL Server workgroup, which contains a group of session requests. Workload groups allow aggregate monitoring of resource consumption and application of uniform policies to all requests in the group.

WorkloadGroupCollection

Represents a workload group collection.

WrongPropertyValueException

The WrongPropertyValueException class represents the exception that is raised when a property is assigned the wrong value.

XmlSchemaCollection

The XmlSchemaCollection object represents a collection of XML namespaces. The collection of XML namespaces behave a composite object though the namespaces can be enumerated within the collection.

XmlSchemaCollectionCollection

The XmlSchemaCollectionCollection class represents a collection of XmlSchemaCollection objects that represent all the XML schema collections defined on a table. The XmlSchemaCollection object represents a collection of XML namespaces.

Structs

AuditSpecificationDetail

The AuditSpecificationDetail object represents a SQL Server audit specification detail required when creating an audit.

DdlTextParserHeaderInfo

This class supports the SMO infrastructure and is not intended to be used directly from your code.

Interfaces

IAvailabilityGroupState

Represents the adapter class that implements the IAvailabilityGroupState logical facet for an Availability Group.

IColumnPermission

The IColumnPermission class represents the interface that manages permissions for a specified column.

IDatabaseMaintenanceFacet

Represents an interface that defined methods and properties for the database maintenance facet.

IDatabaseOptions

Represents an interface with properties that expose database options.

IDatabasePerformanceFacet

Defines methods and properties that can be used to measure and influence database performance.

IDatabaseSecurityFacet

Security facet interface.

IExtendedProperties

The IExtendedProperties class is an interface that represents the collection of extended properties associated with an object.

ILoginOptions

The ILoginOptions class is an interface that represents a collection of options associated with a login.

IMultipartNameFacet

Interface to deal with object names containing both the object and the schema.

INameFacet

Represents the name facet interface.

IObjectPermission

The IObjectPermission class represents the interface used to set object permissions.

IScriptable

The IScriptable class represents the interface used to create Transact-SQL scripts of SMO objects.

IServerAuditFacet

Interface that identifies audit facet members.

IServerConfigurationFacet

Contains configuration information for interfaces based on the Configuration object.

IServerInformation

An interface based on the Information type properties.

IServerPerformanceFacet

An interface for the performance facet.

IServerSecurityFacet

An interface that defines members for the SeverSecurityFacet.

IServerSelectionFacet

The IServerSelectionFacet class contains members that represent the SQL Server policy-based management server selection facet objects.

IServerSettings

Represents an interface for SQL Server 2016 Policy-Based Management that is based on Settings.

IServerSetupFacet

Represents the Policy-Based Management facet interface for setting up an instance of SQL Server.

ISmartAdminState

This facet aggregates smartadmin state information. It is used to support SQL Server manageability tools.

ISurfaceAreaFacet

An interface that defines surface area facet members.

ITableOptions

The ITableOptions class is an interface that represents a collection of options that is associated with a table.

ITextObject

The ITextObject class represents the interface that is used to implement text on objects.

IUserOptions

The IUserOptions class is an interface that represents a collection of options that is associated with a user.

IViewOptions

The IViewOptions class is an interface that represents a collection of options that is associated with a view.

Enums

AbortAfterWait

Describes the various actions to take after the Low Priority expires during an online index build/switch partition operation.

ActivationExecutionContext

The ActivationExecutionContext enumeration contains values that specify the security context used by a procedure. These procedures are activated by a service queue.

AffinityType

The AffinityType enumeration represents the possible affinity settings for an instance of SQL Server.

AssemblyAlterOptions

The AssemblyAlterOptions enumeration contains values that are used to specify the addition options when modifying an assembly. The values are bit flag values, and they can be combined by adding the values.

AssemblySecurityLevel

The AssemblySecurityLevel enumeration contains values that are used to specify the access rights for an assembly.

AsymmetricKeyEncryptionAlgorithm

The AsymmetricKeyEncryptionAlgorithm enumeration contains values that are used to specify an encryption algorithm used on an asymmetric key.

AsymmetricKeySourceType

The AsymmetricKeySourceType enumeration contains values that are used to specify the source type used to load an asymmetric key.

AttachOptions

The AttachOptions enumeration contains values that are used to specify attach options.

AuditActionType

Specifies the type of action for SQL Server audit events.

AuditDestinationType

The AuditDestinationType enumeration contains values that are used to specify the destination, to which the results of a SQL Server Audit are sent.

AuditFileSizeUnit

The AuditFileSizeUnit enumeration contains values that are used to specify the unit that specifies the size of the audit file.

AuditLevel

The AuditLevel enumeration contains values that are used to specify the SQL Server audit level setting.

AuditStatusType

The AuditStatusType enumeration contains values that are used to specify the status of the audit.

AuthenticationType

Specifies the Sql server authentication type.

AvailabilityDatabaseSynchronizationState

Represents the current state of the availability database synchronization.

AvailabilityGroupAutomatedBackupPreference

Specifies how replicas in the primary role are treated in the evaluation to pick the desired replica to perform a backup.

AvailabilityGroupFailureConditionLevel

Specifies the different conditions that can trigger an automatic failover in Availability Group.

AvailabilityGroupListenerIPState

Specifies the state of the Availability Group Listener IP Address.

AvailabilityGroupRollupSynchronizationState

Specifies a rollup of the synchronization states of the availability replicas in the availability group.

AvailabilityReplicaAvailabilityMode

Specifies the availability modes of Availability Replica.

AvailabilityReplicaConnectionModeInPrimaryRole

Specifies the connection intent modes of an Availability Replica in primary role.

AvailabilityReplicaConnectionModeInSecondaryRole

Specifies the connection modes of an Availability Replica in secondary role.

AvailabilityReplicaConnectionState

Represents the current availability replica connection state.

AvailabilityReplicaFailoverMode

Specifies the failover modes of Availability Replica.

AvailabilityReplicaJoinState

Specifies the availability replica join state.

AvailabilityReplicaOperationalState

Specifies the state of the replica's readiness to process client requests for all databases replicas in the availability group residing on it.

AvailabilityReplicaRole

Represents the availability replica role.

AvailabilityReplicaRollupRecoveryState

Specifies a rollup of the recovery state of all database replicas in the availability group that reside on this availability replica.

AvailabilityReplicaRollupSynchronizationState

Specifies the current synchronization state of the availability replica.

BackupActionType

The BackupActionType enumeration contains values that are used to specify the type of backup.

BackupCompressionOptions

The BackupCompressionOptions enumeration contains values that are used to specify the backup compression option.

BackupDeviceType

The BackupDeviceType enumeration contains values that are used to specify the backup device type.

BackupEncryptionAlgorithm

Specifies the algorithm type used for backup encryption.

BackupEncryptorType

Specifies the encryptor type used to encrypt an encryption key.

BackupRestoreBase.AsyncOperation

The BackupRestoreBase.AsyncOperation enumeration contains values that are used to specify which backup components are running asynchronously.

BackupSetFlag

The BackupSetFlag enumeration contains values that are used to specify the purpose of the backup.

BackupSetType

The BackupSetType enumeration contains values that are used to specify the backup type.

BackupTruncateLogType

The BackupTruncateLogType enumeration contains values that are used to specify the truncate action taken on the log.

CatalogPopulationAction

The CatalogPopulationAction enumeration contains values that are used to specify the method used to populate a full-text catalog.

CatalogPopulationStatus

The CatalogPopulationStatus enumeration contains values that are used to specify the status of the full-text catalog.

CertificateSourceType

The CertificateSourceType enumeration contains values that are used to specify the source of the certificate.

ChangeTracking

The ChangeTracking enumeration contains values that are used to specify change tracking in a full-text index.

ClusterMemberState

Specifies the state of a member in a Windows Cluster.

ClusterMemberType

Specifies the type of node in the windows cluster.

ClusterQuorumState

Specifies the current stat of the cluster quorum.

ClusterQuorumType

Specifies the different types of ways a cluster can decide on a quorum.

CollationVersion

The CollationVersion enumeration contains values that specify the collation versions.

ColumnEncryptionType

Describes the column encryption type.

CompatibilityLevel

The CompatibilityLevel enumeration is a list of constant values that specify the behavior that corresponds to a version of SQL Server.

ContainmentType

Specifies the containment types of a database.

CreateDispositionType

The CreateDispositionType enumeration contains values that are used to specify the source of the symmetric key.

DatabaseDdlTriggerExecutionContext

The DatabaseDdlTriggerExecutionContext enumeration contains values that are used to specify the execution context under which the database DDL trigger runs.

DatabaseEncryptionAlgorithm

Specifies the algorithm used to encrypt the database encryption key

DatabaseEncryptionState

Enumerates the possible encryption states of a database.

DatabaseEncryptionType

The DatabaseEncryptionType enumeration contains values that are used to specify the encryption types.

DatabaseEventType

The DatabaseEventType enumeration is a list of constant values that specify the database event type.

DatabaseObjectTypes

Specifies the types of database object.

DatabasePermissionSetValue

The DatabasePermissionSetValue enumeration is a list of constant values that specify all the database permissions.

DatabaseRecoveryState

Specifies the state of the database restore operation.

DatabaseReplicaSuspendReason

Specifies the different reasons for a database replica to be in suspended state.

DatabaseStatus

The DatabaseStatus enumeration is a list of constant values that specify the status of a database, whether it be loading, recovering, or normal, for example. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

DatabaseUserAccess

The DatabaseUserAccess enumeration is a list of constant values that specify how user access can be restricted.

DataCompressionType

Specifies the DataCompressionType enumeration contains values that are used to specify the type of data compression used to store data on the physical partition.

DelayedDurability

Specifies an enumeration of delayed durability setting.

DependencyType

The DependencyType enumeration is a list of constant values that specifies the direction of the dependency discovery operation.

DeviceType

The DeviceType enumeration is a list of constant values that specify the various different types of devices supported by SQL Server.

DistributionType

Specifies how the scale out system distributes a federated (Federation) table.

DurabilityType

Lists durability types of a table.

For more information, see In-Memory OLTP (In-Memory Optimization).

Edition

The Edition enumeration is a list of constant values that specify the various different types of devices that are supported by SQL Server.

EndpointAuthenticationOrder

The EndpointAuthenticationOrder enumeration contains values that are used to specify the authentication methods and order of preference for the endpoint connection.

EndpointEncryption

The EndpointEncryption enumeration contains values that are used to specify the state of encryption on the endpoint.

EndpointEncryptionAlgorithm

Specifies an encryption algorithm used on an endpoint.

EndpointState

The EndpointState enumeration is a list of constant values that specifies the state of the HTTP endpoint.

EndpointType

The EndpointType enumeration is a list of constant values that specifies the type of HTTP endpoint.

EventType

Specifies the various different types of events that are supported by SQL Server.

ExecutionContext

The ExecutionContext enumeration is a list of constant values that specify the different types of context (or which role is assumed) when executing a process represented by an object.

ExecutionStatus

The ExecutionStatus enumeration is a list of constant values that specify the status of an executing process.

ExternalDataSourceType

Specifies an enumeration of external data source type.

ExternalFileFormatType

Enumerates the format type of external file.

ExternalTableDistributionType

Enumerates the external table distribution type.

ExternalTableRejectType

Specifies the type of rejection for the external table.

FileGroupType

FileGroupType is an enumeration that lists types of filegroups in a database.

FileGrowthType

The FileGrowthType enumeration is a list of constant values that specify whether file growth is determined by percentage amount or by KB.

FilestreamAccessLevelType

The FilestreamAccessLevelType enumeration contains values that are used to specify the type of access permitted on file stream operations.

FileStreamEffectiveLevel

The FileStreamEffectiveLevel enumeration contains values that are used to specify the file stream level.

FileStreamLevel

The FileStreamLevel enumeration contains values that are used to specify the file stream level.

FilestreamNonTransactedAccessType

Enumerates the file stream non-transacted access types.

ForeignKeyAction

The ForeignKeyAction enumeration is a list of constant values that specify the action that is taken when the primary key reference by a foreign key is updated.

FragmentationOption

The FragmentationOption enumeration is a list of constant values that specify the levels of detail of collected fragmentation information.

FullTextCatalogUpgradeOption

The FullTextCatalogUpgradeOption enumeration contains values that are used to specify the action taken when the full-text catalog is upgraded.

GeneratedAlwaysType

Enumerates a generated always type.

HadrManagerStatus

Enumeration to represent the status of the Hadr manager.

HttpAuthenticationModes

The HttpAuthenticationModes enumeration contains values that specify the HTTP port for HTTP endpoints.

HttpPortTypes

The HttpPortTypes enumeration contains values that are used to specify the type HTTP port.

ImplementationType

The ImplementationType enumeration contains values that are used to specify the type of implementation for a stored procedure, a user-defined function, and other objects.

IndexedXmlPathType

Specifies an enumeration of type of indexed XML path.

IndexEnableAction

The IndexEnableAction enumeration contains values that are used to specify the action that is taken on an index when it is enabled after having been disabled.

IndexKeyType

The IndexKeyType enumeration contains values that are used to specify the type of key on which the index is created.

IndexOperation

The IndexOperation enumeration contains values that are used to specify index operations.

IndexPopulationAction

The IndexPopulationAction enumeration contains values that are used to specify the type of Microsoft Search full-text index population.

IndexPopulationStatus

The IndexPopulationStatus enumeration contains values that are used to specify the type of population in progress.

IndexType

Specifies the type of an index.

For an In-Memory OLTP code sample, see SQL Server Management Objects Support for In-Memory OLTP.

InDoubtTransactionResolutionType

Enumerates possible responses to in-doubt transactions.

InstanceState

The InstanceState enumeration contains values that are used to specify the possible states of an instance of SQL Server.

KeyEncryptionType

The KeyEncryptionType enumeration is a list of constant values that specify the key encryption type.

LinkedTableType

The LinkedTableType enumeration contains values that specify the type of table accessed on a linked server.

LinkFieldType

The LinkFieldType enumeration contains values that specify the type of link field.

LockEscalationType

An enumeration that lists lock escalation types.

LockRequestStatus

The LockRequestStatus enumeration contains constant values that specify the lock request status.

LoginCreateOptions

The LoginCreateOptions enumeration contains values that are used to specify the password options when you create a logon.

LoginType

The LoginType enumeration contains values that are used to specify the authentication type and the Windows account type.

LogReuseWaitStatus

The LogReuseWaitStatus enumeration contains values that specify the current operation on which the reuse of transaction log space is waiting.

MappedClassType

Enumerates credential mapping options.

MediaTypes

The MediaTypes enumeration contains values that are used to specify the type of media used to store data. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

MethodLoginType

The MethodLoginType enumeration contains values that are used to specify the method used for logging on to the instance of SQL Server.

MethodXsdSchemaOption

The MethodXsdSchemaOption enumeration contains values that specify the XSD schema returned for a SOAP method.

MirroringOption

The MirroringOption enumeration contains values that specify the mirroring options for a database.

MirroringRole

The MirroringRole enumeration contains values that specify the role the database plays in mirroring.

MirroringSafetyLevel

The MirroringSafetyLevel enumeration contains values that specify the safety guarantee on updates to the mirrored database.

MirroringStatus

The MirroringStatus enumeration contains values that specify the state of a database regarding mirroring.

MirroringWitnessStatus

The MirroringWitnessStatus enumeration contains values that specify the state of the mirroring witness.

Month

The Month enumeration contains constant values that specify the twelve calendar months.

NSActivationState

The NSActivationState enumeration contains constant values that specify the activation state of Notification Services.

NumaNodeAffinity

The NumaNodeAffinity enumeration defines the affinity states for a Cpu object.

ObjectClass

The ObjectClass enumeration contains values that specify the SMO class type.

ObjectPermissionSetValue

The ObjectPermissionSetValue enumeration is a list of constant values that specify all the object permissions.

OnFailureAction

Specifies the action that needs to be taken when the audit sink cannot perform the write.

PageVerify

The PageVerify enumeration contains constant values that specify the automatic page verification options for a database.

PasswordHashAlgorithm

Displays the password hash algorithm in the Server Management Objects.

PerfMonMode

The PerfMonMode enumeration contains values that are used to specify the polling behavior in Performance Monitor.

PermissionState

The PermissionState enumeration contains values that specify the state of a permission.

PlanGuideType

Enumerates the possible Plan Guide types.

PrincipalType

The PrincipalType enumeration contains values that specify the type of user, role, or login.

PrivateKeyEncryptionType

The PrivateKeyEncryptionType enumeration contains values that are used to specify the encryption types for a private key associated with a certificate or an asymmetric key.

PrivilegeTypes

The PrivilegeTypes enumeration contains values that are used to specify the operations that the grantee can perform on the specified object when permission is granted.

ProtocolType

The ProtocolType enumeration contains values that are used to specify the type of protocol.

ProviderAuthenticationType

Specifies the type of authentication supported by Cryptographic Provider.

QueryStoreCaptureMode

Specifies an enumeration of query store capture mode.

QueryStoreOperationMode

Enumerates the query store operation mode.

QueryStoreSizeBasedCleanupMode

Specifies the store size of the query.

RangeType

The RangeType enumeration contains values that are used to specify the type range.

RecoveryModel

The RecoveryModel enumeration contains values that are used to specify the type of recovery model.

RemoteDataArchiveMigrationState

Enumerates the remote data archive migration state.

RepairOptions

The RepairOptions enumeration contains values that are used to specify the repair options that are used when checking data in a table.

RepairStructure

The RepairStructure enumeration contains values that are used to specify the type of repair options used when checking data in a table.

RepairType

The RepairType enumeration contains values that are used to specify the type of repair mode used by the database consistency check (DBCC) functions.

ReplicationOptions

The ReplicationOptions enumeration contains values that are used to specify the replication settings for the referenced database.

ResourceUsage

The ResourceUsage enumeration contains values that specify the relative operating system execution priority setting for the Microsoft Search service.

RestoreActionType

The RestoreActionType enumeration contains values that are used to specify the type of action that is required during a data restore operation.

RestoreType

The RestoreType enumeration contains values that specify the type of restore operation to perform.

ResultFormat

The ResultFormat enumeration contains values that specify the format in which to return results for an HTTP endpoint.

RetentionPeriodUnits

Enumerates values that specify the units for the retention period.

RoleTypes

The RoleTypes enumeration contains values that are used to specify the type of role.

SecondaryXmlIndexType

The SecondaryXmlIndexType enumeration contains values that are used to specify the secondary XML index type.

SecurityPredicateOperation

Enumerates the security predicate operation.

SecurityPredicateType

Specifies an enumeration of security predicate type.

SequenceCacheType

The SequenceCacheType enumeration contains constant values that specify the type of caching used by a Sequence.

ServerDdlTriggerExecutionContext

The ServerDdlTriggerExecutionContext enumeration contains values that are used to specify the execution context under which the server DDL trigger runs.

ServerLoginMode

The ServerLoginMode enumeration contains values that are used to specify the method used to connect to the instance of SQL Server.

ServerMirroringRole

The ServerMirroringRole enumeration contains values that are used to specify the role of the instance of SQL Server when participating in mirroring.

ServerPermissionSetValue

The ServerPermissionSetValue enumeration is a list of constant values that specify all the database permissions.

ServerStatus

The ServerStatus enumeration contains values that are used to specify the status of the instance of SQL Server.

ServiceStartMode

The ServiceStartMode enumeration contains values that are used to specify the method that is used to start a service.

ShrinkMethod

The ShrinkMethod enumeration contains values that are used to specify the method that is used shrink a database file.

SmoExceptionType

The SmoExceptionType enumeration contains values that are used to specify the type of SMO exception.

SnapshotIsolationState

The SnapshotIsolationState enumeration contains values that are used to specify the current state of snapshot isolation.

SortOrder

The SortOrder enumeration contains values that specify how objects are sorted in an enumerated list.

SpatialGeoLevelSize

Enumerates grid density levels for spatial indexes.

SpatialIndexType

Enumerates possible spatial index types.

SqlDataType

The SqlDataType enumeration contains values that are used to specify a SQL Server data type.

SqlServerVersion

The SqlServerVersion enumeration contains values that are used to specify the version of the referenced instance of SQL Server.

SqlServerVersions

The SqlServerVersions enumeration contains values that are used to specify the version of the referenced instance of SQL Server.

SqlSmoState

The SqlSmoState enumeration contains values that are used to specify the state of an SMO object.

SqlVerifyAction

The SqlVerifyAction enumeration contains values that are used to specify the type of backup verification.

StatisticsScanType

The StatisticsScanType enumeration contains values that specify the ways in which statistical information is collected from tables or views during the creation or update of a statistic counter.

StatisticsTarget

The StatisticsTarget enumeration contains values that specify the type of statistic that is targeted for the update operation.

StopListOption

The StopListOption enumeration contains values that are used to specify the way in which a new stop list is created.

SymmetricKeyEncryptionAlgorithm

The SymmetricKeyEncryptionAlgorithm enumeration contains values that specify the algorithm that is used to encrypt the symmetric key.

SymmetricKeyEncryptionType

The SymmetricKeyEncryptionType enumeration contains constant values that specify the type of symmetric key encryption.

SynonymBaseType

The SynonymBaseType enumeration contains constant values that specify the type of synonym.

TableTemporalType

Enumerates the table temporal type.

TerminationClause

The TerminationClause enumeration contains constant values that specify the action taken when transactions are terminated.

TransactionTypes

The TransactionTypes enumeration contains constant values that specify the method of recording transactions.

UrnIdOption

Enumerates URN identification options.

UserDefinedFunctionType

The UserDefinedFunctionType enumeration is a list of constant values that specify the types of user-defined functions that are supported by SQL Server.

UserDefinedTypeFormat

The UserDefinedTypeFormat enumeration is a list of constant values that specify the formats used by user-defined types.

UserType

The UserType enumeration contains constant values that specify the security type for the user.

WindowsLoginAccessType

The WindowsLoginAccessType enumeration contains constant values that specify the type of access a Windows login has to the instance of SQL Server.

WorkloadGroupImportance

The WorkloadGroupImportance enumeration contains values that specify the importance of workload groups.

WsdlGeneratorOption

The WsdlGeneratorOption enumeration contains constant values that specify the Web Services Description Language (WSDL) generator options.

XmlDocumentConstraint

The XmlDocumentConstraint enumeration contains constant values that specify the constraints imposed on an XML document.

XmlFormatOption

The WsdlGeneratorOption enumeration contains constant values that specify the Web Services Description Language (WSDL) generator options.

XmlTypeDerivation

The XmlTypeDerivation enumeration contains constant values that specify the XML type derivation.

XmlTypeKind

The XmlTypeKind enumeration contains constant values that specify the kind of XML component.

XsdSchemaOption

The XsdSchemaOption enumeration contains constant values that specify whether an inline schema for the method result is returned in the SOAP response.

Delegates

DatabaseRestorePlanner.CreateRestorePlanEventHandler

Provides the database for the create restore plan event handler.

NextRestoreEventHandler

Handles the NextRestoreEvent class.

PercentCompleteEventHandler

The PercentCompleteEventHandler class represents the event handler that is used to handle percent complete events.

ProgressReportEventHandler

The ProgressReportEventHandler class represents the event handler that is used to handle progress report events.

ScriptingErrorEventHandler

The ScriptingErrorEventHandler class represents the event handler that is used to handle scripting errors.

ScriptingFilter

Do not reference this member directly in your code. It supports the SQL Server infrastructure. Supplies filtering for scripts.

ServerEventHandler

The ServerEventHandler class represents the event handler that is used to handle server errors.

SmoApplication.AnyObjectEventHandler

The SmoApplication.AnyObjectEventHandler class represents the event handler that is used to handle events from any object.

SmoApplication.DatabaseEventHandler

The SmoApplication.DatabaseEventHandler class represents the event handler that handles database events.

SmoApplication.ObjectAlteredEventHandler

The SmoApplication.ObjectAlteredEventHandler class represents the event handler that is used to handle events that occur when an object is altered.

SmoApplication.ObjectCreatedEventHandler

The SmoApplication.ObjectCreatedEventHandler class represents the event handler that is used to handle events when an object is created.

SmoApplication.ObjectDroppedEventHandler

The SmoApplication.ObjectDroppedEventHandler class represents the event handler that is used to handle events when an object is dropped.

SmoApplication.ObjectRenamedEventHandler

The SmoApplication.ObjectRenamedEventHandler class represents the event handler that handles events that occur when an object is renamed.

VerifyCompleteEventHandler

The VerifyCompleteEventHandler class represents the event handler that handles completion events.

Remarks

The Microsoft.SqlServer.Management.Smo namespace contains the instance object classes that represent SQL Server Database Engine objects and some utility classes that represent specific tasks, such as scripting. When a connection to the instance of the SQL Server Database Engine has been established by using a Server object variable, objects on the instance can be accessed by using the SMO instance objects. For example, you can use the Database object to access databases on the connected instance of SQL Server Database Engine. All the instance classes are related to the Server class in the object hierarchy. Utility classes exist outside of the Server class object hierarchy and represent specific tasks, such as backup or scripting.

Most of the classes Microsoft.SqlServer.Management.Smo namespace resides in the Microsoft.SqlServer.Smo.dll and Microsoft.SqlServer.SmoExtended.dll files. Additionally, some of the enumeration classes are in the Microsoft.SqlServer.SqlEnum.dll and Microsoft.SqlServer.SmoEnum.dll assembly files. You will have to import all four files to access all of the classes in the Microsoft.SqlServer.Management.Smo namespace.

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

  • Connect to an instance of the SQL Server Database Engine.

  • View and modify instance settings and configuration options.

  • View and modify database objects.

  • Perform DDL (data definition language) tasks on an instance of the SQL Server Database Engine.

  • Script databases dependencies.

  • Perform database maintenance tasks, such as backup and restore operations.

  • Transfer database schemas and data.