1"""sqlglot expressions - string, encoding, hashing, and regex functions."""
  2
  3from __future__ import annotations
  4
  5from sqlglot.expressions.core import Expression, Func, Binary
  6
  7
  8# String basics
  9
 10
 11class Ascii(Expression, Func):
 12    pass
 13
 14
 15class BitLength(Expression, Func):
 16    pass
 17
 18
 19class ByteLength(Expression, Func):
 20    pass
 21
 22
 23class Chr(Expression, Func):
 24    arg_types = {"expressions": True, "charset": False}
 25    is_var_len_args = True
 26    _sql_names = ["CHR", "CHAR"]
 27
 28
 29class Concat(Expression, Func):
 30    arg_types = {"expressions": True, "safe": False, "coalesce": False}
 31    is_var_len_args = True
 32
 33
 34class ConcatWs(Concat):
 35    _sql_names = ["CONCAT_WS"]
 36
 37
 38class Contains(Expression, Func):
 39    arg_types = {"this": True, "expression": True, "json_scope": False}
 40
 41
 42class Elt(Expression, Func):
 43    arg_types = {"this": True, "expressions": True}
 44    is_var_len_args = True
 45
 46
 47class EndsWith(Expression, Func):
 48    _sql_names = ["ENDS_WITH", "ENDSWITH"]
 49    arg_types = {"this": True, "expression": True}
 50
 51
 52class Format(Expression, Func):
 53    arg_types = {"this": True, "expressions": False}
 54    is_var_len_args = True
 55
 56
 57class Initcap(Expression, Func):
 58    arg_types = {"this": True, "expression": False}
 59
 60
 61class IsAscii(Expression, Func):
 62    pass
 63
 64
 65class Left(Expression, Func):
 66    arg_types = {"this": True, "expression": True, "negative_length_returns_empty": False}
 67
 68
 69class Length(Expression, Func):
 70    arg_types = {"this": True, "binary": False, "encoding": False}
 71    _sql_names = ["LENGTH", "LEN", "CHAR_LENGTH", "CHARACTER_LENGTH"]
 72
 73
 74class Levenshtein(Expression, Func):
 75    arg_types = {
 76        "this": True,
 77        "expression": False,
 78        "ins_cost": False,
 79        "del_cost": False,
 80        "sub_cost": False,
 81        "max_dist": False,
 82    }
 83
 84
 85class Lower(Expression, Func):
 86    _sql_names = ["LOWER", "LCASE"]
 87
 88
 89class MatchAgainst(Expression, Func):
 90    arg_types = {"this": True, "expressions": True, "modifier": False}
 91
 92
 93class Normalize(Expression, Func):
 94    arg_types = {"this": True, "form": False, "is_casefold": False}
 95
 96
 97class NumberToStr(Expression, Func):
 98    arg_types = {"this": True, "format": True, "culture": False}
 99
