IConventionSequence Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v3.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v3.1.0

Package:: Microsoft.EntityFrameworkCore.Relational v5.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v6.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a database sequence in the model in a form that can be mutated while building the model.

public interface IConventionSequence : Microsoft.EntityFrameworkCore.Metadata.ISequence

public interface IConventionSequence : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.ISequence

public interface IConventionSequence : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence

type IConventionSequence = interface
    interface ISequence

type IConventionSequence = interface
    interface ISequence
    interface IAnnotatable
    interface IConventionAnnotatable

type IConventionSequence = interface
    interface IReadOnlySequence
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionSequence
Implements ISequence

Public Interface IConventionSequence
Implements IConventionAnnotatable, ISequence

Public Interface IConventionSequence
Implements IConventionAnnotatable, IReadOnlySequence

Implements: ISequence IAnnotatable IConventionAnnotatable IReadOnlyAnnotatable IReadOnlySequence

Remarks

See Database sequences for more information and examples.

Properties

Builder	Gets the builder that can be used to configure this sequence.
ClrType	Obsolete. Gets the Type of values returned by the sequence. (Inherited from IReadOnlySequence)
IncrementBy	Gets the amount incremented to obtain each new value in the sequence. (Inherited from IReadOnlySequence)
IsCyclic	Gets the value indicating whether the sequence will start again from the beginning when the max value is reached. (Inherited from IReadOnlySequence)
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
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. (Inherited from IReadOnlySequence)
MinValue	Gets the minimum value supported by the sequence, or `null` if none has been set. (Inherited from IReadOnlySequence)
Model	Gets the IConventionModel 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. (Inherited from IReadOnlySequence)
Schema	Gets the database schema that contains the sequence. (Inherited from IReadOnlySequence)
StartValue	Gets the value at which the sequence will start. (Inherited from IReadOnlySequence)
Type	Gets the type of values returned by the sequence. (Inherited from IReadOnlySequence)

Methods

AddAnnotation(String, Object, Boolean)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object. (Inherited from IConventionAnnotatable)
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)
GetClrTypeConfigurationSource()	Obsolete. Gets the configuration source for ClrType.
GetConfigurationSource()	Gets the configuration source for this IConventionSequence.
GetIncrementByConfigurationSource()	Gets the configuration source for IncrementBy.
GetIsCyclicConfigurationSource()	Gets the configuration source for IsCyclic.
GetMaxValueConfigurationSource()	Gets the configuration source for MaxValue.
GetMinValueConfigurationSource()	Returns the configuration source for MinValue.
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)
GetStartValueConfigurationSource()	Returns the configuration source for StartValue.
GetTypeConfigurationSource()	Gets the configuration source for Type.
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from IAnnotatable)
SetAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
SetClrType(Type, Boolean)	Obsolete. Sets the Type of values returned by the sequence.
SetIncrementBy(Nullable<Int32>, Boolean)	Sets the amount incremented to obtain each new value in the sequence.
SetIsCyclic(Nullable<Boolean>, Boolean)	Sets whether the sequence will start again from the beginning when the max value is reached.
SetMaxValue(Nullable<Int64>, Boolean)	Sets the maximum value supported by the sequence.
SetMinValue(Nullable<Int64>, Boolean)	Sets the minimum value supported by the sequence.
SetOrRemoveAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if `null` is supplied. (Inherited from IConventionAnnotatable)
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)
SetStartValue(Nullable<Int64>, Boolean)	Sets the value at which the sequence will start.
SetType(Type, Boolean)	Sets the Type of values returned by the sequence.
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

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object.
GetAnnotation(IConventionAnnotatable, String)	Gets the annotation with the given name, throwing if it does not exist.
SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if `null` is supplied.
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.

Applies to