1"""sqlglot expressions - JSON functions."""
  2
  3from __future__ import annotations
  4
  5from sqlglot.expressions.core import Expression, Func, AggFunc, Binary, Predicate
  6
  7
  8class CheckJson(Expression, Func):
  9    arg_types = {"this": True}
 10
 11
 12class JSONArray(Expression, Func):
 13    arg_types = {
 14        "expressions": False,
 15        "null_handling": False,
 16        "return_type": False,
 17        "strict": False,
 18    }
 19    is_var_len_args = True
 20
 21
 22class JSONArrayAgg(Expression, AggFunc):
 23    arg_types = {
 24        "this": True,
 25        "order": False,
 26        "null_handling": False,
 27        "return_type": False,
 28        "strict": False,
 29    }
 30
 31
 32class JSONArrayAppend(Expression, Func):
 33    arg_types = {"this": True, "expressions": True}
 34    is_var_len_args = True
 35    _sql_names = ["JSON_ARRAY_APPEND"]
 36
 37
 38class JSONArrayContains(Expression, Binary, Predicate, Func):
 39    arg_types = {"this": True, "expression": True, "json_type": False}
 40    _sql_names = ["JSON_ARRAY_CONTAINS"]
 41
 42
 43class JSONArrayInsert(Expression, Func):
 44    arg_types = {"this": True, "expressions": True}
 45    is_var_len_args = True
 46    _sql_names = ["JSON_ARRAY_INSERT"]
 47
 48
 49class JSONBContains(Expression, Binary, Func):
 50    _sql_names = ["JSONB_CONTAINS"]
 51
 52
 53class JSONBContainsAllTopKeys(Expression, Binary, Func):
 54    pass
 55
 56
 57class JSONBContainsAnyTopKeys(Expression, Binary, Func):
 58    pass
 59
 60
 61class JSONBDeleteAtPath(Expression, Binary, Func):
 62    pass
 63
 64
 65class JSONBPathExists(Expression, Binary, Predicate, Func):
 66    pass
 67
 68
 69class JSONBExists(Expression, Func):
 70    arg_types = {"this": True, "path": True}
 71    _sql_names = ["JSONB_EXISTS"]
 72
 73
 74class JSONBExtract(Expression, Binary, Func):
 75    _sql_names = ["JSONB_EXTRACT"]
 76
 77
 78class JSONBExtractScalar(Expression, Binary, Func):
 79    arg_types = {"this": True, "expression": True, "json_type": False}
 80    _sql_names = ["JSONB_EXTRACT_SCALAR"]
 81
 82
 83class JSONBObjectAgg(Expression, AggFunc):
 84    arg_types = {"this": True, "expression": True}
 85
 86
 87class JSONBool(Expression, Func):
 88    pass
 89
 90
 91class JSONExists(Expression, Func):
 92    arg_types = {
 93        "this": True,
 94        "path": True,
 95        "passing": False,
 96        "on_condition": False,
 97        "from_dcolonqmark": False,
 98    }
 99
100
101class JSONExtract(Expression, Binary, Func):
102    arg_types = {
103        "this": True,
104        "expression": True,
105        "only_json_types": False,
106        "expressions": False,
107        "variant_extract": False,
108        "json_query": False,
109        "option": False,
110        "quote": False,
111        "on_condition": False,
112        "requires_json": False,
113        "emits": False,
114    }
115    _sql_names = ["JSON_EXTRACT"]
116    is_var_len_args = True
117
118    @property
119    def output_name(self) -> str:
120        return self.expression.output_name if not self.expressions else ""
121
122
123class JSONExtractArray(Expression, Func):
124    arg_types = {"this": True, "expression": False}
125    _sql_names = ["JSON_EXTRACT_ARRAY"]
126
127
128class JSONExtractScalar(Expression, Binary, Func):
129    arg_types = {
130        "this": True,
131        "expression": True,
132        "only_json_types": False,
133        "expressions": False,
134        "json_type": False,
135        "scalar_only": False,
136    }
137    _sql_names = ["JSON_EXTRACT_SCALAR"]
138    is_var_len_args = True
139
140    @property
141    def output_name(self) -> str:
142        return self.expression.output_name
143
144
145class JSONFormat(Expression, Func):
146    arg_types = {"this": False, "options": False, "is_json": False, "to_json": False}
147    _sql_names = ["JSON_FORMAT"]
148
149
150class JSONKeys(Expression, Func):
151    arg_types = {"this": True, "expression": False, "expressions": False}
152    is_var_len_args = True
153    _sql_names = ["JSON_KEYS"]
154
155
156class JSONKeysAtDepth(Expression, Func):
157    arg_types = {"this": True, "expression": False, "mode": False}
158
159
160class JSONObject(Expression, Func):
161    arg_types = {
162        "expressions": False,
163        "null_handling": False,
164        "unique_keys": False,
165        "return_type": False,
166        "encoding": False,
167    }
168
169
170class JSONObjectAgg(Expression, AggFunc):
171    arg_types = {
172        "expressions": False,
173        "null_handling": False,
174        "unique_keys": False,
175        "return_type": False,
176        "encoding": False,
177    }
178
179
180class JSONRemove(Expression, Func):
181    arg_types = {"this": True, "expressions": True}
182    is_var_len_args = True
183    _sql_names = ["JSON_REMOVE"]
184
185
186class JSONSet(Expression, Func):
187    arg_types = {"this": True, "expressions": True}
188    is_var_len_args = True
189    _sql_names = ["JSON_SET"]
190
191
192class JSONStripNulls(Expression, Func):
193    arg_types = {
194        "this": True,
195        "expression": False,
196        "include_arrays": False,
197        "remove_empty": False,
198    }
199    _sql_names = ["JSON_STRIP_NULLS"]
200
201
202class StripNullValue(Expression, Func):
203    pass
204
205
206class JSONTable(Expression, Func):
207    arg_types = {
208        "this": True,
209        "schema": True,
210        "path": False,
211        "error_handling": False,
212        "empty_handling": False,
213    }
214
215
216class JSONType(Expression, Func):
217    arg_types = {"this": True, "expression": False}
218    _sql_names = ["JSON_TYPE"]
219
220
221class ObjectId(Expression, Func):
222    arg_types = {"this": True, "expression": False}
223
224
225class ObjectInsert(Expression, Func):
226    arg_types = {
227        "this": True,
228        "key": True,
229        "value": True,
230        "update_flag": False,
231    }
232
233
234class OpenJSON(Expression, Func):
235    arg_types = {"this": True, "path": False, "expressions": False}
236
237
238class ParseJSON(Expression, Func):
239    # BigQuery, Snowflake have PARSE_JSON, Presto has JSON_PARSE
240    # Snowflake also has TRY_PARSE_JSON, which is represented using `safe`
241    _sql_names = ["PARSE_JSON", "JSON_PARSE"]
242    arg_types = {"this": True, "expression": False, "safe": False}