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