> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/structured-data/relationship.md).

# Relationship

Descubra mais sobre o componente Relationship e saiba como utilizá-lo na Digibee Integration Platform.

O componente **Relationship** cria relações entre 1 ou mais entidades para que sejam feitas buscas em bases diferentes.

{% hint style="info" %}
**Importante:** o componente não suporta acessos simultâneos enquanto está tentando atualizar ou salvar novas relações.
{% endhint %}

## Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por [expressões *Double Braces*](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados com `(DB)`.

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Operation</strong></td><td>Operação a ser executada (<em>Match</em>, <em>Create</em>, <em>Update</em>, <em>Get By Field And Value</em>, <em>Translate</em> e <em>Delete Exact</em>)</td><td><em>Translate</em></td><td><em>String</em></td></tr><tr><td><strong>Relation Name</strong></td><td>Nome dado à relação criada.</td><td>N/A</td><td><em>String</em></td></tr><tr><td><strong>Translate Path</strong></td><td>Caminho pelo qual o componente busca os IDs a serem traduzidos.</td><td>relation.obj.id</td><td><em>String</em></td></tr><tr><td><strong>From</strong></td><td>Origem da busca.</td><td>teste</td><td><em>String</em></td></tr><tr><td><strong>To</strong></td><td>Destino da busca.</td><td>N/A</td><td><em>String</em></td></tr><tr><td><strong>Fail On Error</strong></td><td>Se a opção estiver habilitada, a execução do <em>pipeline</em> com erro será interrompida; do contrário, a execução do <em>pipeline</em> continua, mas o resultado mostrará um valor falso para a propriedade "<em>success</em>".</td><td><em>True</em></td><td>Booleano</td></tr></tbody></table>

## Operações <a href="#operaes" id="operaes"></a>

* **Match:** busca por uma equivalência entre 2 campos e o valor declarado.
* **Create:** cria uma relação através do campo.
* **Update:** atualiza uma relação existente através do campo.
* **Get by field and value:** busca por uma relação entre o campo e o seu valor.
* **Translate:** traduz uma lista de IDs com base no caminho especificado em **Translate Path**.
* **Delete Exact:** exclui a relação exata em todos os campos declarados.

{% hint style="info" %}
**Importante:** é preciso declarar a *query* dentro do objeto de relação:
{% endhint %}

```
{
    relation : {
            field1: value
            field2: value
    }
 }
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/structured-data/relationship.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.