RelationshipInfo Classe

Modèle de retour typé pour les métadonnées de relation.

Retourné par create_one_to_many_relationship, create_many_to_many_relationship, get_relationshipet create_lookup_field.

Exemple :


   result = client.tables.create_one_to_many_relationship(lookup, relationship)
   print(result.relationship_schema_name)
   print(result.lookup_schema_name)

Constructeur

RelationshipInfo(relationship_id: str | None = None, relationship_schema_name: str = '', relationship_type: str = '', lookup_schema_name: str | None = None, referenced_entity: str | None = None, referencing_entity: str | None = None, entity1_logical_name: str | None = None, entity2_logical_name: str | None = None)

Paramètres

Nom	Description
relationship_id	str GUID des métadonnées de relation. Valeur par défaut: None
relationship_schema_name Obligatoire	str Nom du schéma de relation.
relationship_type Obligatoire	str `"one_to_many"` ou `"many_to_many"`.
lookup_schema_name	str Nom du schéma de champ de recherche (un-à-plusieurs uniquement). Valeur par défaut: None
referenced_entity	str Nom logique de l’entité parente (un-à-plusieurs uniquement). Valeur par défaut: None
referencing_entity	str Nom logique de l’entité enfant (un-à-plusieurs uniquement). Valeur par défaut: None
entity1_logical_name	str Nom logique de la première entité (plusieurs-à-plusieurs uniquement). Valeur par défaut: None
entity2_logical_name	str Deuxième nom logique d’entité (plusieurs-à-plusieurs uniquement). Valeur par défaut: None

Méthodes

from_api_response

Créez à partir d’une réponse d’API Web Dataverse brute.

Détecte un-à-plusieurs vs plusieurs-à-plusieurs à partir du @odata.type champ dans la réponse et mappe les clés PascalCase à snake_case attributs. Dataverse prend uniquement en charge ces deux types de relation ; un déclenchement non reconnu @odata.type .ValueError

from_many_to_many

Créez à partir d’un résultat de relation plusieurs-à-plusieurs.

from_one_to_many

Créez à partir d’un résultat de relation un-à-plusieurs.

from_api_response

Créez à partir d’une réponse d’API Web Dataverse brute.

from_api_response(response_data: Dict[str, Any]) -> RelationshipInfo

Paramètres

Nom	Description
response_data Obligatoire	dict Métadonnées de relation brutes de l’API web.

Retours

Type	Description
RelationshipInfo

Exceptions

Type	Description
ValueError	Si le `@odata.type` type de relation n’est pas reconnu.

from_many_to_many

Créez à partir d’un résultat de relation plusieurs-à-plusieurs.

from_many_to_many(*, relationship_id: str | None, relationship_schema_name: str, entity1_logical_name: str, entity2_logical_name: str) -> RelationshipInfo

Paramètres

Nom	Description
relationship_id Obligatoire	str GUID des métadonnées de relation.
relationship_schema_name Obligatoire	str Nom du schéma de relation.
entity1_logical_name Obligatoire	str Prénom logique d’entité.
entity2_logical_name Obligatoire	str Deuxième nom logique d’entité.

Paramètres de mot clé uniquement

Nom	Description
relationship_id Obligatoire
relationship_schema_name Obligatoire
entity1_logical_name Obligatoire
entity2_logical_name Obligatoire

Retours

Type	Description
RelationshipInfo

from_one_to_many

Créez à partir d’un résultat de relation un-à-plusieurs.

from_one_to_many(*, relationship_id: str | None, relationship_schema_name: str, lookup_schema_name: str, referenced_entity: str, referencing_entity: str) -> RelationshipInfo

Paramètres

Nom	Description
relationship_id Obligatoire	str GUID des métadonnées de relation.
relationship_schema_name Obligatoire	str Nom du schéma de relation.
lookup_schema_name Obligatoire	str Nom du schéma de champ de recherche.
referenced_entity Obligatoire	str Nom logique de l’entité parente.
referencing_entity Obligatoire	str Nom logique de l’entité enfant.

Paramètres de mot clé uniquement

Nom	Description
relationship_id Obligatoire
relationship_schema_name Obligatoire
lookup_schema_name Obligatoire
referenced_entity Obligatoire
referencing_entity Obligatoire

Retours

Type	Description
RelationshipInfo

Attributs

entity1_logical_name

entity1_logical_name: str | None = None

entity2_logical_name

entity2_logical_name: str | None = None

lookup_schema_name

lookup_schema_name: str | None = None

referenced_entity

referenced_entity: str | None = None

referencing_entity

referencing_entity: str | None = None

relationship_id

relationship_id: str | None = None

relationship_schema_name

relationship_schema_name: str = ''

relationship_type

relationship_type: str = ''