Table of Contents

Class RelationshipAttribute

Namespace
NextORM.Core
Assembly
nextorm.core.dll

Declares a navigation relationship on an entity property. Placed on the navigation property; the kind is derived from the navigation shape (a collection is OneToMany, a reference is ManyToOne).

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public sealed class RelationshipAttribute : Attribute
Inheritance
RelationshipAttribute
Inherited Members
Extension Methods

Remarks

The foreign key is declared either as one property name with ForeignKey (the legacy single-column form) or as an ordered list of property names with ForeignKeys; exactly one of the two forms must be set. PrincipalKeys optionally declares an ordered principal key; when it is omitted the principal key is the full key of the principal entity in entity-metadata order. Component pairing is positional and only the underlying mapped CLR types are compared.

The attribute and the fluent HasMany/HasOne registration produce the same metadata model. When both are used for the same navigation property, the fluent declaration wins and the attribute is ignored. Only declared navigations are excluded from column mapping; no convention is applied. The attribute does not declare one-to-one or many-to-many relationships; those are fluent-only.

Properties

ForeignKey

The name of the single foreign-key property on the dependent side: a property of the related type for a collection navigation (the declaring type is the principal), or a property of the declaring type for a reference navigation (the declaring type is the dependent). Mutually exclusive with ForeignKeys.

public string? ForeignKey { get; set; }

Property Value

string

ForeignKeys

The ordered names of the foreign-key properties on the dependent side. Mutually exclusive with ForeignKey and must not be empty, contain duplicates, or name an unmapped member. The declaration order is the component order used for positional pairing.

public string[]? ForeignKeys { get; set; }

Property Value

string[]

PrincipalKeys

The optional ordered names of the principal-key properties. When omitted, the principal key is the full key of the principal entity in entity-metadata order. When set, the component count must equal the foreign-key component count and the positional underlying types must match; an explicit principal key may select mapped non-key properties.

public string[]? PrincipalKeys { get; set; }

Property Value

string[]
Edit this page