Server Class

Constructs a new Server object that relies on the given ServerConnection for connectivity.

Regular SMO objects access the parent class reference through parentColl (corresponding collection in parent class). Singleton class has no collection in parent.

connection context

Returns the DatabaseEngineEdition of the SMO object

Returns the DatabaseEngineType of the SMO object

Default availability group cluster type for the server

Checks whether the server is a member of WSFC cluster

Whether the object has been touched for unconditional scripting of Alter

Returns the collection that contains the object. May be null.

Returns the ServerVersion of the Server that contains the object. If the object is not associated with a connected Server, the highest known server version is returned.

Returns the state of the object

Gets the supported availability group cluster types for the server

Returns the Urn of the object, computed on the fly

method get called from the create script related method (from derived classes like Table, Index etc..)

Alter the metadata for the server, including dependent child objects such as Configuration, Information, and Settings. The Configuration class will not override value checking with this call.

Alter the metadata for the server, including dependent child objects such as Configuration, Information, and Settings.

Attach Database

Attach Database

Attach Database

Attach Database

This is a virtual function, so that derived classes can override it if they want to do additional checks on the state of the object

Checks object state Because it is not recusrive, this function can be called directly and which means derived classes can't supply their own validation

Compares two Urn's, taking into account the collations on the server

Deletes the entries in the backup and restore history tables for backup sets older than oldestDate

Deletes the entries in the backup and restore history tables for backup sets on mediaSetID

Deletes the entries in the backup and restore history tables for database

Detach a database

Detach a database

The DetachedDBInfo method returns information about a detached database.

Best Effort Discovery mechanism : This method reflects upon metadata and gets all available objects

drops the object

For drop calls on the user database in Azure, the connection will be closed as the database is dropped The ExecutionManager will normally attempt to retry such calls by reopening the connection We want to avoid this retry when handleSevereError is true.

drops the object

Returns output of DBCC TRACESTATUS()

Enumerate all active global trace flags set for SQL Instance and return them as DataTable

Returns output of xp_availablemedia

Returns output of xp_availablemedia

Enumerate the current state of the Windows cluster members of which the instance is a part of.

Enumerate the current state of the Windows cluster members of which the instance is a part of.

Enumerates the witness roles the server plays in a database mirroring partnership

The ListDetachedDBFiles method lists all database files referenced by a primary database file.

The ListDetachedLogFiles method lists all log files referenced by primary log file.

Returns a table of active locks

Returns a table of active locks

The ListMembers method returns a NameList object that enumerates the Microsoft� SQL Server� 2000 server or database roles in which the SQLServer object login has membership. For SDS, there is no concept of server roles. Depending on the connection to the databases, we will get information about membership in the database roles. There are two special database roles in master database in SDS, sds_securityadmin and sds_dbcreator, membership of whose can only be got while connected to master database.

Retrieves performance counter data from the server.

Retrieves performance counter data from the server.

Retrieves performance counter data from the server.

Retrieves performance counter data from the server.

enumerate processes optionaly excluting the system processes

Returns the content of sp_server_info

Returns output of xp_logininfo filtered to groups

Returns output of xp_logininfo filtered to groups

Returns output of xp_logininfo filtered to groups.

Returns output of xp_logininfo filtered to users

Returns output of xp_logininfo filtered to users

Returns output of xp_logininfo filtered to users

Executes sql statements

Executes the given action under the given execution modes.

Resets the original modes after the action completes or fails.

Checks whether the specified file exists

returns a clone of the default init fields. This function will be deprecated. Please use the overload function.

returns a clone of the default init fields

Provides an enumerable of properties that are explicitly disabled for specific server types or editions. This is not a list of all properties that don't work for the specified target.

Get the Property field supported by given object type

Retrieve the property value from : - The property bag directly if property is available (dirty or retrieved) - A call to our OnPropertyMissing method otherwise

Will throw an exception if the property value is NULL in either case.

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL value) - A call to our OnPropertyMissing method otherwise (will throw exception if value is NULL)

Returns the value of the named property. If the object is in the Creating state and the property has not yet been set the defaultValue is returned. If the object exists the defaultValue is ignored and the actual value is returned.

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL) - A call to our OnPropertyMissing method otherwise (possible NULL)

Returns the real value for the property.

Returns the object with the corresponding Urn

Gets the sqlserver public name for the current connection, e.g: will transfer "SQLTOOLS2008-2" to "SQL Server 2008".

Returns the comparer used by all child object collections to perform comparison of object names. The comparer of a Server is based on the collation of master The comparer of a Database and its children is based on the database collation

Returns the comparer object corresponding to the collation string passed.

Computes the Urn for the object.

Computes the Urn for the object, potentially including other fields in the definition besides the key fields.

This method is called on a secondary replica that has joined the availability group to grant availability group create database privilege for automatic seeding to work

