Share via


ISequence Interface

Definition

Represents a database sequence in the model.

public interface ISequence
public interface ISequence : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
public interface ISequence : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence
type ISequence = interface
type ISequence = interface
    interface IAnnotatable
type ISequence = interface
    interface IReadOnlySequence
    interface IReadOnlyAnnotatable
    interface IAnnotatable
Public Interface ISequence
Public Interface ISequence
Implements IAnnotatable
Public Interface ISequence
Implements IAnnotatable, IReadOnlySequence
Derived
Implements

Remarks

See Database sequences for more information and examples.

Properties

ClrType
Obsolete.

Gets the Type of values returned by the sequence.

IncrementBy

Gets the amount incremented to obtain each new value in the sequence.

IsCyclic

Gets the value indicating whether the sequence will start again from the beginning when the max value is reached.

Item[String]

Gets the value of the annotation with the given name, returning null if it does not exist.

(Inherited from IReadOnlyAnnotatable)
MaxValue

Gets the maximum value supported by the sequence, or null if none has been set.

MinValue

Gets the minimum value supported by the sequence, or null if none has been set.

Model

Gets the model in which this sequence is defined.

ModelSchema

Gets the model schema of the sequence. This is the one specified in HasSequence(ModelBuilder, String, String) and the one to use with FindSequence(IConventionModel, String, String).

(Inherited from IReadOnlySequence)
Name

Gets the name of the sequence in the database.

Schema

Gets the database schema that contains the sequence.

StartValue

Gets the value at which the sequence will start.

Type

Gets the Type of values returned by the sequence.

Methods

AddRuntimeAnnotation(String, Object)

Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from IAnnotatable)
AnnotationsToDebugString(Int32)

Gets the debug string for all annotations declared on the object.

(Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)

Gets the value of the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
GetAnnotation(String)

Gets the annotation with the given name, throwing if it does not exist.

(Inherited from IReadOnlyAnnotatable)
GetAnnotations()

Gets all annotations on the current object.

(Inherited from IReadOnlyAnnotatable)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Gets the value of the runtime annotation with the given name, adding it if one does not exist.

(Inherited from IAnnotatable)
GetRuntimeAnnotations()

Gets all the runtime annotations on the current object.

(Inherited from IAnnotatable)
RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

(Inherited from IAnnotatable)
SetRuntimeAnnotation(String, Object)

Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.

(Inherited from IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Creates a human-readable representation of the given metadata.

Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.

(Inherited from IReadOnlySequence)

Extension Methods

AnnotationsToDebugString(IAnnotatable, Int32)

Gets the debug string for all annotations declared on the object.

GetAnnotation(IAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

ToDebugString(ISequence, MetadataDebugStringOptions, Int32)

Creates a human-readable representation of the given metadata.

Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.

GetFluentApiCalls(ISequence, IAnnotationCodeGenerator)

Gets the fluent API calls to configure a sequence.

Applies to