> 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/connectors/structured-data/relationship.md).

# Relationship

**Relationship** component creates relations between 1 or more entities so that searches in different bases can be made.

{% hint style="info" %}
The component doesn't support concurrent accesses while trying to update or save new relations.
{% endhint %}

## Parameters

Take a look at the configuration parameters of the component. Parameters supported by [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked with `(DB)`.

<table data-full-width="true"><thead><tr><th>Parameter</th><th width="339">Description</th><th width="144.75">Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Operation</strong></td><td>Operation to be executed (Match, Create, Update, Get By Field And Value, Translate, and Delete Exact).</td><td>Translate</td><td>String</td></tr><tr><td><strong>Relation Name</strong></td><td>Name given to the created relation.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Translate Path</strong></td><td>Path through which the component searches the IDs to be translated.</td><td>relation.obj.id</td><td>String</td></tr><tr><td><strong>From</strong></td><td>Origin of the search.</td><td>teste</td><td>String</td></tr><tr><td><strong>To</strong></td><td>Destination of the search.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.</td><td>True</td><td>Boolean</td></tr></tbody></table>

## Operations <a href="#operations" id="operations"></a>

* **Match:** searches a match between 2 fields and the declared value.
* **Create:** creates a relation by the field.
* **Update:** update an existing relation by the field.
* **Get by field and value:** searches a relation between the field and its value.
* **Translate:** translates an IDs list based on the path specified in "Translate Path".
* **Delete Exact:** delete an exact relation in all the declared fields.

{% hint style="info" %}
**Important:** it's necessary to declare the query inside the relation object:
{% 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.