Interface IConventionSequence

Namespace

Microsoft.EntityFrameworkCore.Metadata

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Represents a database sequence in the Microsoft.EntityFrameworkCore.Metadata.IConventionModel in a form that can be mutated while building the model.

public interface IConventionSequence : ISequence, IAnnotatable, IConventionAnnotatable

Inherited Members

ISequence.Name

ISequence.Schema

ISequence.StartValue

ISequence.IncrementBy

ISequence.MinValue

ISequence.MaxValue

ISequence.Type

ISequence.ClrType

ISequence.IsCyclic

Properties

Builder

Gets the builder that can be used to configure this sequence.

IConventionSequenceBuilder Builder { get; }

Property Value

IConventionSequenceBuilder

Model

Gets the Microsoft.EntityFrameworkCore.Metadata.IConventionModel in which this sequence is defined.

IConventionModel Model { get; }

Property Value

IConventionModel

Methods

GetClrTypeConfigurationSource()

Gets the configuration source for ClrType.

[Obsolete("Use GetTypeConfigurationSource")]
ConfigurationSource? GetClrTypeConfigurationSource()

Returns

ConfigurationSource?

The configuration source for ClrType.

GetConfigurationSource()

Gets the configuration source for this IConventionSequence.

ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

The configuration source for IConventionSequence.

GetIncrementByConfigurationSource()

Gets the configuration source for IncrementBy.

ConfigurationSource? GetIncrementByConfigurationSource()

Returns

ConfigurationSource?

The configuration source for IncrementBy.

GetIsCyclicConfigurationSource()

Gets the configuration source for IsCyclic.

ConfigurationSource? GetIsCyclicConfigurationSource()

Returns

ConfigurationSource?

The configuration source for IsCyclic.

GetMaxValueConfigurationSource()

Gets the configuration source for MaxValue.

ConfigurationSource? GetMaxValueConfigurationSource()

Returns

ConfigurationSource?

The configuration source for MaxValue.

GetMinValueConfigurationSource()

Returns the configuration source for MinValue.

ConfigurationSource? GetMinValueConfigurationSource()

Returns

ConfigurationSource?

The configuration source for MinValue.

GetStartValueConfigurationSource()

Returns the configuration source for StartValue.

ConfigurationSource? GetStartValueConfigurationSource()

Returns

ConfigurationSource?

The configuration source for StartValue.

GetTypeConfigurationSource()

Gets the configuration source for ClrType.

ConfigurationSource? GetTypeConfigurationSource()

Returns

ConfigurationSource?

The configuration source for ClrType.

SetClrType(Type, bool)

Sets the Type of values returned by the sequence.

[Obsolete("Use SetType")]
Type SetClrType(Type type, bool fromDataAnnotation = false)

Parameters

type Type

The Type of values returned by the sequence.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

Type

The configured value.

SetIncrementBy(int?, bool)

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

int? SetIncrementBy(int? incrementBy, bool fromDataAnnotation = false)

Parameters

incrementBy int?

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

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

int?

The configured value.

SetIsCyclic(bool?, bool)

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

bool? SetIsCyclic(bool? cyclic, bool fromDataAnnotation = false)

Parameters

cyclic bool?

If true, then the sequence will start again from the beginning when the max value is reached.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool?

The configured value.

SetMaxValue(long?, bool)

Sets the maximum value supported by the sequence.

long? SetMaxValue(long? maxValue, bool fromDataAnnotation = false)

Parameters

maxValue long?

The maximum value supported by the sequence.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

long?

The configured value.

SetMinValue(long?, bool)

Sets the minimum value supported by the sequence.

long? SetMinValue(long? minValue, bool fromDataAnnotation = false)

Parameters

minValue long?

The minimum value supported by the sequence.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

long?

The configured value.

SetStartValue(long?, bool)

Sets the value at which the sequence will start.

long? SetStartValue(long? startValue, bool fromDataAnnotation = false)

Parameters

startValue long?

The value at which the sequence will start.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

long?

The configured value.

SetType(Type, bool)

Sets the Type of values returned by the sequence.

Type SetType(Type type, bool fromDataAnnotation = false)

Parameters

type Type

The Type of values returned by the sequence.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

Type

The configured value.