sqlx-query-dsl 0.1.0

A query DSL extension for SQLx
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.com/query.schema.json",
  "title": "QueryParams",
  "type": "object",
  "required": ["page", "page_size"],
  "properties": {
    "filter": {
      "$ref": "#/$defs/filterExpr"
    },
    "group_by": {
      "type": "array",
      "items": { "type": "string" }
    },
    "having": {
      "$ref": "#/$defs/filterExpr"
    },
    "sort": {
      "type": "array",
      "items": { "$ref": "#/$defs/sortItem" }
    },
    "page": {
      "type": "integer",
      "minimum": 0
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "$defs": {
    "filterExpr": {
      "oneOf": [
        {
          "type": "object",
          "required": ["and"],
          "properties": {
            "and": {
              "type": "array",
              "minItems": 1,
              "items": { "$ref": "#/$defs/filterExpr" }
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": ["or"],
          "properties": {
            "or": {
              "type": "array",
              "minItems": 1,
              "items": { "$ref": "#/$defs/filterExpr" }
            }
          },
          "additionalProperties": false
        },
        {
          "$ref": "#/$defs/filterCond"
        }
      ]
    },

    "filterCond": {
      "type": "object",
      "required": ["op"],
      "properties": {
        "field": {
          "type": "string",
          "description": "SQL column with alias, e.g. u.name"
        },
        "op": {
          "type": "string",
          "enum": [
            "eq",
            "ne",
            "like",
            "gt",
            "lt",
            "gte",
            "lte",
            "in",
            "not_in",
            "between",
            "find_in_set",
            "json_contains",
            "is_null",
            "is_not_null",
            "exists",
            "not_exists"
          ]
        },
        "value": {}
      },
      "allOf": [
        {
          "if": {
            "properties": { "op": { "enum": ["is_null", "is_not_null"] } }
          },
          "then": {
            "not": { "required": ["value"] }
          }
        },
        {
          "if": {
            "properties": { "op": { "enum": ["in", "not_in", "between"] } }
          },
          "then": {
            "required": ["value"],
            "properties": {
              "value": {
                "type": "array",
                "minItems": 1
              }
            }
          }
        },
        {
          "if": {
            "properties": { "op": { "enum": ["exists", "not_exists"] } }
          },
          "then": {
            "required": ["value"],
            "properties": {
              "value": {
                "type": "object",
                "required": ["sql"],
                "properties": {
                  "sql": {
                    "type": "string",
                    "description": "EXISTS subquery SQL, controlled by backend"
                  },
                  "bind": {
                    "type": "array",
                    "items": {}
                  }
                },
                "additionalProperties": false
              }
            }
          }
        }
      ],
      "additionalProperties": false
    },

    "sortItem": {
      "type": "object",
      "required": ["field"],
      "properties": {
        "field": {
          "type": "string"
        },
        "desc": {
          "type": "boolean",
          "default": false
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}