RelationshipInfo Classe

Modelo de retorno digitado para metadados de relação.

Retornado por create_one_to_many_relationship, create_many_to_many_relationship, get_relationshipe create_lookup_field.

Exemplo:


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

Construtor

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)

Parâmetros

Nome Description
relationship_id
str

GUID de metadados de relação.

Valor padrão: None
relationship_schema_name
Obrigatório
str

Nome do esquema de relação.

relationship_type
Obrigatório
str

"one_to_many" ou "many_to_many".

lookup_schema_name
str

Nome do esquema do campo de pesquisa (somente um para muitos).

Valor padrão: None
referenced_entity
str

Nome lógico da entidade pai (somente um para muitos).

Valor padrão: None
referencing_entity
str

Nome lógico da entidade filho (somente um para muitos).

Valor padrão: None
entity1_logical_name
str

Nome lógico da primeira entidade (somente muitos para muitos).

Valor padrão: None
entity2_logical_name
str

Nome lógico da segunda entidade (somente muitos para muitos).

Valor padrão: None

Métodos

from_api_response

Crie a partir de uma resposta bruta da API Web do Dataverse.

Detecta um para muitos versus muitos para muitos do @odata.type campo na resposta e mapeia as chaves PascalCase para snake_case atributos. O Dataverse só dá suporte a esses dois tipos de relação; um aumento ValueErrornão reconhecido @odata.type .

from_many_to_many

Crie de um resultado de relação muitos para muitos.

from_one_to_many

Crie com base em um resultado de relação um para muitos.

from_api_response

Crie a partir de uma resposta bruta da API Web do Dataverse.

Detecta um para muitos versus muitos para muitos do @odata.type campo na resposta e mapeia as chaves PascalCase para snake_case atributos. O Dataverse só dá suporte a esses dois tipos de relação; um aumento ValueErrornão reconhecido @odata.type .

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

Parâmetros

Nome Description
response_data
Obrigatório

Metadados de relação brutos da API Web.

Retornos

Tipo Description

Exceções

Tipo Description

Se o @odata.type tipo de relação não for reconhecido.

from_many_to_many

Crie de um resultado de relação muitos para muitos.

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

Parâmetros

Nome Description
relationship_id
Obrigatório
str

GUID de metadados de relação.

relationship_schema_name
Obrigatório
str

Nome do esquema de relação.

entity1_logical_name
Obrigatório
str

Nome lógico da primeira entidade.

entity2_logical_name
Obrigatório
str

Nome lógico da segunda entidade.

Parâmetros somente de palavra-chave

Nome Description
relationship_id
Obrigatório
relationship_schema_name
Obrigatório
entity1_logical_name
Obrigatório
entity2_logical_name
Obrigatório

Retornos

Tipo Description

from_one_to_many

Crie com base em um resultado de relação um para muitos.

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

Parâmetros

Nome Description
relationship_id
Obrigatório
str

GUID de metadados de relação.

relationship_schema_name
Obrigatório
str

Nome do esquema de relação.

lookup_schema_name
Obrigatório
str

Nome do esquema do campo de pesquisa.

referenced_entity
Obrigatório
str

Nome lógico da entidade pai.

referencing_entity
Obrigatório
str

Nome lógico da entidade filho.

Parâmetros somente de palavra-chave

Nome Description
relationship_id
Obrigatório
relationship_schema_name
Obrigatório
lookup_schema_name
Obrigatório
referenced_entity
Obrigatório
referencing_entity
Obrigatório

Retornos

Tipo Description

Atributos

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 = ''