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 JSONBExists(Expression, Func):
 66    arg_types = {"this": True, "path": True}
 67    _sql_names = ["JSONB_EXISTS"]
 68
 69
 70class JSONBExtract(Expression, Binary, Func):
 71    _sql_names = ["JSONB_EXTRACT"]
 72
 73
 74class JSONBExtractScalar(Expression, Binary, Func):
 75    arg_types = {"this": True, "expression": True, "json_type": False}
 76    _sql_names = ["JSONB_EXTRACT_SCALAR"]
 77
 78
 79class JSONBObjectAgg(Expression, AggFunc):
 80    arg_types = {"this": True, "expression": True}
 81
 82
 83class JSONBool(Expression, Func):
 84    pass
 85
 86
 87class JSONExists(Expression, Func):
 88    arg_types = {
 89        "this": True,
 90        "path": True,
 91        "passing": False,
 92        "on_condition": False,
 93        "from_dcolonqmark": False,
 94    }
 95
 96
 97class JSONExtract(Expression, Binary, Func):
 98    arg_types = {
 99        "this": True,
100        "expression": True,
101        "only_json_types": False,
102        "expressions": False,
103        "variant_extract": False,
104        "json_query": False,
105        "option": False,
106        "quote": False,
107        "on_condition": False,
108        "requires_json": False,
109        "emits": False,
110    }
111    _sql_names = ["JSON_EXTRACT"]
112    is_var_len_args = True
113
114    @property
115    def output_name(self) -> str:
116        return self.expression.output_name if not self.expressions else ""
117
118
119class JSONExtractArray(Expression, Func):
120    arg_types = {"this": True, "expression": False}
121    _sql_names = ["JSON_EXTRACT_ARRAY"]
122
123
124class JSONExtractScalar(Expression, Binary, Func):
125    arg_types = {
126        "this": True,
127        "expression": True,
128        "only_json_types": False,
129        "expressions": False,
130        "json_type": False,
131        "scalar_only": False,
132    }
133    _sql_names = ["JSON_EXTRACT_SCALAR"]
134    is_var_len_args = True
135
136    @property
137    def output_name(self) -> str:
138        return self.expression.output_name
139
140
141class JSONFormat(Expression, Func):
142    arg_types = {"this": False, "options": False, "is_json": False, "to_json": False}
143    _sql_names = ["JSON_FORMAT"]
144
145
146class JSONKeys(Expression, Func):
147    arg_types = {"this": True, "expression": False, "expressions": False}
148    is_var_len_args = True
149    _sql_names = ["JSON_KEYS"]
150
151
152class JSONKeysAtDepth(Expression, Func):
153    arg_types = {"this": True, "expression": False, "mode": False}
154
155
156class JSONObject(Expression, Func):
157    arg_types = {
158        "expressions": False,
159        "null_handling": False,
160        "unique_keys": False,
161        "return_type": False,
162        "encoding": False,
163    }
164
165
166class JSONObjectAgg(Expression, AggFunc):
167    arg_types = {
168        "expressions": False,
169        "null_handling": False,
170        "unique_keys": False,
171        "return_type": False,
172        "encoding": False,
173    }
174
175
176class JSONRemove(Expression, Func):
177    arg_types = {"this": True, "expressions": True}
178    is_var_len_args = True
179    _sql_names = ["JSON_REMOVE"]
180
181
182class JSONSet(Expression, Func):
183    arg_types = {"this": True, "expressions": True}
184    is_var_len_args = True
185    _sql_names = ["JSON_SET"]
186
187
188class JSONStripNulls(Expression, Func):
189    arg_types = {
190        "this": True,
191        "expression": False,
192        "include_arrays": False,
193        "remove_empty": False,
194    }
195    _sql_names = ["JSON_STRIP_NULLS"]
196
197
198class StripNullValue(Expression, Func):
199    pass
200
201
202class JSONTable(Expression, Func):
203    arg_types = {
204        "this": True,
205        "schema": True,
206        "path": False,
207        "error_handling": False,
208        "empty_handling": False,
209    }
210
211
212class JSONType(Expression, Func):
213    arg_types = {"this": True, "expression": False}
214    _sql_names = ["JSON_TYPE"]
215
216
217class ObjectId(Expression, Func):
218    arg_types = {"this": True, "expression": False}
219
220
221class ObjectInsert(Expression, Func):
222    arg_types = {
223        "this": True,
224        "key": True,
225        "value": True,
226        "update_flag": False,
227    }
228
229
230class OpenJSON(Expression, Func):
231    arg_types = {"this": True, "path": False, "expressions": False}
232
233
234class ParseJSON(Expression, Func):
235    # BigQuery, Snowflake have PARSE_JSON, Presto has JSON_PARSE
236    # Snowflake also has TRY_PARSE_JSON, which is represented using `safe`
237    _sql_names = ["PARSE_JSON", "JSON_PARSE"]
238    arg_types = {"this": True, "expression": False, "safe": False}