Op

Shared request and response schema. Request: One step of the ops list accepted in an ontology request. Set exactly one of where, traverse, union, intersect, subtract, or derive; direction, depth, to, and alias apply only with traverse. Response: One step of the ops list returned in a stored ontology request. Exactly one of where, traverse, union, intersect, subtract, or derive is set; direction, depth, to, and alias apply only with traverse.

where object

anyOf

• object
• null

object

traverse object

anyOf

• string
• string[]
• null

string

direction object

anyOf

• string
• null

string

Possible values: [out, in]

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

to object

anyOf

• string
• null

string

Constant value: link

alias object

anyOf

• string
• null

string

Possible values: non-empty

union object

anyOf

• Definition
• null

from objectrequired

Where a definition starts: one type (entity or relation) and, optionally, the rows to start from. anchors are {column: value} maps that name every key column of the type (compile checks); extra columns are only meaningful under upsert, where the anchor row is the row written.

entity object

EntityType id

anyOf

• string
• null

string

relation object

RelationType id

anyOf

• string
• null

string

anchors object

Start rows as {key column: value} maps

anyOf

• object[]
• null

Array [

property name*any

]

opsundefined[]

caps object

anyOf

• Caps
• null

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

frontier_per_level object

anyOf

• integer
• null

integer

Possible values: >= 1

max_nodes object

anyOf

• integer
• null

integer

Possible values: >= 1

max_edges object

anyOf

• integer
• null

integer

Possible values: >= 1

intermediate object

anyOf

• integer
• null

integer

Possible values: >= 1

matching object

anyOf

• integer
• null

integer

Possible values: >= 1

pin object

anyOf

• Pin
• null

txn objectrequired

anyOf

• integer
• object

integer

versions object

anyOf

• object
• null

object

intersect object

anyOf

• Definition
• null

from objectrequired

Where a definition starts: one type (entity or relation) and, optionally, the rows to start from. anchors are {column: value} maps that name every key column of the type (compile checks); extra columns are only meaningful under upsert, where the anchor row is the row written.

entity object

EntityType id

anyOf

• string
• null

string

relation object

RelationType id

anyOf

• string
• null

string

anchors object

Start rows as {key column: value} maps

anyOf

• object[]
• null

Array [

property name*any

]

opsundefined[]

caps object

anyOf

• Caps
• null

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

frontier_per_level object

anyOf

• integer
• null

integer

Possible values: >= 1

max_nodes object

anyOf

• integer
• null

integer

Possible values: >= 1

max_edges object

anyOf

• integer
• null

integer

Possible values: >= 1

intermediate object

anyOf

• integer
• null

integer

Possible values: >= 1

matching object

anyOf

• integer
• null

integer

Possible values: >= 1

pin object

anyOf

• Pin
• null

txn objectrequired

anyOf

• integer
• object

integer

versions object

anyOf

• object
• null

object

subtract object

anyOf

• Definition
• null

from objectrequired

Where a definition starts: one type (entity or relation) and, optionally, the rows to start from. anchors are {column: value} maps that name every key column of the type (compile checks); extra columns are only meaningful under upsert, where the anchor row is the row written.

entity object

EntityType id

anyOf

• string
• null

string

relation object

RelationType id

anyOf

• string
• null

string

anchors object

Start rows as {key column: value} maps

anyOf

• object[]
• null

Array [

property name*any

]

opsundefined[]

caps object

anyOf

• Caps
• null

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

frontier_per_level object

anyOf

• integer
• null

integer

Possible values: >= 1

max_nodes object

anyOf

• integer
• null

integer

Possible values: >= 1

max_edges object

anyOf

• integer
• null

integer

Possible values: >= 1

intermediate object

anyOf

• integer
• null

integer

Possible values: >= 1

matching object

anyOf

• integer
• null

integer

Possible values: >= 1

pin object

anyOf

• Pin
• null

txn objectrequired

anyOf

• integer
• object

integer

versions object

anyOf

• object
• null

object

derive object

anyOf

• object
• null

object

Op

{
  "where": {},
  "traverse": "string",
  "direction": "out",
  "depth": 0,
  "to": "link",
  "alias": "string",
  "union": {
    "from": {
      "entity": "string",
      "relation": "string",
      "anchors": [
        {}
      ]
    },
    "ops": [
      null
    ],
    "caps": {
      "depth": 0,
      "frontier_per_level": 0,
      "max_nodes": 0,
      "max_edges": 0,
      "intermediate": 0,
      "matching": 0
    },
    "pin": {
      "txn": 0,
      "versions": {}
    }
  },
  "intersect": {
    "from": {
      "entity": "string",
      "relation": "string",
      "anchors": [
        {}
      ]
    },
    "ops": [
      null
    ],
    "caps": {
      "depth": 0,
      "frontier_per_level": 0,
      "max_nodes": 0,
      "max_edges": 0,
      "intermediate": 0,
      "matching": 0
    },
    "pin": {
      "txn": 0,
      "versions": {}
    }
  },
  "subtract": {
    "from": {
      "entity": "string",
      "relation": "string",
      "anchors": [
        {}
      ]
    },
    "ops": [
      null
    ],
    "caps": {
      "depth": 0,
      "frontier_per_level": 0,
      "max_nodes": 0,
      "max_edges": 0,
      "intermediate": 0,
      "matching": 0
    },
    "pin": {
      "txn": 0,
      "versions": {}
    }
  },
  "derive": {}
}