Skip To Content ArcGIS for Developers Sign In Dashboard

RelationshipInfo QML Type

Information about the relationship between two tables. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.1
Inherits:

Object

Properties

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

A RelationshipInfo identifies:

  • a table.
  • the related table that the table is related to.
  • the table's role in the relationship (origin or destination).
  • the relationship's cardinality.
  • whether this is a composite relationship.

A table can participate in more than one relationship. Further, a table may be an origin table in one relationship and also a destination table in another relationship.

The relationship's cardinality describes whether features in a table are related to only one feature in the other table, or whether a feature may be related to multiple features.

In a simple relationship, the features in the participating tables can exist without the other. For example, a transformer and an electric pole may be related but one's existence does not depend on the other. Deleting the origin features will simply disassociate the destination features from the origin features.

In a composite relationship, the destination features cannot exist without the origin features. When the origin feature is deleted, the related destination feature is deleted as well. This is called a cascade delete. This dependency also means that each destination feature must be linked to a counterpart origin feature.

Property Documentation

cardinality : Enums.RelationshipCardinality

Returns this relationship's cardinality (read-only).

See also Enums.RelationshipCardinality.


isComposite : bool

Returns whether the relationship is composite (read-only).

In a composite relationship, a feature in the destination table must always be associated with an origin feature. Orphan features in the destination tables are not permitted. Therefore, destination table features will be deleted when their associated origin table features are deleted. (This is called a cascade delete.)


keyField : string

Returns the key field of this table (read-only).

This is the field that links the origin and destination tables of this relationship.


name : string

Returns the name of the relationship (read-only).


relatedTableId : string

Returns the ID of the related table (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

See also relatedTableIdAsInt.


relatedTableIdAsInt : int

The same as relatedTableId but represented as an integer type (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


relationshipId : string

Returns the ID of this relationship, this is shared between origin and destination tables (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.2.

See also relationshipIdAsInt.


relationshipIdAsInt : int

The same as relationshipId but represented as an integer type (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


role : Enums.RelationshipRole

Returns the role of the table in this relationship (read-only).

See also Enums.RelationshipRole.



Feedback on this topic?