DatabaseDdlTrigger Class

  • Article

The DatabaseDdlTrigger object represents a SQL Server database data definition language (DDL) trigger.

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.DdlTriggerBase
            Microsoft.SqlServer.Management.Smo.DatabaseDdlTrigger

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

Syntax

'Declaration
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<SfcElementTypeAttribute("DdlTrigger")> _
Public NotInheritable Class DatabaseDdlTrigger _
    Inherits DdlTriggerBase _
    Implements IExtendedProperties, ISfcSupportsDesignMode
'Usage
Dim instance As DatabaseDdlTrigger

[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[SfcElementTypeAttribute("DdlTrigger")]
public sealed class DatabaseDdlTrigger : DdlTriggerBase, 
    IExtendedProperties, ISfcSupportsDesignMode

[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[SfcElementTypeAttribute(L"DdlTrigger")]
public ref class DatabaseDdlTrigger sealed : public DdlTriggerBase, 
    IExtendedProperties, ISfcSupportsDesignMode

[<SealedAttribute>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<SfcElementTypeAttribute("DdlTrigger")>]
type DatabaseDdlTrigger =  
    class 
        inherit DdlTriggerBase 
        interface IExtendedProperties 
        interface ISfcSupportsDesignMode 
    end

public final class DatabaseDdlTrigger extends DdlTriggerBase implements IExtendedProperties, ISfcSupportsDesignMode

The DatabaseDdlTrigger type exposes the following members.

Constructors

  Name Description
Public method DatabaseDdlTrigger() Initializes a new instance of the DatabaseDdlTrigger class.
Public method DatabaseDdlTrigger(Database, String) Initializes a new instance of the DatabaseDdlTrigger class on the specified database and with the specified name.
Public method DatabaseDdlTrigger(Database, String, DatabaseDdlTriggerEventSet, String) Initializes a new instance of the DatabaseDdlTrigger class on the specified database with the specified name. The trigger responds to the specified event set and runs the specified batch.
Public method DatabaseDdlTrigger(Database, String, DatabaseDdlTriggerEventSet, String, String, String) Initializes a new instance of the DatabaseDdlTrigger class on the specified database with the specified name. The trigger responds to the specified event set and runs the specified batch.

Top

Properties

  Name Description
Public property AnsiNullsStatus Gets or sets the Boolean property value that specifies whether ISO NULL handling is enabled in the data definition language (DDL) trigger.
Public property AssemblyName Gets or sets the name of the assembly that contains the managed code that is executed when the data definition language (DDL) trigger is raised.
Public property BodyStartIndex Gets the index value that represents the start of the DDL trigger text body.
Public property ClassName Gets or sets the name of the class in the assembly that contains the managed code that is executed when the data definition language (DDL) trigger is raised.
Public property CreateDate Gets the date and time when the database data definition language (DDL) trigger was created.
Public property DateLastModified Gets the date and time when the database data definition language (DDL) trigger was last modified.
Public property DdlTriggerEvents Gets or sets the set of data definition language (DDL) events that raise the database DDL trigger.
Public property ExecutionContext Gets or sets the execution context type that is used by the database DDL trigger, by itself, by the caller, or by a specified login.
Public property ExecutionContextUser Gets or sets the database user that is the context used when the database DDL trigger executes.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property for the DatabaseDdlTrigger object.
Public property ID Gets the ID value that uniquely identifies the database data definition language (DDL) trigger.
Public property ImplementationType Gets or sets the implementation type for the database data definition language (DDL) trigger.
Public property IsEnabled Gets or sets the Boolean property value that specifies whether the database data definition language (DDL) trigger is enabled.
Public property IsEncrypted Gets or sets a Boolean property value that specifies whether the Transact-SQL batch or managed code is encrypted.
Public property IsSystemObject Gets the Boolean property value that specifies whether the database data definition language (DDL) trigger is a system object.
Public property MethodName Gets or sets the name of the method that is owned by the class in the assembly, which is executed when the trigger is raised.
Public property Name Gets or sets a String value that specifies the name of the DDL trigger. (Overrides NamedSmoObject.Name.)
Public property NotForReplication Gets or sets a Boolean property value that specifies whether the database data definition language (DDL) trigger is available for replication.
Public property Parent Gets or sets the Database object that is the parent of the DatabaseDdlTrigger object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property QuotedIdentifierStatus Gets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Text Gets the Transact-SQL statement that defines the database data definition language (DDL) trigger.
Public property TextBody Gets or sets a String value that specifies the text body that is used to define the DDL trigger. (Overrides DdlTriggerBase.TextBody.)
Public property TextHeader Gets or sets a String value that specifies the text header that is used to define the DDL trigger. (Overrides DdlTriggerBase.TextHeader.)
Public property TextMode Gets or sets a Boolean value that specifies whether the DDL trigger is editable as text. (Overrides DdlTriggerBase.TextMode.)
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 DatabaseDdlTrigger object property changes on the instance of SQL Server. (Inherited from DdlTriggerBase.)
Public method Create Creates a database data definition language (DDL) trigger on the instance of SQL Server as defined by the DatabaseDdlTrigger object. (Inherited from DdlTriggerBase.)
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the database data definition language (DDL) trigger. (Inherited from DdlTriggerBase.)
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 database data definition language (DDL) trigger. (Inherited from DdlTriggerBase.)
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the database data definition language (DDL) trigger as specified by the script options. (Inherited from DdlTriggerBase.)
Public method ScriptHeader Generates a Transact-SQL script that can be used to re-create the database data definition language (DDL) trigger header as specified by the script options. (Inherited from DdlTriggerBase.)
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 specifies whether the trigger supports design mode.

Top

Remarks

DDL triggers run a Transact-SQL or user-defined function in response to certain DDL events.

SMO provides programmatic access to allow management of all DDL trigger functionality with the DatabaseDdlTrigger object and the ServerDdlTrigger object.

Database DDL triggers respond to events within the scope of the database and server DDL triggers respond to events within the scope of the SQL Server instance.

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

To set DatabaseDdlTrigger object properties, users must have ALTER ANY DATABASE DDL TRIGGER permission on the database.

To create a DDL trigger, users must have ALTER ANY DATABASE DDL TRIGGER permission on the database.

To drop a DDL trigger, users must have ALTER ANY DATABASE DDL TRIGGER permission on the database.

To enable or disable the DDL trigger, users must have ALTER ANY DATABASE DDL TRIGGER permission on the database.

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

DDL Triggers