Share via

Check Class

  • Article

The Check object represents a SQL Server check constraint. 

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Check

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

Syntax

'Declaration
Public NotInheritable Class Check _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IRenamable, IMarkForDrop,  _
    IAlterable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
'Usage
Dim instance As Check

public sealed class Check : ScriptNameObjectBase, 
    ICreatable, IDroppable, IRenamable, IMarkForDrop, IAlterable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode

public ref class Check sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IRenamable, IMarkForDrop, IAlterable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode

[<SealedAttribute>]
type Check =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IMarkForDrop 
        interface IAlterable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
    end

public final class Check extends ScriptNameObjectBase implements ICreatable, IDroppable, IRenamable, IMarkForDrop, IAlterable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode

The Check type exposes the following members.

Constructors

  Name Description
Public method Check() Initializes a new instance of the Check class.
Public method Check(SqlSmoObject, String) Initializes a new instance of the Check class, which is owned by the specified parent object and has the specified name.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time that the check constraint was created.
Public property DateLastModified Gets the date and time that the check constraint was last modified.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the Check object.
Public property ID Gets the database ID value that uniquely identifies the check constraint.
Public property IsChecked Gets the Boolean property value that specifies whether the constraint was enabled without checking existing rows, so constraint may not hold for all rows
Public property IsEnabled Gets the Boolean property value that specifies whether the check constraint is enabled.
Public property IsFileTableDefined Gets a value that specifies whether the check constraint defines a file table.
Public property IsSystemNamed Gets the Boolean property value that specifies whether the check constraint was named automatically by Microsoft SQL Server or named by the database object creator.
Public property Name Gets or sets the name of the check constraint. (Overrides NamedSmoObject.Name.)
Public property NotForReplication Gets the Boolean property value that specifies whether the check constraint is available for replication or not.
Public property Parent Gets the SqlSmoObject object that is the parent of the Check object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Text Gets or sets the Transact-SQL statement that defines the check constraint.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any Check object property changes on an instance of Microsoft SQL Server.
Public method Create Creates a check constraint on the instance of SQL Server as defined by the Check object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the check constraint.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method MarkForDrop Marks the foreign key to be dropped next time its parent Table object is altered by the Alter method.
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Marks the foreign key to be dropped next time its parent Table object is altered by the Alter method.
Public method Script() Generates a Transact-SQL script that can be used to re-create the check constraint.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the check constraint as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

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

To set Check object properties and run the Alter method, users must have ALTER permission on the parent table or column, or be a member of the db_owner fixed database role.

To create a check constraint, users must have ALTER permission on the parent table, or be a member of the db_owner fixed database role.

To drop a check constraint, users must have ALTER permission on the parent table, or be a member of the db_owner fixed database role.

Thread Safety

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.

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Working with Database Objects

CHECK Constraints

CREATE TABLE (Transact-SQL)