Create a datagraph schema - Reelevant Documentation

POST

datagraph

schemas

Create a datagraph schema

curl --request POST \
  --url https://api.reelevant.com/v2/datasources/datagraph/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema": [
    {
      "name": "<string>",
      "datasourceId": "<string>",
      "columns": [
        {
          "name": "<string>",
          "type": "string",
          "nullable": true,
          "description": "<string>",
          "default": "<string>"
        }
      ],
      "description": "<string>",
      "indexes": [
        {
          "type": "Index",
          "columns": [
            "<string>"
          ],
          "description": "<string>"
        }
      ],
      "virtualColumns": [
        {
          "name": "<string>",
          "type": "string",
          "query": "<string>",
          "nullable": true,
          "description": "<string>"
        }
      ],
      "uniqueKeys": [
        {
          "type": "UniqueKey",
          "columns": [
            "<string>"
          ],
          "description": "<string>"
        }
      ],
      "relations": [
        {
          "type": "Relation",
          "columns": [
            "<string>"
          ],
          "reference": {
            "datasourceId": "<string>",
            "columns": [
              "<string>"
            ],
            "table": "<string>"
          },
          "description": "<string>"
        }
      ]
    }
  ]
}
'

{
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": {
    "companyId": "<string>",
    "resourceGroupIds": [
      "<string>"
    ],
    "versions": [
      "<string>"
    ],
    "archivedAt": "2023-11-07T05:31:56Z"
  },
  "code": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

schema

object[]

required

Show child attributes

Response

status

enum<string>

required

Available options:

success

program

string

required

version

string

required

datetime

string

required

message

string

required

data

object

required

Show child attributes

code

number

Validate a datagraph schema and analyse the relevance of its joinsValidate a datagraph schema and analyse the relevance of its joins Performs two steps: 1. Structural validation of the schema (duplicate tables, unknown relation targets, column constraints, …). 2. For each relation declared in the schema, queries Pinot to measure how well the join keys overlap between the two datasources (distinct-value intersection score). The relation analysis is only executed when the schema is structurally valid.

⌘I

Create a datagraph schema

curl --request POST \
  --url https://api.reelevant.com/v2/datasources/datagraph/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema": [
    {
      "name": "<string>",
      "datasourceId": "<string>",
      "columns": [
        {
          "name": "<string>",
          "type": "string",
          "nullable": true,
          "description": "<string>",
          "default": "<string>"
        }
      ],
      "description": "<string>",
      "indexes": [
        {
          "type": "Index",
          "columns": [
            "<string>"
          ],
          "description": "<string>"
        }
      ],
      "virtualColumns": [
        {
          "name": "<string>",
          "type": "string",
          "query": "<string>",
          "nullable": true,
          "description": "<string>"
        }
      ],
      "uniqueKeys": [
        {
          "type": "UniqueKey",
          "columns": [
            "<string>"
          ],
          "description": "<string>"
        }
      ],
      "relations": [
        {
          "type": "Relation",
          "columns": [
            "<string>"
          ],
          "reference": {
            "datasourceId": "<string>",
            "columns": [
              "<string>"
            ],
            "table": "<string>"
          },
          "description": "<string>"
        }
      ]
    }
  ]
}
'

{
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": {
    "companyId": "<string>",
    "resourceGroupIds": [
      "<string>"
    ],
    "versions": [
      "<string>"
    ],
    "archivedAt": "2023-11-07T05:31:56Z"
  },
  "code": 123
}