Docs: added docs for trimLeft, trimRight, trimBoth (#7924)

This commit is contained in:
Sergei Bocharov 2019-12-05 13:03:35 +03:00 committed by Ivan Blinkov
parent 2cc78413ed
commit 529293faad
2 changed files with 222 additions and 6 deletions

View File

@ -217,17 +217,119 @@ Result:
└───────────────────────────────────┘
```
## trimLeft(s)
## trimLeft {#trimleft}
Returns a string that removes the whitespace characters on left side.
Removes all consecutive occurrences of common whitespace (ASCII character 32) from the beginning of a string. It doesn't remove other kinds of whitespace characters (tab, no-break space, etc.).
## trimRight(s)
**Syntax**
Returns a string that removes the whitespace characters on right side.
```sql
trimLeft()
```
## trimBoth(s)
Alias: `ltrim`.
Returns a string that removes the whitespace characters on either side.
**Parameters**
- `string` — string to trim. [String](../../data_types/string.md).
**Returned value**
A string without leading common whitespaces.
Type: `String`.
**Example**
Query:
```sql
SELECT trimLeft(' Hello, world! ')
```
Result:
```text
┌─trimLeft(' Hello, world! ')─┐
│ Hello, world! │
└─────────────────────────────────────┘
```
## trimRight {#trimright}
Removes all consecutive occurrences of common whitespace (ASCII character 32) from the end of a string. It doesn't remove other kinds of whitespace characters (tab, no-break space, etc.).
**Syntax**
```sql
trimRight()
```
Alias: `rtrim`.
**Parameters**
- `string` — string to trim. [String](../../data_types/string.md).
**Returned value**
A string without trailing common whitespaces.
Type: `String`.
**Example**
Query:
```sql
SELECT trimRight(' Hello, world! ')
```
Result:
```text
┌─trimRight(' Hello, world! ')─┐
│ Hello, world! │
└──────────────────────────────────────┘
```
## trimBoth {#trimboth}
Removes all consecutive occurrences of common whitespace (ASCII character 32) from both ends of a string. It doesn't remove other kinds of whitespace characters (tab, no-break space, etc.).
**Syntax**
```sql
trimBoth()
```
Alias: `trim`.
**Parameters**
- `string` — string to trim. [String](../../data_types/string.md).
**Returned value**
A string without leading and trailing common whitespaces.
Type: `String`.
**Example**
Query:
```sql
SELECT trimBoth(' Hello, world! ')
```
Result:
```text
┌─trimBoth(' Hello, world! ')─┐
│ Hello, world! │
└─────────────────────────────────────┘
```
## CRC32(s)

View File

@ -189,6 +189,120 @@ SELECT startsWith('Hello, world!', 'He');
└───────────────────────────────────┘
```
## trimLeft {#trimleft}
Удаляет все последовательные вхождения обычных пробелов (32 символ ASCII) с левого конца строки. Не удаляет другие виды пробелов (табуляция, пробел без разрыва и т. д.).
**Синтаксис**
```sql
trimLeft()
```
Алиас: `ltrim`.
**Параметры**
- `string` — строка для обрезки. [String](../../data_types/string.md).
**Возвращаемое значение**
Исходную строку без общих пробельных символов слева.
Тип: `String`.
**Пример**
Запрос:
```sql
SELECT trimLeft(' Hello, world! ')
```
Ответ:
```text
┌─trimLeft(' Hello, world! ')─┐
│ Hello, world! │
└─────────────────────────────────────┘
```
## trimRight {#trimright}
Удаляет все последовательные вхождения обычных пробелов (32 символ ASCII) с правого конца строки. Не удаляет другие виды пробелов (табуляция, пробел без разрыва и т. д.).
**Синтаксис**
```sql
trimRight()
```
Алиас: `rtrim`.
**Параметры**
- `string` — строка для обрезки. [String](../../data_types/string.md).
**Возвращаемое значение**
Исходную строку без общих пробельных символов справа.
Тип: `String`.
**Пример**
Запрос:
```sql
SELECT trimRight(' Hello, world! ')
```
Ответ:
```text
┌─trimRight(' Hello, world! ')─┐
│ Hello, world! │
└──────────────────────────────────────┘
```
## trimBoth {#trimboth}
Удаляет все последовательные вхождения обычных пробелов (32 символ ASCII) с обоих концов строки. Не удаляет другие виды пробелов (табуляция, пробел без разрыва и т. д.).
**Синтаксис**
```sql
trimBoth()
```
Алиас: `trim`.
**Параметры**
- `string` — строка для обрезки. [String](../../data_types/string.md).
**Возвращаемое значение**
Исходную строку без общих пробельных символов с обоих концов строки.
Тип: `String`.
**Пример**
Запрос:
```sql
SELECT trimBoth(' Hello, world! ')
```
Ответ:
```text
┌─trimBoth(' Hello, world! ')─┐
│ Hello, world! │
└─────────────────────────────────────┘
```
## CRC32(s)
Возвращает чексумму CRC32 данной строки, используется CRC-32-IEEE 802.3 многочлен и начальным значением `0xffffffff` (т.к. используется реализация из zlib).