Rule Class

 

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

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


[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class Rule sealed : DefaultRuleBase, ISfcSupportsDesignMode

NameDescription
System_CAPS_pubmethodRule()

Initializes a new instance of the Rule class.

System_CAPS_pubmethodRule(Database^, String^)

Initializes a new instance of the Rule class on the specified database and with the specified name.

System_CAPS_pubmethodRule(Database^, String^, String^)

Initializes a new instance of the Rule class on the specified database, with the specified name and schema.

NameDescription
System_CAPS_pubpropertyCreateDate

Gets the time and date when the rule was created.

System_CAPS_pubpropertyDateLastModified

Gets the time and date when the rule was last modified.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the Default object or the Rule object. (Inherited from DefaultRuleBase.)

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the rule.

System_CAPS_pubpropertyName

Gets or sets the name of the schema.(Inherited from ScriptSchemaObjectBase.)

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the Rule object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySchema

Gets or sets the schema.(Inherited from ScriptSchemaObjectBase.)

System_CAPS_pubpropertyState

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

System_CAPS_pubpropertyTextBody

Gets or sets the text that defines the default or rule.(Inherited from DefaultRuleBase.)

System_CAPS_pubpropertyTextHeader

Gets or sets the header of the text body that defines the default or rule.(Inherited from DefaultRuleBase.)

System_CAPS_pubpropertyTextMode

Gets or sets the Boolean property value that specifies whether the Default object or Rule object header is editable as text. (Inherited from DefaultRuleBase.)

System_CAPS_pubpropertyUrn

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

System_CAPS_pubpropertyUserData

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

NameDescription
System_CAPS_pubmethodAlter()

Updates any Default object or Rule object property changes on instance of SQL Server.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodBindToColumn(String^, String^)

Binds the default or rule to the specified column in the specified table.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodBindToColumn(String^, String^, String^)

Binds the default or rule to the specified column in the specified table with the specified schema. (Inherited from DefaultRuleBase.)

System_CAPS_pubmethodBindToDataType(String^, Boolean)

Binds the default or rule to a data type.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodChangeSchema(String^)

Changes the schema associated with the rule.

System_CAPS_pubmethodCreate()

Creates a default or rule on the instance of SQL Server as defined by the Default object or Rule object.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the rule or the default.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodDropIfExists()

(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodEnumBoundColumns()

Enumerates a list of columns to which the default or rule is bound.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodEnumBoundDataTypes()

Enumerates a list of data types to which the default or rule is bound.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object^)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String^)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the default or rule.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodScript(ScriptingOptions^)

Generates a Transact-SQL script that can be used to re-create the default or rule as specified by the script options.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodScriptHeader(Boolean)

Generates a Transact-SQL script that can be used to re-create the default or rule header as specified by the script options.(Inherited from DefaultRuleBase.)

System_CAPS_protmethodSetParentImpl(SqlSmoObject^)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodUnbindFromColumn(String^, String^)

Unbinds the default or rule from the specified column.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodUnbindFromColumn(String^, String^, String^)

Unbinds the default or rule from the specified column with the specified table schema.(Inherited from DefaultRuleBase.)

System_CAPS_pubmethodUnbindFromDataType(String^, Boolean)

Unbinds the default or rule from the specified data type (Inherited from DefaultRuleBase.)

System_CAPS_pubmethodValidate(String^, array<Object^>^)

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

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

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.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

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.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyType(String^)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyValue(String^, Type^)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

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.(Inherited from SqlSmoObject.)

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.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetPropertyValue(String^, Type^, Object^)

Sets the property value.(Inherited from SqlSmoObject.)

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.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode::IsDesignMode

To get Rule object properties, users can be a member of the public fixed server role.

To set Rule object properties, users must have CREATE RULE permission on the parent database or be a member of the db_owner fixed database role.

To create a rule, users must have CREATE RULE permission on the parent database or be a member of the db_owner fixed database role.

To drop a rule, users must have ALTER permission on the schema to which the rule belongs.

To bind or unbind a rule to a table, users must have ALTER permission on the table.

To bind or unbind a rule to a data type, users must have ALTER permission on the schema to which the data type belongs.

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
Show: