[Enhancement](docs) Sql function compress and uncompress #1955
+310
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 tasks
zclllyybb
reviewed
Jan 27, 2025
|
|
||
| ## Parameters | ||
|
|
||
| | 参数 | 说明 | |
There was a problem hiding this comment.
there shouldn't be Chinese character in English docs
zclllyybb
reviewed
Jan 27, 2025
| select compress('abc'); | ||
| ``` | ||
| ```text | ||
| +----------------------------------+ |
There was a problem hiding this comment.
please add case about empty string input
zclllyybb
reviewed
Jan 27, 2025
| ## Syntax | ||
|
|
||
| ```sql | ||
| SELECT(<uncompressed>, <compressed>) |
There was a problem hiding this comment.
seems it's wrong? should be COMPRESS(<uncompressed_str>)?
zclllyybb
reviewed
Jan 27, 2025
| ## Syntax | ||
|
|
||
| ```sql | ||
| UNCOMPRESS(<compressed>, <uncompressed>) |
There was a problem hiding this comment.
wrong, uncompress only accept one arg
zclllyybb
reviewed
Jan 27, 2025
| select uncompress(compress('abc')); | ||
| ``` | ||
| ```text | ||
| +-----------------------------+ |
There was a problem hiding this comment.
add more cases which got NULL, or empty
lzyy2024
force-pushed
the
FunctionCompress
branch
from
cd7da31 to
3fad78c
Compare
zclllyybb
reviewed
Jan 28, 2025
| | 0x03000000789C4B4C4A0600024D0127 | | ||
| +----------------------------------+ | ||
| ``` | ||
| ``` |
There was a problem hiding this comment.
add sql here, and remove mysql>
| ``` | ||
| mysql> select compress(''); | ||
| ``` | ||
| ``` |
zclllyybb
reviewed
Feb 7, 2025
| ``` sql | ||
| select compress('abc'); | ||
| ``` | ||
| The result of the decompression is unreadable and you don't need to care about its true value. |
There was a problem hiding this comment.
dont comment like this. add a example like uncompress(compress())
lzyy2024
force-pushed
the
FunctionCompress
branch
from
0025aad to
54fef7a
Compare
zclllyybb
reviewed
Feb 8, 2025
| ## 语法 | ||
|
|
||
| ```sql | ||
| COMPRESS(<uncompresse_str>) |
|
|
||
| ## 返回值 | ||
| 返回串与输入的 <uncompressed_str> 类型一致 | ||
| 它是不可读的压缩字节流，你不应该获取它。 |
| |--------------------|---------------| | ||
| | `<uncompressed_str>` | 未压缩的原串 | | ||
|
|
||
| 参数类型是varchar或者string |
morrySnow
reviewed
Feb 11, 2025
|
|
||
|
|
||
| ## Instructions | ||
| The parameter type is varchar or string |
There was a problem hiding this comment.
- 这一行移动到 Parameters 的 Description 里
- 这一章节改名 Return Value
| ## Instructions | ||
| The parameter type is varchar or string | ||
|
|
||
| The return string is of the same type as the input <uncompressed_str> |
There was a problem hiding this comment.
Suggested change
| The return string is of the same type as the input <uncompressed_str> | |
| The return string is of the same type as the input `<uncompressed_str>` |
|
|
||
| The return string is an unreadable compressed byte stream. | ||
| Special cases: | ||
| - <uncompressed_str> Return '' when the input is '' |
There was a problem hiding this comment.
Suggested change
| - <uncompressed_str> Return '' when the input is '' | |
| - `<uncompressed_str>` Return empty string(`''`) when the input is empty string(`''`) |
| | `<compressed_str>` | Compressed binary data | | ||
|
|
||
|
|
||
| ## Instructions |
morrySnow
reviewed
Feb 11, 2025
Comment on lines
40
to
42
| | `<uncompressed_str>` | Uncompressed raw string | | ||
|
|
||
| The parameter type is varchar or string |
There was a problem hiding this comment.
Suggested change
| | `<uncompressed_str>` | Uncompressed raw string | | |
| The parameter type is varchar or string | |
| | `<uncompressed_str>` | Uncompressed raw string, parameter type is varchar or string | |
lzyy2024
had a problem deploying
to
Production
GitHub Actions
Failure
morrySnow
approved these changes
Feb 11, 2025
lzyy2024
force-pushed
the
FunctionCompress
branch
from
2649121 to
16dc471
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Versions
Languages
Docs Checklist