framework/packages/spec/json-schema/DriverInterface.json at 4c80263113f0e1de96bb5e982c523599ed8b5e3f · objectstack-ai/framework · GitHub

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
{
  "$ref": "#/definitions/DriverInterface",
  "definitions": {
    "DriverInterface": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Driver unique name"
        },
        "version": {
          "type": "string",
          "description": "Driver version"
        },
        "supports": {
          "type": "object",
          "properties": {
            "transactions": {
              "type": "boolean",
              "description": "Supports transactions"
            },
            "queryFilters": {
              "type": "boolean",
              "description": "Supports WHERE clause filtering"
            },
            "queryAggregations": {
              "type": "boolean",
              "description": "Supports GROUP BY and aggregation functions"
            },
            "querySorting": {
              "type": "boolean",
              "description": "Supports ORDER BY sorting"
            },
            "queryPagination": {
              "type": "boolean",
              "description": "Supports LIMIT/OFFSET pagination"
            },
            "queryWindowFunctions": {
              "type": "boolean",
              "description": "Supports window functions with OVER clause"
            },
            "querySubqueries": {
              "type": "boolean",
              "description": "Supports subqueries"
            },
            "joins": {
              "type": "boolean",
              "description": "Supports SQL joins"
            },
            "fullTextSearch": {
              "type": "boolean",
              "description": "Supports full-text search"
            },
            "jsonFields": {
              "type": "boolean",
              "description": "Supports JSON field types"
            },
            "arrayFields": {
              "type": "boolean",
              "description": "Supports array field types"
            }
          },
          "required": [
            "transactions",
            "queryFilters",
            "queryAggregations",
            "querySorting",
            "queryPagination",
            "queryWindowFunctions",
            "querySubqueries",
            "joins",
            "fullTextSearch",
            "jsonFields",
            "arrayFields"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "name",
        "version",
        "supports"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}