Remote schema relationships¶

Step 0: Add a remote schema¶

Add a remote schema as described here.

Step 1: Open the remote relationship section¶

• From your table, go to the Relationships tab.
• Click the Add a remote relationship button.

Step 2: Define the relationship¶

The following fields can be defined for a remote schema relationship:

• Name: Define a name for the relationship.
• Remote Schema: Select a remote schema among all the ones you’ve created.
• Configuration: Set up the join configuration, to inject values as input arguments of the remote schema field.
  • From column: Input injected from table column values.
  • From static value: Input injected from a static value of your choice.

For this example, we assume that our schema has a users table with the fields name and auth0_id.

Console

CLI

API

You can add a remote schema relationship by adding it to the tables.yaml in the metadata directory:

 - table:
     schema: public
     name: users
   remote_relationships:
   - definition:
       remote_field:
         auth0profile:
           arguments:
             id: $auth0_id
       hasura_fields:
       - auth0_id
       remote_schema: auth0
     name: auth0

Apply the metadata by running:

hasura metadata apply

You can add a remote schema relationship by using the create_remote_relationship metadata API:

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
  "type": "create_remote_relationship",
  "args": {
    "name": "auth0_profile",
    "table": "users",
    "hasura_fields": [
      "auth0_id"
    ],
    "remote_schema": "auth0",
    "remote_field": {
      "auth0": {
        "arguments": {
          "auth0_id": "$auth0_id"
        }
      }
    }
  }
}

In this example, we’ve added a remote schema which is a wrapper around Auth0’s REST API (see example here).

1. We name the relationship auth0_profile.
2. We select the auth0 schema that we’ve added.
3. We set up the config to join the auth0_id input argument of our remote schema field to the auth0_id column of this table (in this case, the users table).

Step 3: Explore with GraphiQL¶

In the GraphiQL tab, test out your remote schema relationship.

query {
  users {
    name
    auth0_profile {
      nickname
      email
      last_login
    }
  }
}