Class OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IMutableDbFunction that an entity type is mapped to.

public class OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> : OwnedNavigationTableValuedFunctionBuilder, IInfrastructure<IConventionDbFunctionBuilder>, IInfrastructure<OwnedNavigationBuilder>, IInfrastructure<OwnedNavigationBuilder<TOwnerEntity, TDependentEntity>> where TOwnerEntity : class where TDependentEntity : class

Type Parameters

TOwnerEntity

The entity type owning the relationship.

TDependentEntity

The dependent entity type of the relationship.

Inheritance

object

DbFunctionBuilderBase

OwnedNavigationTableValuedFunctionBuilder

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

Implements

IInfrastructure<IConventionDbFunctionBuilder>

IInfrastructure<OwnedNavigationBuilder>

IInfrastructure<OwnedNavigationBuilder<TOwnerEntity, TDependentEntity>>

Inherited Members

DbFunctionBuilderBase.HasParameter(string)

DbFunctionBuilderBase.Builder

DbFunctionBuilderBase.Metadata

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OwnedNavigationTableValuedFunctionBuilder(IMutableDbFunction, OwnedNavigationBuilder<TOwnerEntity, TDependentEntity>)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public OwnedNavigationTableValuedFunctionBuilder(IMutableDbFunction function, OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> ownedNavigationBuilder)

Parameters

function IMutableDbFunction

ownedNavigationBuilder OwnedNavigationBuilder<TOwnerEntity, TDependentEntity>

Methods

HasAnnotation(string, object?)

Adds or updates an annotation on the database function. If an annotation with the key specified in annotation already exists, its value will be updated.

public virtual OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> HasAnnotation(string annotation, object? value)

Parameters

annotation string

The key of the annotation to be added or updated.

value object

The value to be stored in the annotation.

Returns

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

The same builder instance so that multiple configuration calls can be chained.

HasName(string)

Sets the name of the database function.

public virtual OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> HasName(string name)

Parameters

name string

The name of the function in the database.

Returns

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.

HasParameter(string, Action<DbFunctionParameterBuilder>)

Returns an object that can be used to configure a parameter with the given name. If no parameter with the given name exists, then a new parameter will be added.

public virtual OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> HasParameter(string name, Action<DbFunctionParameterBuilder> buildAction)

Parameters

name string

The parameter name.

buildAction Action<DbFunctionParameterBuilder>

An action that performs configuration of the parameter.

Returns

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

The builder to use for further parameter configuration.

Remarks

See Database functions for more information and examples.

HasSchema(string?)

Sets the schema of the database function.

public virtual OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> HasSchema(string? schema)

Parameters

schema string

The schema of the function in the database.

Returns

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.

IsBuiltIn(bool)

Marks whether the database function is built-in.

public virtual OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity> IsBuiltIn(bool builtIn = true)

Parameters

builtIn bool

The value indicating whether the database function is built-in.

Returns

OwnedNavigationTableValuedFunctionBuilder<TOwnerEntity, TDependentEntity>

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.