Initializes the child object collection associated with the given type. For example, the name Column would initialize the Columns collection.

Initializes the object, by reading its properties from the enumerator

The IsDetachedPrimaryFile method specifies whether a file is a detached primary database file.

Returns whether the server containing this object is an Express SKU

Validate whether the specified property is supported in current server environment

Checks whether a trace flag is enabled on the server

The IsNTGroupMember method exposes an instance of Microsoft� SQL Server� 2000 access rights for Windows NT� 4.0 or Microsoft Windows 2000 user accounts. Cloud for now doesn't support windows logins. And Sql logins can't be member of any windows group. Hence this method is not supported for Cloud.

This method is called on a secondary replica that has been added to an Availability Group from a primary to complete the handshake. Upon successful execution the instance will become a functioning replica in the availability group.

This method is called on a secondary replica that has been added to an Availability Group from a primary to complete the handshake. Upon successful execution the instance will become a functioning replica in the availability group.

Kills all user processes that are using the given database.

Drops a database. If users are connected to it their connections will be dropped.

Checks whether the parent directory of the specified file exists

will connect to the specified serve, retrieve the version string, and disconnect before return to the caller This allows caller to ping the SQLServer version Expensive because we need to make a connection to get the info, call only when necessary

will connect to the specified serve, retrieve the version string, and disconnect before return to the caller This allows caller to ping the SQLServer version Expensive because we need to make a connection to get the info, call only when necessary

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after altering the object

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after object creation

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after dropping the object

Revoke the create database privilege of the specified availability group

Returns a StringCollection object with the script for the object. This method throws an error if ScriptData is true

Set the accessToken for connection.

Sets a value indicating whether objects in collections should be initialized with all properties and clears any prior settings from other overrides of this method. Specific properties to fetch for a given type can be chosen for initialization by using another override of this method.

Set the default fields of the given object type. This function will be deprecated. Please use the overload function.

Set the default fields of the given object type

Set the default fields of the given object type

Set the default fields of the given object type. This function will be deprecated. Please use the overload function.

Set the default for the fields of the given object type. This function will be deprecated. Please use the overload function.

Set the default fields of the given object type

Sets the object state (Existing, Dropped etc.) Applications should avoid using this method.

Sets a session trace flag

Throws an exception if the ServerVersion major version for this object is above 10.0 (SQL 2008)

Throws an exception if the ServerVersion major version for this object is above 8.0 (SQL 2000)

Throws an exception if the ServerVersion major version for this object is below 10.0 (SQL 2008)

Throws an UnsupportedVersionException if either the source or destination server is below 11.0 (SQL 2012)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 11.0 (SQL 2012)

Throws an exception if the ServerVersion major version for this object is below 12.0 (SQL 2014)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 12.0 (SQL 2014)

Throws an exception if the ServerVersion major version for this object is below 13.0 (SQL 2016)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 13.0 (SQL 2016)

Throws an exception if the ServerVersion major version for this object is below 14.0 (SQL 2017)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 14.0 (SQL 2017)

Throws an exception if the ServerVersion major version for this object is below 8.0 (SQL 2000)

Throws an exception if the ServerVersion for this object is below 8.760 (8.0 SP3)

Throws an exception if the ServerVersion major version for this object is below 9.0 (SQL 2005)

Mark the object "touched" for unconditional scripting of Alter.

Virtual method to allow derived classes to do additional work when touched.

Discovers type of property.

Retrieves value for a given property. Throws if property is not found.

Sets state of this object based on provided SfcObjectState.

Sets the value of given property, if it is writable. If property is not in property bag, reflection is used. Throws exception if the property is not found.

Helper for SFC. Ask Enumerator for a DataTable of results given a Urn.

Returns the object with the corresponding Urn in string form

Helper for SFC. Query and iterator/enumerator interfaces should be the level we abstract at, but for now we make sure caching via InitChildLevel is done while we still give back the list of Urns.

Returns the instance name of this domain

Returns the SMO domain name

Returns logical version of SMO object model schema

This object extend ISfcSupportsDesignMode.

Finds all available checks for given server.

Finds all available checks for given smoObject.

Synchronously runs assessment for given server and gives a IEnumerable<T> describing discovered issues. This method performs only given checks from checks.

Synchronously runs assessment for given server and gives a IEnumerable<T> describing discovered issues.

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues. This method performs only given checks from checks.

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues.

Synchronously runs assessment for given server and gives a IEnumerable<T> describing discovered issues. This method performs only given checks from checks.

Asynchronously runs assessment for given server and gives a List<T> describing discovered issues.

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues. This method performs only given checks from checks.

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues.

Checks if the specified type is supported by the ServerVersion and DatabaseEngineType of the root server for this object. If ScriptingPreferences are non-null will also check if specified type is supported by the ServerVersion and DatabaseEngineType of the target server.