Interface IConventionSkipNavigationBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.dll

Provides a simple API surface for configuring an IConventionSkipNavigation from conventions.

This interface is typically used by database providers (and other extensions). It is generally not used in application code.

public interface IConventionSkipNavigationBuilder : IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>, IConventionAnnotatableBuilder

Inherited Members

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.HasAnnotation(string, object, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.HasNonNullAnnotation(string, object, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.HasNoAnnotation(string, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.HasField(string, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.HasField(FieldInfo, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.CanSetField(string, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.CanSetField(FieldInfo, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.UsePropertyAccessMode(PropertyAccessMode?, bool)

IConventionPropertyBaseBuilder<IConventionSkipNavigationBuilder>.CanSetPropertyAccessMode(PropertyAccessMode?, bool)

IConventionAnnotatableBuilder.CanSetAnnotation(string, object, bool)

IConventionAnnotatableBuilder.CanRemoveAnnotation(string, bool)

IConventionAnnotatableBuilder.ModelBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata

Gets the navigation property being configured.

IConventionSkipNavigation Metadata { get; }

Property Value

IConventionSkipNavigation

Methods

AutoInclude(bool?, bool)

Configures this navigation to be automatically included in a query.

IConventionSkipNavigationBuilder? AutoInclude(bool? autoInclude, bool fromDataAnnotation = false)

Parameters

autoInclude bool?

A value indicating whether the navigation should be automatically included.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionSkipNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.

CanSetAutoInclude(bool?, bool)

Returns a value indicating whether this navigation can be configured to be automatically included in a query from the current configuration source.

bool CanSetAutoInclude(bool? autoInclude, bool fromDataAnnotation = false)

Parameters

autoInclude bool?

A value indicating whether the navigation should be automatically included.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if automatically included can be set for this navigation.

CanSetForeignKey(IConventionForeignKey?, bool)

Returns a value indicating whether the ForeignKey can be set for this navigation from the given configuration source.

bool CanSetForeignKey(IConventionForeignKey? foreignKey, bool fromDataAnnotation = false)

Parameters

foreignKey IConventionForeignKey

The foreign key. Passing null will result in there being no foreign key associated.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the ForeignKey can be set for this property.

CanSetInverse(IConventionSkipNavigation?, bool)

Returns a value indicating whether the Inverse can be set for this navigation from the given configuration source.

bool CanSetInverse(IConventionSkipNavigation? inverse, bool fromDataAnnotation = false)

Parameters

inverse IConventionSkipNavigation

The inverse skip navigation. Passing null will result in there being no inverse navigation property defined.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the Inverse can be set for this property.

CanSetLazyLoadingEnabled(bool?, bool)

Returns a value indicating whether this navigation can be configured to enable lazy-loading from the current configuration source.

bool CanSetLazyLoadingEnabled(bool? lazyLoadingEnabled, bool fromDataAnnotation = false)

Parameters

lazyLoadingEnabled bool?

A value indicating whether the navigation should be enabled for lazy-loading.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if automatically included can be set for this navigation.

EnableLazyLoading(bool?, bool)

Configures this navigation to be enabled for lazy-loading.

IConventionSkipNavigationBuilder? EnableLazyLoading(bool? lazyLoadingEnabled, bool fromDataAnnotation = false)

Parameters

lazyLoadingEnabled bool?

A value indicating whether the navigation should be enabled for lazy-loading.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionSkipNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.

HasForeignKey(IConventionForeignKey?, bool)

Sets the foreign key.

IConventionSkipNavigationBuilder? HasForeignKey(IConventionForeignKey? foreignKey, bool fromDataAnnotation = false)

Parameters

foreignKey IConventionForeignKey

The foreign key. Passing null will result in there being no foreign key associated.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionSkipNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.

HasInverse(IConventionSkipNavigation?, bool)

Sets the inverse skip navigation.

IConventionSkipNavigationBuilder? HasInverse(IConventionSkipNavigation? inverse, bool fromDataAnnotation = false)

Parameters

inverse IConventionSkipNavigation

The inverse skip navigation. Passing null will result in there being no inverse navigation property defined.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionSkipNavigationBuilder

The same builder instance if the configuration was applied, null otherwise.