NavigationProperty

open class NavigationProperty : Property, @unchecked Sendable

Represents an OData navigation property.

  • Name of relationship that this navigation property belongs to. Some data model formats (e.g. OData V2) make use of named relationships in their file-based format. Retaining this name can be useful to allow conversion of parsed metadata back into file-based format. If the relationship name is non-null, then fromRelationshipRole and toRelationshipRole must also be non-null.

    Declaration

    Swift

    final public var relationshipName: String?
  • Role that the entity holding this navigation property plays in a named relationship.

    See also

    relationshipName.

    Declaration

    Swift

    final public var fromRelationshipRole: String?
  • Role that the related entity for this navigation property plays in a named relationship.

    See also

    relationshipName.

    Declaration

    Swift

    final public var toRelationshipRole: String?
  • Default initializer.

    Declaration

    Swift

    override public init()
  • If this property is a navigation property, then does it contain its target?

    Declaration

    Swift

    override open var containsTarget: Bool { get set }
  • If this property is a navigation property, then where are foreign keys found.

    See also

    constants.

    Declaration

    Swift

    override open var hasForeignKeys: Int { get set }
  • JoinSetRelations for this navigation property, which contaions information to navigating to the partner property through server-only navigation properties and entityset.

    Declaration

    Swift

    open var joinSetRelations: JoinSetRelations? { get set }
  • Navigation to the partner property can be realized through a join entityset, using this (server-only) navigation property.

    Declaration

    Swift

    open var joinUsingNavigationProperty: NavigationProperty? { get set }
  • If this property is a navigation property, then the action upon deletion of the source entity. Zero indicates an undefined action.

    See also

    ON_DELETE_* constants.

    Declaration

    Swift

    override open var onDeleteAction: Int { get set }
  • If this property is a navigation property with a defined partner property, then the path of the partner.

    Declaration

    Swift

    override open var partnerPath: String? { get set }
  • If this property is a navigation property with referential constraints, then a map of constraints (from property name in the dependent entity to property name in the principal entity).

    Declaration

    Swift

    override open var referentialConstraints: StringMap { get set }
  • Navigation to the partner property can be realized through a join entityset, using this (server-only) navigation property.

    Declaration

    Swift

    open var serverOnly: Bool { get set }