From fc222377ae8042785d7cef42c6b628819d51b2d8 Mon Sep 17 00:00:00 2001 From: Katya Macedo <38017980+ektravel@users.noreply.github.com> Date: Mon, 11 Dec 2023 11:12:06 -0600 Subject: [PATCH] [Docs] Document decode_base64_complex and decode_base64_utf8 functions (#15444) --- docs/querying/sql-functions.md | 17 +++++++++++++++++ docs/querying/sql-scalar.md | 33 +++++++++++++++++---------------- website/.spelling | 2 ++ 3 files changed, 36 insertions(+), 16 deletions(-) diff --git a/docs/querying/sql-functions.md b/docs/querying/sql-functions.md index 40fabb8a6ed2..d0bf65364286 100644 --- a/docs/querying/sql-functions.md +++ b/docs/querying/sql-functions.md @@ -504,6 +504,23 @@ Returns the current timestamp in the connection's time zone. Rounds down a timestamp by a given time unit. +## DECODE_BASE64_COMPLEX + +`DECODE_BASE64_COMPLEX(dataType, expr)` + +**Function type:** [Scalar, other](sql-scalar.md#other-scalar-functions) + +Decodes a Base64-encoded string into a complex data type, where `dataType` is the complex data type and `expr` is the Base64-encoded string to decode. + +## DECODE_BASE64_UTF8 + +`DECODE_BASE64_UTF8(expr)` + +**Function type:** [Scalar, string](sql-scalar.md#string-functions) + + +Decodes a Base64-encoded string into a UTF-8 encoded string. + ## DEGREES `DEGREES()` diff --git a/docs/querying/sql-scalar.md b/docs/querying/sql-scalar.md index b6be95c02691..8214d379321f 100644 --- a/docs/querying/sql-scalar.md +++ b/docs/querying/sql-scalar.md @@ -93,35 +93,36 @@ String functions accept strings, and return a type appropriate to the function. |--------|-----| |`CONCAT(expr, expr...)`|Concats a list of expressions. Also see the [concatenation operator](sql-operators.md#concatenation-operator).| |`TEXTCAT(expr, expr)`|Two argument version of `CONCAT`.| -|`STRING_FORMAT(pattern, [args...])`|Returns a string formatted in the manner of Java's [String.format](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#format-java.lang.String-java.lang.Object...-).| +|`CONTAINS_STRING(expr, str)`|Returns true if the `str` is a substring of `expr`.| +|`ICONTAINS_STRING(expr, str)`|Returns true if the `str` is a substring of `expr`. The match is case-insensitive.| +|`DECODE_BASE64_UTF8(expr)`|Decodes a Base64-encoded string into a UTF-8 encoded string.| +|`LEFT(expr, [length])`|Returns the leftmost length characters from `expr`.| +|`RIGHT(expr, [length])`|Returns the rightmost length characters from `expr`.| |`LENGTH(expr)`|Length of `expr` in UTF-16 code units.| |`CHAR_LENGTH(expr)`|Alias for `LENGTH`.| |`CHARACTER_LENGTH(expr)`|Alias for `LENGTH`.| |`STRLEN(expr)`|Alias for `LENGTH`.| -|`LOOKUP(expr, lookupName, [replaceMissingValueWith])`|Look up `expr` in a registered [query-time lookup table](lookups.md). Note that lookups can also be queried directly using the [`lookup` schema](sql.md#from). Optional constant replaceMissingValueWith can be passed as 3rd argument to be returned when value is missing from lookup.| +|`LOOKUP(expr, lookupName, [replaceMissingValueWith])`|Look up `expr` in a registered [query-time lookup table](lookups.md). Note that lookups can also be queried directly using the [`lookup` schema](sql.md#from). Optional constant `replaceMissingValueWith` can be passed as a third argument to be returned when value is missing from lookup.| |`LOWER(expr)`|Returns `expr` in all lowercase.| |`UPPER(expr)`|Returns `expr` in all uppercase.| +|`LPAD(expr, length, [chars])`|Returns a string of `length` from `expr` left-padded with `chars`. If `length` is shorter than the length of `expr`, the result is `expr` which is truncated to `length`. The result will be null if either `expr` or `chars` is null. If `chars` is an empty string, no padding is added, however `expr` may be trimmed if necessary.| +|`RPAD(expr, length, [chars])`|Returns a string of `length` from `expr` right-padded with `chars`. If `length` is shorter than the length of `expr`, the result is `expr` which is truncated to `length`. The result will be null if either `expr` or `chars` is null. If `chars` is an empty string, no padding is added, however `expr` may be trimmed if necessary.| |`PARSE_LONG(string, [radix])`|Parses a string into a long (BIGINT) with the given radix, or 10 (decimal) if a radix is not provided.| |`POSITION(needle IN haystack [FROM fromIndex])`|Returns the index of `needle` within `haystack`, with indexes starting from 1. The search will begin at `fromIndex`, or 1 if `fromIndex` is not specified. If `needle` is not found, returns 0.| |`REGEXP_EXTRACT(expr, pattern, [index])`|Apply regular expression `pattern` to `expr` and extract a capture group, or `NULL` if there is no match. If index is unspecified or zero, returns the first substring that matched the pattern. The pattern may match anywhere inside `expr`; if you want to match the entire string instead, use the `^` and `$` markers at the start and end of your pattern. Note: when `druid.generic.useDefaultValueForNull = true`, it is not possible to differentiate an empty-string match from a non-match (both will return `NULL`).| |`REGEXP_LIKE(expr, pattern)`|Returns whether `expr` matches regular expression `pattern`. The pattern may match anywhere inside `expr`; if you want to match the entire string instead, use the `^` and `$` markers at the start and end of your pattern. Similar to [`LIKE`](sql-operators.md#logical-operators), but uses regexps instead of LIKE patterns. Especially useful in WHERE clauses.| |`REGEXP_REPLACE(expr, pattern, replacement)`|Replaces all occurrences of regular expression `pattern` within `expr` with `replacement`. The replacement string may refer to capture groups using `$1`, `$2`, etc. The pattern may match anywhere inside `expr`; if you want to match the entire string instead, use the `^` and `$` markers at the start and end of your pattern.| -|`CONTAINS_STRING(expr, str)`|Returns true if the `str` is a substring of `expr`.| -|`ICONTAINS_STRING(expr, str)`|Returns true if the `str` is a substring of `expr`. The match is case-insensitive.| |`REPLACE(expr, pattern, replacement)`|Replaces pattern with replacement in `expr`, and returns the result.| +|`REPEAT(expr, [N])`|Repeats `expr` N times.| +|`REVERSE(expr)`|Reverses `expr`.| +|`STRING_FORMAT(pattern, [args...])`|Returns a string formatted in the manner of Java's [String.format](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#format-java.lang.String-java.lang.Object...-).| |`STRPOS(haystack, needle)`|Returns the index of `needle` within `haystack`, with indexes starting from 1. If `needle` is not found, returns 0.| |`SUBSTRING(expr, index, [length])`|Returns a substring of `expr` starting at index, with a max length, both measured in UTF-16 code units.| -|`RIGHT(expr, [length])`|Returns the rightmost length characters from `expr`.| -|`LEFT(expr, [length])`|Returns the leftmost length characters from `expr`.| |`SUBSTR(expr, index, [length])`|Alias for `SUBSTRING`.| -|`TRIM([BOTH `|` LEADING `|` TRAILING] [chars FROM] expr)`|Returns `expr` with characters removed from the leading, trailing, or both ends of "expr" if they are in "chars". If "chars" is not provided, it defaults to " " (a space). If the directional argument is not provided, it defaults to "BOTH".| +|`TRIM([BOTH `|` LEADING `|` TRAILING] [chars FROM] expr)`|Returns `expr` with characters removed from the leading, trailing, or both ends of `expr` if they are in `chars`. If `chars` is not provided, it defaults to `''` (a space). If the directional argument is not provided, it defaults to `BOTH`.| |`BTRIM(expr, [chars])`|Alternate form of `TRIM(BOTH chars FROM expr)`.| |`LTRIM(expr, [chars])`|Alternate form of `TRIM(LEADING chars FROM expr)`.| |`RTRIM(expr, [chars])`|Alternate form of `TRIM(TRAILING chars FROM expr)`.| -|`REVERSE(expr)`|Reverses `expr`.| -|`REPEAT(expr, [N])`|Repeats `expr` N times| -|`LPAD(expr, length, [chars])`|Returns a string of `length` from `expr` left-padded with `chars`. If `length` is shorter than the length of `expr`, the result is `expr` which is truncated to `length`. The result will be null if either `expr` or `chars` is null. If `chars` is an empty string, no padding is added, however `expr` may be trimmed if necessary.| -|`RPAD(expr, length, [chars])`|Returns a string of `length` from `expr` right-padded with `chars`. If `length` is shorter than the length of `expr`, the result is `expr` which is truncated to `length`. The result will be null if either `expr` or `chars` is null. If `chars` is an empty string, no padding is added, however `expr` may be trimmed if necessary.| ## Date and time functions @@ -271,11 +272,11 @@ The [DataSketches extension](../development/extensions-core/datasketches-extensi |Function|Notes| |--------|-----| -|`CAST(value AS TYPE)`|Cast value to another type. See [Data types](sql-data-types.md) for details about how Druid SQL handles CAST.| +|`BLOOM_FILTER_TEST(expr, serialized-filter)`|Returns true if the value of `expr` is contained in the base64-serialized Bloom filter. See the [Bloom filter extension](../development/extensions-core/bloom-filter.md) documentation for additional details. See the [`BLOOM_FILTER` function](sql-aggregations.md) for computing Bloom filters.| |`CASE expr WHEN value1 THEN result1 \[ WHEN value2 THEN result2 ... \] \[ ELSE resultN \] END`|Simple CASE.| |`CASE WHEN boolean_expr1 THEN result1 \[ WHEN boolean_expr2 THEN result2 ... \] \[ ELSE resultN \] END`|Searched CASE.| -|`NULLIF(value1, value2)`|Returns NULL if value1 and value2 match, else returns value1.| +|`CAST(value AS TYPE)`|Cast value to another type. See [Data types](sql-data-types.md) for details about how Druid SQL handles CAST.| |`COALESCE(value1, value2, ...)`|Returns the first value that is neither NULL nor empty string.| -|`NVL(value1, value2)`|Returns `value1` if `value1` is not null, otherwise `value2`.| -|`BLOOM_FILTER_TEST(expr, serialized-filter)`|Returns true if the value of `expr` is contained in the Base64-serialized Bloom filter. See the [Bloom filter extension](../development/extensions-core/bloom-filter.md) documentation for additional details. See the [`BLOOM_FILTER` function](sql-aggregations.md) for computing Bloom filters.| - +|`DECODE_BASE64_COMPLEX(dataType, expr)`| Decodes a Base64-encoded string into a complex data type, where `dataType` is the complex data type and `expr` is the Base64-encoded string to decode. The `hyperUnique` and `serializablePairLongString` data types are supported by default. You can enable support for the following complex data types by loading their extensions:
| +|`NULLIF(value1, value2)`|Returns NULL if `value1` and `value2` match, else returns `value1`.| +|`NVL(value1, value2)`|Returns `value1` if `value1` is not null, otherwise `value2`.| \ No newline at end of file diff --git a/website/.spelling b/website/.spelling index 1aa08a229fb3..5b21a4c5bd2c 100644 --- a/website/.spelling +++ b/website/.spelling @@ -2219,6 +2219,8 @@ CHARACTER_LENGTH CURRENT_DATE CURRENT_TIMESTAMP DATE_TRUNC +DECODE_BASE64_COMPLEX +DECODE_BASE64_UTF8 DS_CDF DS_GET_QUANTILE DS_GET_QUANTILES