graphersal 0.1.1

In-memory graph traversal engine modelled on Apache TinkerPop Gremlin, with a Rhai DSL, optimizer and GraphSON/GraphML I/O
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://graphersal.dev/schema/v1",
  "title": "GraphersalGraphSchema",
  "description": "A Graphersal graph schema: an envelope (mode, meta, labels, connections) around a strict subset of JSON Schema 2020-12 for each label's properties. Unknown keys are errors everywhere.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": { "const": "https://graphersal.dev/schema/v1" },
    "meta": {
      "description": "Free-form data the library stores, round-trips and never interprets.",
      "type": "object"
    },
    "mode": { "enum": ["none", "open", "closed"], "default": "none" },
    "vertices": {
      "type": "object",
      "propertyNames": { "minLength": 1 },
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "schema": { "$ref": "#/$defs/label_schema" }
        }
      }
    },
    "edges": {
      "type": "object",
      "propertyNames": { "minLength": 1 },
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "connections": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": ["from", "to"],
              "properties": {
                "from": { "type": "string", "minLength": 1 },
                "to": { "type": "string", "minLength": 1 }
              }
            }
          },
          "schema": { "$ref": "#/$defs/label_schema" }
        }
      }
    }
  },
  "$defs": {
    "label_schema": {
      "description": "The JSON Schema of a label's property map: an object node, optionally with $defs for local $ref.",
      "type": "object",
      "required": ["type"],
      "properties": {
        "type": { "const": "object" },
        "$schema": { "type": "string" },
        "$id": { "type": "string" },
        "$defs": { "type": "object", "additionalProperties": { "$ref": "#/$defs/node" } },
        "properties": { "type": "object", "additionalProperties": { "$ref": "#/$defs/node" } },
        "required": { "$ref": "#/$defs/key_list" },
        "additionalProperties": { "type": "boolean" },
        "title": { "type": "string" },
        "description": { "type": "string" },
        "$comment": { "type": "string" },
        "examples": { "type": "array" },
        "deprecated": { "type": "boolean" },
        "default": true,
        "$ref": { "$ref": "#/$defs/local_ref" }
      },
      "additionalProperties": false
    },
    "type_name": { "enum": ["null", "boolean", "integer", "number", "string", "array", "object"] },
    "key_list": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
    "local_ref": { "type": "string", "pattern": "^#/\\$defs/" },
    "count": { "type": "integer", "minimum": 0 },
    "node": {
      "description": "One property schema node. integer = int64, number = float64, string + format uuid = uuid.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "anyOf": [
            { "$ref": "#/$defs/type_name" },
            { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/type_name" } }
          ]
        },
        "format": { "const": "uuid" },
        "items": { "$ref": "#/$defs/node" },
        "properties": { "type": "object", "additionalProperties": { "$ref": "#/$defs/node" } },
        "required": { "$ref": "#/$defs/key_list" },
        "additionalProperties": { "type": "boolean" },
        "anyOf": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/node" } },
        "enum": { "type": "array", "minItems": 1 },
        "const": true,
        "minimum": { "type": "number" },
        "maximum": { "type": "number" },
        "exclusiveMinimum": { "type": "number" },
        "exclusiveMaximum": { "type": "number" },
        "minLength": { "$ref": "#/$defs/count" },
        "maxLength": { "$ref": "#/$defs/count" },
        "pattern": { "type": "string", "format": "regex" },
        "minItems": { "$ref": "#/$defs/count" },
        "maxItems": { "$ref": "#/$defs/count" },
        "title": { "type": "string" },
        "description": { "type": "string" },
        "$comment": { "type": "string" },
        "examples": { "type": "array" },
        "deprecated": { "type": "boolean" },
        "default": { "description": "An annotation only: never applied on write, never substituted on read." },
        "$ref": { "$ref": "#/$defs/local_ref" }
      }
    }
  }
}