100
101class Overlay(Expression, Func):
102    arg_types = {"this": True, "expression": True, "from_": True, "for_": False}
103
104
105class Pad(Expression, Func):
106    arg_types = {"this": True, "expression": True, "fill_pattern": False, "is_left": True}
107
108
109class Repeat(Expression, Func):
110    arg_types = {"this": True, "times": True}
111
112
113class Replace(Expression, Func):
114    arg_types = {"this": True, "expression": True, "replacement": False}
115
116
117class Reverse(Expression, Func):
118    pass
119
120
121class Right(Expression, Func):
122    arg_types = {"this": True, "expression": True, "negative_length_returns_empty": False}
123
124
125class RtrimmedLength(Expression, Func):
126    pass
127
128
129class Search(Expression, Func):
130    arg_types = {
131        "this": True,  # data_to_search / search_data
132        "expression": True,  # search_query / search_string
133        "json_scope": False,  # BigQuery: JSON_VALUES | JSON_KEYS | JSON_KEYS_AND_VALUES
134        "analyzer": False,  # Both: analyzer / ANALYZER
135        "analyzer_options": False,  # BigQuery: analyzer_options_values
136        "search_mode": False,  # Snowflake: OR | AND
137    }
138
139
140class SearchIp(Expression, Func):
141    arg_types = {"this": True, "expression": True}
142
143
144class Soundex(Expression, Func):
145    pass
146
147
148class SoundexP123(Expression, Func):
149    pass
150
151
152class Space(Expression, Func):
153    """
154    SPACE(n) → string consisting of n blank characters
155    """
156
157    pass
158
159
160class Split(Expression, Func):
161    arg_types = {
162        "this": True,
163        "expression": True,
164        "limit": False,
165        "null_returns_null": False,
166        "empty_delimiter_returns_whole": False,
167    }
168
169
170class SplitPart(Expression, Func):
171    arg_types = {
172        "this": True,
173        "delimiter": False,
174        "part_index": False,
175        "part_index_zero_as_one": False,  # usually part_index is 1-based, however Snowflake allows 0 and treats it as 1
176        "empty_delimiter_returns_whole": False,  # whether the whole input string should be returned if the delimiter string is empty (i.e. Snowflake)
177    }
178
179
180class Strtok(Expression, Func):
181    arg_types = {
182        "this": True,
183        "delimiter": False,
184        "part_index": False,
185    }
186
187
188class StartsWith(Expression, Func):
189    _sql_names = ["STARTS_WITH", "STARTSWITH"]
190    arg_types = {"this": True, "expression": True}
191
192
193class StrPosition(Expression, Func):
194    arg_types = {
195        "this": True,
196        "substr": True,
197        "position": False,
198        "occurrence": False,
199        "clamp_position": False,
200    }
201
202
203class StrToMap(Expression, Func):
204    arg_types = {
205        "this": True,
206        "pair_delim": False,
207        "key_value_delim": False,
208        "duplicate_resolution_callback": False,
209    }
210
211
212class String(Expression, Func):
213    arg_types = {"this": True, "zone": False}
214
215
216class Stuff(Expression, Func):
217    _sql_names = ["STUFF", "INSERT"]
218    arg_types = {"this": True, "start": True, "length": True, "expression": True}
219
220
221class Substring(Expression, Func):
222    _sql_names = ["SUBSTRING", "SUBSTR"]
223    arg_types = {"this": True, "start": False, "length": False, "zero_start": False}
224
225
226class SubstringIndex(Expression, Func):
227    """
228    SUBSTRING_INDEX(str, delim, count)
229
230    *count* > 0  → left slice before the *count*-th delimiter
231    *count* < 0  → right slice after the |count|-th delimiter
232    """
233
234    arg_types = {"this": True, "delimiter": True, "count": True}
235
236
237class Translate(Expression, Func):
238    arg_types = {"this": True, "from_": True, "to": True}
239
240
241class Trim(Expression, Func):
242    arg_types = {
243        "this": True,
244        "expression": False,
245        "position": False,
246        "collation": False,
247    }
248
249
250class Unicode(Expression, Func):
251    arg_types = {"this": True, "empty_is_zero": False}
252
253
254class Upper(Expression, Func):
255    _sql_names = ["UPPER", "UCASE"]
256
257
258# Encoding / base conversion
259
260
261class Base64DecodeBinary(Expression, Func):
262    arg_types = {"this": True, "alphabet": False}
263
264
265class Base64DecodeString(Expression, Func):
266    arg_types = {"this": True, "alphabet": False}
267
268
269class Base64Encode(Expression, Func):
270    arg_types = {"this": True, "max_line_length": False, "alphabet": False}
271
272
273class CodePointsToBytes(Expression, Func):
274    pass
275
276
277class CodePointsToString(Expression, Func):
278    pass
279
280
281class ConvertToCharset(Expression, Func):
282    arg_types = {"this": True, "dest": True, "source": False}
283
284
285class Decode(Expression, Func):
286    arg_types = {"this": True, "charset": True, "replace": False}
287
288
289class Encode(Expression, Func):
290    arg_types = {"this": True, "charset": True}
291
292
293class FromBase(Expression, Func):
294    arg_types = {"this": True, "expression": True}
295
296
297class FromBase32(Expression, Func):
298    pass
299
300
301class FromBase64(Expression, Func):
302    pass
303
304
305class Hex(Expression, Func):
306    pass
307
308
309class HexDecodeString(Expression, Func):
310    pass
311
312
313class HexEncode(Expression, Func):
314    arg_types = {"this": True, "case": False}
315
316
317class LowerHex(Hex):
318    pass
319
320
321class SafeConvertBytesToString(Expression, Func):
322    pass
323
324
325class ToBase32(Expression, Func):
326    pass
327
328
329class ToBase64(Expression, Func):
330    pass
331
332
333class ToBinary(Expression, Func):
334    arg_types = {"this": True, "format": False, "safe": False}
335
336
337class ToChar(Expression, Func):
338    arg_types = {
339        "this": True,
340        "format": False,
341        "nlsparam": False,
342        "is_numeric": False,
343    }
344
345
346class ToCodePoints(Expression, Func):
347    pass
348
349
350class ToDecfloat(Expression, Func):
351    arg_types = {
352        "this": True,
353        "format": False,
354    }
355
356
357class ToDouble(Expression, Func):
358    arg_types = {
359        "this": True,
360        "format": False,
361        "safe": False,
362    }
363
364
365class ToFile(Expression, Func):
366    arg_types = {
367        "this": True,
368        "path": False,
369        "safe": False,
370    }
371
372
373class ToNumber(Expression, Func):
374    arg_types = {
375        "this": True,
376        "format": False,
377        "nlsparam": False,
378        "precision": False,
379        "scale": False,
380        "safe": False,
381        "safe_name": False,
382    }
383
384
385class TryBase64DecodeBinary(Expression, Func):
386    arg_types = {"this": True, "alphabet": False}
387
388
389class TryBase64DecodeString(Expression, Func):
390    arg_types = {"this": True, "alphabet": False}
391
392
393class TryHexDecodeBinary(Expression, Func):
394    pass
395
396
397class TryHexDecodeString(Expression, Func):
398    pass
399
400
401class TryToDecfloat(Expression, Func):
402    arg_types = {
403        "this": True,
404        "format": False,
405    }
406
407
408class Unhex(Expression, Func):
409    arg_types = {"this": True, "expression": False}
410
411
412# Regex
413
414
415class RegexpCount(Expression, Func):
416    arg_types = {
417        "this": True,
418        "expression": True,
419        "position": False,
420        "parameters": False,
421    }
422
423
424class RegexpExtract(Expression, Func):
425    arg_types = {
426        "this": True,
427        "expression": True,
428        "position": False,
429        "occurrence": False,
430        "parameters": False,
431        "group": False,
432        "null_if_pos_overflow": False,  # for transpilation target behavior
433    }
434
435
436class RegexpExtractAll(Expression, Func):
437    arg_types = {
438        "this": True,
439        "expression": True,
440        "group": False,
441        "parameters": False,
442        "position": False,
443        "occurrence": False,
444    }
445
446
447class RegexpFullMatch(Expression, Binary, Func):
448    arg_types = {"this": True, "expression": True, "options": False}
449
450
451class RegexpILike(Expression, Binary, Func):
452    arg_types = {"this": True, "expression": True, "flag": False}
453
454
455class RegexpInstr(Expression, Func):
456    arg_types = {
457        "this": True,
458        "expression": True,
459        "position": False,
460        "occurrence": False,
461        "option": False,
462        "parameters": False,
463        "group": False,
464    }
465
466
467class RegexpReplace(Expression, Func):
468    arg_types = {
469        "this": True,
470        "expression": True,
471        "replacement": False,
472        "position": False,
473        "occurrence": False,
474        "modifiers": False,
475        "single_replace": False,
476    }
477
478
479class RegexpSplit(Expression, Func):
480    arg_types = {"this": True, "expression": True, "limit": False}
481
482
483# Hashing / cryptographic
484
485
486class Compress(Expression, Func):
487    arg_types = {"this": True, "method": False}
488
489
490class Decrypt(Expression, Func):
491    arg_types = {
492        "this": True,
493        "passphrase": True,
494        "aad": False,
495        "encryption_method": False,
496        "safe": False,
497    }
498
499
500class DecryptRaw(Expression, Func):
501    arg_types = {
502        "this": True,
503        "key": True,
504        "iv": True,
505        "aad": False,
506        "encryption_method": False,
507        "aead": False,
508        "safe": False,
509    }
510
511
512class DecompressBinary(Expression, Func):
513    arg_types = {"this": True, "method": True}
514
515
516class DecompressString(Expression, Func):
517    arg_types = {"this": True, "method": True}
518
519
520class Encrypt(Expression, Func):
521    arg_types = {"this": True, "passphrase": True, "aad": False, "encryption_method": False}
522
523
524class EncryptRaw(Expression, Func):
525    arg_types = {"this": True, "key": True, "iv": True, "aad": False, "encryption_method": False}
526
527
528class CityHash64(Expression, Func):
529    arg_types = {"expressions": False}
530    is_var_len_args = True
531
532
533class FarmFingerprint(Expression, Func):
534    arg_types = {"expressions": True}
535    is_var_len_args = True
536    _sql_names = ["FARM_FINGERPRINT", "FARMFINGERPRINT64"]
537
538
539class MD5(Expression, Func):
540    _sql_names = ["MD5"]
541
542
543class MD5Digest(Expression, Func):
544    arg_types = {"this": True, "expressions": False}
545    is_var_len_args = True
546    _sql_names = ["MD5_DIGEST"]
547
548
549class MD5NumberLower64(Expression, Func):
550    pass
551
552
553class MD5NumberUpper64(Expression, Func):
554    pass
555
556
557class SHA(Expression, Func):
558    _sql_names = ["SHA", "SHA1"]
559
560
561class SHA1Digest(Expression, Func):
562    pass
563
564
565class SHA2(Expression, Func):
566    _sql_names = ["SHA2"]
567    arg_types = {"this": True, "length": False}
568
569
570class SHA2Digest(Expression, Func):
571    arg_types = {"this": True, "length": False}
572
573
574class StandardHash(Expression, Func):
575    arg_types = {"this": True, "expression": False}
576
577
578# Parse
579
580
581class ParseBignumeric(Expression, Func):
582    pass
583
584
585class ParseNumeric(Expression, Func):
586    pass
587
588
589class ParseUrl(Expression, Func):
590    arg_types = {"this": True, "part_to_extract": False, "key": False, "permissive": False}