Default Class

  • Article

The Default object represents a SQL Server default.

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.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.DefaultRuleBase
              Microsoft.SqlServer.Management.Smo.Default

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Default _
    Inherits DefaultRuleBase _
    Implements ISfcSupportsDesignMode
'Usage
Dim instance As Default

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Default : DefaultRuleBase, 
    ISfcSupportsDesignMode

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

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Default =  
    class 
        inherit DefaultRuleBase 
        interface ISfcSupportsDesignMode 
    end

public final class Default extends DefaultRuleBase implements ISfcSupportsDesignMode

The Default type exposes the following members.

Constructors

  Name Description
Public method Default() Initializes a new instance of the Default class.
Public method Default(Database, String) Initializes a new instance of the Default class on the specified database and with the specified name.
Public method Default(Database, String, String) Initializes a new instance of the Default class on the specified database and with the specified name and schema.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the default was created.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the Default object or the Rule object. (Inherited from DefaultRuleBase.)
Public property ID Gets the ID value that uniquely identifies the default.
Public property Name Gets or sets the name of the schema. (Inherited from ScriptSchemaObjectBase.)
Public property Parent Gets or sets the Database object that is the parent of the Default object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property Schema Gets or sets the schema. (Inherited from ScriptSchemaObjectBase.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property TextBody Gets or sets the text that defines the default or rule. (Inherited from DefaultRuleBase.)
Public property TextHeader Gets or sets the header of the text body that defines the default or rule. (Inherited from DefaultRuleBase.)
Public property TextMode Gets or sets the Boolean property value that specifies whether the Default object or Rule object header is editable as text. (Inherited from DefaultRuleBase.)
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 Default object or Rule object property changes on instance of SQL Server. (Inherited from DefaultRuleBase.)
Public method BindToColumn(String, String) Binds the default or rule to the specified column in the specified table. (Inherited from DefaultRuleBase.)
Public method BindToColumn(String, String, String) Binds the default or rule to the specified column in the specified table with the specified schema. (Inherited from DefaultRuleBase.)
Public method BindToDataType Binds the default or rule to a data type. (Inherited from DefaultRuleBase.)
Public method ChangeSchema Changes the schema for the default.
Public method Create Creates a default or rule on the instance of SQL Server as defined by the Default object or Rule object. (Inherited from DefaultRuleBase.)
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the rule or the default. (Inherited from DefaultRuleBase.)
Public method EnumBoundColumns Enumerates a list of columns to which the default or rule is bound. (Inherited from DefaultRuleBase.)
Public method EnumBoundDataTypes Enumerates a list of data types to which the default or rule is bound. (Inherited from DefaultRuleBase.)
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 Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the default or rule. (Inherited from DefaultRuleBase.)
Public method Script(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.)
Public method ScriptHeader 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.)
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 UnbindFromColumn(String, String) Unbinds the default or rule from the specified column. (Inherited from DefaultRuleBase.)
Public method UnbindFromColumn(String, String, String) Unbinds the default or rule from the specified column with the specified table schema. (Inherited from DefaultRuleBase.)
Public method UnbindFromDataType Unbinds the default or rule from the specified data type (Inherited from DefaultRuleBase.)
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 Default object properties, users can be a member of the public fixed server role.

To set Default object properties, users must have CREATE DEFAULT permission on the database.

To create a default, users must have CREATE DEFAULT permission on the database.

To drop a default, users must have DROP DEFAULT permission on the database.

To bind a default to a column or unbind a default from a column, users must be a member of db_owner or db_ddladmin fixed database roles.

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.

Examples

Creating, Altering, and Removing Defaults

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

Defaults

CREATE DEFAULT (Transact-SQL)