Sequence Class

This class represents the SQL Server Sequence. A sequence is a user-defined schema bound object that generates a sequence of numeric values according to the specification with which the sequence was created. The sequence of numeric values is generated in an ascending or descending order at a defined interval and can be configured to restart (cycle) when exhausted. Sequences, unlike identity columns, are not associated with specific tables. Applications refer to a sequence object to retrieve its next value. The relationship between sequences and tables is controlled by the application. User applications can reference a sequence object and coordinate the values across multiple rows and tables.

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.Sequence

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

Syntax

'Declaration
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SEQUENCE")> _
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("CREATE_SEQUENCE", "SEQUENCE")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<StateChangeEventAttribute("ALTER_SEQUENCE", "SEQUENCE")> _
<StateChangeEventAttribute("RENAME", "SEQUENCE")> _
<StateChangeEventAttribute("ALTER_SCHEMA", "SEQUENCE")> _
Public NotInheritable Class Sequence _
    Inherits ScriptSchemaObjectBase _
    Implements IObjectPermission, ICreatable, IDroppable, IRenamable,  _
    IExtendedProperties, IScriptable, IAlterable
'Usage
Dim instance As Sequence

[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SEQUENCE")]
[PhysicalFacetAttribute]
[StateChangeEventAttribute("CREATE_SEQUENCE", "SEQUENCE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[StateChangeEventAttribute("ALTER_SEQUENCE", "SEQUENCE")]
[StateChangeEventAttribute("RENAME", "SEQUENCE")]
[StateChangeEventAttribute("ALTER_SCHEMA", "SEQUENCE")]
public sealed class Sequence : ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, IAlterable

[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"SEQUENCE")]
[PhysicalFacetAttribute]
[StateChangeEventAttribute(L"CREATE_SEQUENCE", L"SEQUENCE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[StateChangeEventAttribute(L"ALTER_SEQUENCE", L"SEQUENCE")]
[StateChangeEventAttribute(L"RENAME", L"SEQUENCE")]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"SEQUENCE")]
public ref class Sequence sealed : public ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, IAlterable

[<SealedAttribute>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SEQUENCE")>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("CREATE_SEQUENCE", "SEQUENCE")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<StateChangeEventAttribute("ALTER_SEQUENCE", "SEQUENCE")>]
[<StateChangeEventAttribute("RENAME", "SEQUENCE")>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "SEQUENCE")>]
type Sequence =  
    class 
        inherit ScriptSchemaObjectBase 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface IAlterable 
    end

public final class Sequence extends ScriptSchemaObjectBase implements IObjectPermission, ICreatable, IDroppable, IRenamable, IExtendedProperties, IScriptable, IAlterable

The Sequence type exposes the following members.

Constructors

	Name	Description
	Sequence()	Initializes a new instance of the Sequence class.
	Sequence(Database, String)	Initializes a new instance of the Sequence class with specified parent database and name.
	Sequence(Database, String, String)	Initializes a new instance of the Sequence class with specified parent database, name and schema.

Top

Properties

	Name	Description
	CacheSize	Gets or sets the number of sequence values to be cached.
	CreateDate	Gets a DateTime representing the date and time when the sequence was created.
	CurrentValue	Gets the Object which represents the current value of the Sequence
	DataType	Gets or sets the [Microsoft.SqlServer.Management.Smo.DataType] of this sequence.
	DateLastModified	Get the DateTime representing the date and time the sequence was last modified.
	Events	Gets the SequenceEvents object associated with this sequence.
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property for the ExtendedPropertyCollection object.
	ID	Gets the ID value that uniquely identifies the sequence.
	IncrementValue	Gets or sets the object that represents the increment value for the sequence.
	IsCycleEnabled	Gets or sets a Boolean that specifies whether the sequence object should restart from the minimum value (or maximum for descending sequence objects) or throw an exception when its minimum or maximum value is exceeded.
	IsExhausted	Gets a Boolean which indicates whether the sequence is exhausted.
	IsSchemaOwned	Gets a Boolean value that indicates whether the Sequence object is owned by a schema.
	MaxValue	Gets or sets an Object that specifies the upper bound for the sequence object. The default maximum value for a new sequence object is the maximum value of the data type of the sequence object.
	MinValue	Gets or sets an Object that specifies the lower bound for the sequence object. The default minimum value for a new sequence object is the minimum value of the data type of the sequence object.
	Name	Gets or sets the name of the sequence. (Overrides ScriptSchemaObjectBase.Name.)
	Owner	Gets the name of the owner of the Sequence object.
	Parent	Gets the Database object that is the parent of the Sequence object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Schema	Gets or sets a String which contains the name of the schema which owns the Sequence. (Overrides ScriptSchemaObjectBase.Schema.)
	SequenceCacheType	Gets or sets a SequenceCacheType which indicates how the sequence is cached.
	StartValue	Gets or sets a Object which represents the starting value of the sequence.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any Sequence object property changes on the instance of Microsoft SQL Server.
	Create	Creates a sequence on the instance of SQL Server as defined by the Sequence object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the sequence.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the sequence.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the sequence.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantees granted the specified set of permissions on the sequence.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the sequence from the database.
	EnumObjectPermissions()	Enumerates a list of object permissions for the Sequence.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the Sequence.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the Sequence.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the Sequence.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the Sequence.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the Sequence.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the Sequence.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the sequence
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the sequence under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the sequence under an assumed role.
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the objects and properties on the Sequence object. (Overrides ScriptNameObjectBase.Refresh().)
	Rename	Renames the sequence.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the sequence.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a set of grantees on the sequence.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes a previously granted set of permissions from a grantee from the sequence and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from a set of grantees from the sequence and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes a previously granted set of permissions from a grantee from the sequence and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes a previously granted set of permissions from a set of grantees from the sequence and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users within an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the sequence.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the sequence.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

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