> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Relationship file parameters

> Detailed reference for source view, target view, join condition, and relationship type parameters in Omni relationship files.

## Source view parameters

<table style={{ width: '100%', display: 'table' }}>
  <thead>
    <tr>
      <th style={{ width: '30%'}}>Name</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><a href="/modeling/relationships/parameters/join-from-view"><code>join\_from\_view</code></a></td>
      <td>Defines the source view from which the join originates.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/join-from-view-as"><code>join\_from\_view\_as</code></a></td>
      <td>Aliases the source view with a new name.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/join-from-view-as-label"><code>join\_from\_view\_as\_label</code></a></td>
      <td>Controls the display name of the source view in Omni when using the join.</td>
    </tr>
  </tbody>
</table>

## Target view parameters

<table style={{ width: '100%', display: 'table' }}>
  <thead>
    <tr>
      <th style={{ width: '30%'}}>Name</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><a href="/modeling/relationships/parameters/join-to-view"><code>join\_to\_view</code></a></td>
      <td>Specifies the view to join to the source view.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/join-to-view-as"><code>join\_to\_view\_as</code></a></td>
      <td>Aliases the joined view with a new name.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/join-to-view-as-label"><code>join\_to\_view\_as\_label</code></a></td>
      <td>Controls the display name of the joined view in Omni when using the join.</td>
    </tr>
  </tbody>
</table>

## Join configuration

<table style={{ width: '100%', display: 'table' }}>
  <thead>
    <tr>
      <th style={{ width: '30%'}}>Name</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><a href="/modeling/relationships/parameters/join-type"><code>join\_type</code></a></td>
      <td>Specifies the type of SQL join to perform.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/on-sql"><code>on\_sql</code></a></td>
      <td>Specifies the SQL condition that determines how to perform the join.</td>
    </tr>
  </tbody>
</table>

## Relationship properties

<table style={{ width: '100%', display: 'table' }}>
  <thead>
    <tr>
      <th style={{ width: '30%'}}>Name</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><a href="/modeling/relationships/parameters/relationship-type"><code>relationship\_type</code></a></td>
      <td>Defines the cardinality relationship between joined tables.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/reversible"><code>reversible</code></a></td>
      <td>Controls whether the join can function bi-directionally for topics.</td>
    </tr>

    <tr>
      <td><a href="/modeling/relationships/parameters/where-sql"><code>where\_sql</code></a></td>
      <td>Adds a `WHERE` clause to the generated SQL when a join is established.</td>
    </tr>
  </tbody>
</table>

## Special cases

<table style={{ width: '100%', display: 'table' }}>
  <thead>
    <tr>
      <th style={{ width: '30%'}}>Name</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><a href="/modeling/relationships/parameters/id"><code>id</code></a></td>
      <td>**Do not use**. Omni-generated identifier for duplicate joins.</td>
    </tr>
  </tbody>
</table>