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