Export (0) Print
Expand All

SqlSmoObject Class

 

Applies To: SQL Server 2016 Preview

The SqlSmoObject object represents all SQL Server objects.

Namespace:   Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.Agent.JobServer
      Microsoft.SqlServer.Management.Smo.AvailabilityGroupListenerIPAddress
      Microsoft.SqlServer.Management.Smo.Broker.ServiceBroker
      Microsoft.SqlServer.Management.Smo.DatabaseActiveDirectory
      Microsoft.SqlServer.Management.Smo.DatabaseEncryptionKey
      Microsoft.SqlServer.Management.Smo.DatabaseOptions
      Microsoft.SqlServer.Management.Smo.DatabaseReplicaState
      Microsoft.SqlServer.Management.Smo.DatabaseSegment
      Microsoft.SqlServer.Management.Smo.EndpointPayload
      Microsoft.SqlServer.Management.Smo.EndpointProtocol
      Microsoft.SqlServer.Management.Smo.FileSegment
      Microsoft.SqlServer.Management.Smo.FullTextIndex
      Microsoft.SqlServer.Management.Smo.Information
      Microsoft.SqlServer.Management.Smo.Mail.SqlMail
      Microsoft.SqlServer.Management.Smo.MasterKey
      Microsoft.SqlServer.Management.Smo.MessageObjectBase
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
      Microsoft.SqlServer.Management.Smo.PhysicalPartition
      Microsoft.SqlServer.Management.Smo.ResourceGovernor
      Microsoft.SqlServer.Management.Smo.Server
      Microsoft.SqlServer.Management.Smo.ServerActiveDirectory
      Microsoft.SqlServer.Management.Smo.ServerProxyAccount
      Microsoft.SqlServer.Management.Smo.ServiceMasterKey
      Microsoft.SqlServer.Management.Smo.Settings
      Microsoft.SqlServer.Management.Smo.SmartAdmin
      Microsoft.SqlServer.Management.Smo.UserOptions

[<AbstractClass>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
type SqlSmoObject = 
    class
        inherit SmoObjectBase
        interface ISfcPropertyProvider
        interface ISfcNotifyPropertyMetadataChanged
        interface INotifyPropertyChanged
        interface IRefreshable
        interface IAlienObject
    end

NameDescription
System_CAPS_protmethodSqlSmoObject()

Initializes a new instance of the SqlSmoObject class.

NameDescription
System_CAPS_protpropertyExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

System_CAPS_protpropertyIsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

System_CAPS_protpropertyObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.

System_CAPS_protpropertyScalarResult

Gets the scalar result for the referenced object.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_protmethodAddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

System_CAPS_protmethodAlterImpl()

Activates the object altered event.

System_CAPS_protmethodAlterImplWorker()

Calls the Alter methods.

System_CAPS_protmethodBindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

System_CAPS_protmethodBindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

System_CAPS_protmethodCheckObjectState()

Validates the state of the referenced object.

System_CAPS_protmethodCheckObjectState(Boolean)

Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created.

System_CAPS_protmethodCheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

System_CAPS_protmethodCheckVersion100()

Checks whether version of SQL Server is SQL Server 2008.

System_CAPS_protmethodCheckVersion110()

Checks whether version of SQL Server is SQL Server 2012.

System_CAPS_protmethodCheckVersion110(String)

Checks whether the version of SQL Server is SQL Server 2012 with the specified name.

System_CAPS_protmethodCheckVersion120()

Checks whether the version of SQL Server is SQL Server 2014.

System_CAPS_protmethodCheckVersion120(String)

Checks whether the version of SQL Server is SQL Server 2014.

System_CAPS_protmethodCheckVersion80()

Checks the validity of the object on SQL Server 2000.

System_CAPS_protmethodCheckVersion80SP3()

Checks the validity of the object on SQL Server 2000 SP3.

System_CAPS_protmethodCheckVersion90()

Check the validity of the object on SQL Server 2005.

System_CAPS_protmethodCheckVersionBelow110()

Checks whether version of SQL Server is before SQL Server 2012.

System_CAPS_protmethodCheckVersionBelow90()

Checks whether version of SQL Server is before SQL Server 2005.

System_CAPS_protmethodCleanObject()

Sets the object to its unmodified state.

System_CAPS_protmethodCreateImpl()

Creates an object with scripting options.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.

System_CAPS_protmethodDropImpl()

Drops a SqlSmoObject.

System_CAPS_protmethodDropImplWorker(Urn)

Calls the drop methods.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

System_CAPS_protmethodGenerateAlterEvent()

Generates the alter event with the specified value.

System_CAPS_protmethodGenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

System_CAPS_pubmethodSystem_CAPS_staticGetChildType(String, String)

Gets the type of a child element.

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.

System_CAPS_protmethodGetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

System_CAPS_protmethodGetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

System_CAPS_protmethodGetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.

System_CAPS_protmethodGetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetTypeFromUrnSkeleton(Urn)

Gets the type from the Urn object specified by the parameter.

System_CAPS_protmethodGetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

System_CAPS_protmethodGetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

System_CAPS_protmethodImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.

System_CAPS_protmethodSystem_CAPS_staticIsCollectionDirty(ICollection)

Determines whether any object in the SqlSmoObject collection has been modified.

System_CAPS_protmethodIsObjectDirty()

Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server.

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

System_CAPS_protmethodIsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

System_CAPS_protmethodIsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

System_CAPS_protmethodMarkDropped()

Sets the SqlSmoState to dropped.

System_CAPS_protmethodMarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodPostAlter()

The method that is activated after the SqlSmoObject is altered.

System_CAPS_protmethodPostCreate()

The method that is activated after the SqlSmoObject is created.

System_CAPS_protmethodPostDrop()

The method that is activated after the SqlSmoObject is dropped.

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.

System_CAPS_protmethodScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

System_CAPS_protmethodScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Overrides Object.ToString().)

System_CAPS_protmethodTouchImpl()

Not implemented.

System_CAPS_protmethodSystem_CAPS_staticTrace(String)

Traces the object.

System_CAPS_protmethodUnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

System_CAPS_protmethodUnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

System_CAPS_protmethodSystem_CAPS_staticUpdateCollectionState2(ICollection)

Updates the collection state of the SqlSmoObject.

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_protfieldm_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

System_CAPS_protfieldsingletonParent

Represents the singleton parent.

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

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

The SqlSmoObject is a generic object that is used to referenced objects that are not of a specified type. The SqlSmoObject is also used as a base class.

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.  

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft