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