Skip to content

Update docs for Digest #12889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 13, 2025
Merged

Update docs for Digest #12889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab12e9b
Update docs for Digest
Dec 23, 2024
db479bf
Update en version
Dec 23, 2024
1aee273
Fix markup
Dec 23, 2024
57c34e9
Update digest.md
Dec 27, 2024
d4b3eb1
Apply suggestions from code review
blinkov Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions ydb/docs/en/core/yql/reference/yql-core/udf/list/digest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ A set of commonly used hash functions.
## List of functions

* `Digest::Crc32c(String{Flags::AutoMap}) -> Uint32`
* `Digest::Crc64(String{Flags::AutoMap}) -> Uint64`
* `Digest::Fnv32(String{Flags::AutoMap}) -> Uint32`
* `Digest::Fnv64(String{Flags::AutoMap}) -> Uint64`
* `Digest::MurMurHash(String{Flags:AutoMap}) -> Uint64`
* `Digest::MurMurHash32(String{Flags:AutoMap}) -> Uint32`
* `Digest::MurMurHash2A(String{Flags:AutoMap}) -> Uint64`
* `Digest::MurMurHash2A32(String{Flags:AutoMap}) -> Uint32`
* `Digest::CityHash(String{Flags:AutoMap}, [Uint64?]) -> Uint64`: The second optional argument is seed
* `Digest::Crc64(String{Flags::AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::Fnv32(String{Flags::AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::Fnv64(String{Flags::AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash32(String{Flags:AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::MurMurHash2A(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash2A32(String{Flags:AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::CityHash(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::CityHash128(String{Flags:AutoMap}) -> Tuple<Uint64,Uint64>`
* `Digest::NumericHash(Uint64{Flags:AutoMap}) -> Uint64`
* `Digest::Md5Hex(String{Flags:AutoMap}) -> String`
Expand All @@ -34,6 +34,8 @@ A set of commonly used hash functions.
* `Digest::XXH3(String{Flags:AutoMap}) -> Uint64`
* `Digest::XXH3_128(String{Flags:AutoMap}) -> Tuple<Uint64,Uint64>`

The functions for the hashes that support the initialization parameter (seed) accept its value in the optional named argument `Init`.

### Examples

```yql
Expand Down
18 changes: 10 additions & 8 deletions ydb/docs/ru/core/yql/reference/yql-core/udf/list/digest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@
## Список функций

* `Digest::Crc32c(String{Flags::AutoMap}) -> Uint32`
* `Digest::Crc64(String{Flags::AutoMap}) -> Uint64`
* `Digest::Fnv32(String{Flags::AutoMap}) -> Uint32`
* `Digest::Fnv64(String{Flags::AutoMap}) -> Uint64`
* `Digest::MurMurHash(String{Flags:AutoMap}) -> Uint64`
* `Digest::MurMurHash32(String{Flags:AutoMap}) -> Uint32`
* `Digest::MurMurHash2A(String{Flags:AutoMap}) -> Uint64`
* `Digest::MurMurHash2A32(String{Flags:AutoMap}) -> Uint32`
* `Digest::CityHash(String{Flags:AutoMap}, [Uint64?]) -> Uint64`: Второй опциональный аргумент задает seed
* `Digest::Crc64(String{Flags::AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::Fnv32(String{Flags::AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::Fnv64(String{Flags::AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash32(String{Flags:AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::MurMurHash2A(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::MurMurHash2A32(String{Flags:AutoMap}, [Init:Uint32?]) -> Uint32`
* `Digest::CityHash(String{Flags:AutoMap}, [Init:Uint64?]) -> Uint64`
* `Digest::CityHash128(String{Flags:AutoMap}) -> Tuple<Uint64,Uint64>`

Функции для видов хешей, которые поддерживают значение-параметр для инициализации (seed), принимают его опциональным именованным аргументом `Init`.

CityHash функция для байтовой строки с результатом типа uint128. Результат представлен как пара из двух uint64 чисел `<low, high>`

```yql
Expand Down
Loading