function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 #16087

PitifulPete · 2024-01-10T14:06:02Z

What have you changed? (mandatory)

Please explain IN DETAIL what the changes are in this PR and why they are needed:

Fix (Enrich instructions for string functions BIT_LENGTH() and CHAR() #15482)
Describe the BIT_LENGTH() and CHAR() functions
Add three examples that illustrate how BIT_LENGTH() works and four examples that illustrate how CHAR() works.
Add a blockquote under the second BIT_LENGTH() example to indicate that the example operates under the assumption that a database exist
Add a blockquote before "Further Examples" to explain that CHAR() also works with non-ASCII character

Please NOTE that:

Do not assume the code is self-evident
Do not assume reviewers understand the original issue

What are the type of the changes? (mandatory)

The currently defined types are listed below, please pick one of the types for this PR by removing the others:

Improvement (non-breaking change which is an improvement to an existing feature)

How has this PR been tested? (mandatory)

Please describe the tests that you ran to verify your changes. Have you finished unit tests, integration tests, or manual tests?

Does this PR affect documentation (docs/docs-cn) update? (mandatory)

YES

If there is document change, please file a PR in (docs and docs-cn) and add the PR number here.

Refer to a related PR or issue link (optional)

Benchmark result if necessary (optional)

Add a few positive/negative examples (optional)

…R_LENGTH() and CHARACTER_LENGTH() improve content on string functions

@dveeden

Implemented corrections suggested by @dveeden and responded to one comment Co-authored-by: Daniël van Eeden <[email protected]>

improve string functions documentation

dveeden

Note that this might have overlap with #16068

functions-and-operators/string-functions.md

dveeden · 2024-01-10T14:25:11Z

From the linters:

[2024-01-10T14:09:46.029Z] functions-and-operators/string-functions.md: this file has manual line breaks in the following lines:
[2024-01-10T14:09:46.029Z] 
[2024-01-10T14:09:46.029Z] MANUAL LINE BREAKS: L128
[2024-01-10T14:09:46.029Z] MANUAL LINE BREAKS: L157

[2024-01-10T14:09:33.056Z] + markdownlint functions-and-operators/string-functions.md
[2024-01-10T14:09:33.314Z] functions-and-operators/string-functions.md: 121: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
[2024-01-10T14:09:33.314Z] functions-and-operators/string-functions.md: 122: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```sql"]
[2024-01-10T14:09:33.314Z] functions-and-operators/string-functions.md: 148: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
[2024-01-10T14:09:33.314Z] functions-and-operators/string-functions.md: 149: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```sql"]

…R_LENGTH() and CHARACTER_LENGTH() improve content on string functions

@dveeden

Implemented corrections suggested by @dveeden and responded to one comment Co-authored-by: Daniël van Eeden <[email protected]>

improve string functions documentation

…ions and add new details add details and examples that modify previous descriptions

dveeden · 2024-01-11T15:35:50Z

functions-and-operators/string-functions.md

+----------+
+| BIT_LENGTH("TiDB") |
+----------+
+| 8 (T) + 8 (i) + 8 (D) + 8 (B) = 40 bits |


This is mixing actual output with the description.

mysql> SELECT BIT_LENGTH("TiDB"); +--------------------+ | BIT_LENGTH("TiDB") | +--------------------+ | 32 | +--------------------+ 1 row in set (0.01 sec)

Also maybe it would be better to say: "8 bits per character × 4 characters = 40 bits"

i actually think the "8 (T) + 8 (i)..." is clearer because of examples that use non-alphanumeric characters

functions-and-operators/string-functions.md

dveeden · 2024-01-11T15:38:30Z

functions-and-operators/string-functions.md

+SELECT CustomerName, BIT_LENGTH(CustomerName) AS BitLengthOfName FROM Customers;
+| CustomerName|BitLengthOfName |
+|-------------|----------------|
+| Albert Einstein | 120 bits |


This also mixes actual output with description.

mysql> SELECT CustomerName, BIT_LENGTH(CustomerName) AS BitLengthOfName FROM Customers; +--------------------+-----------------+ | CustomerName | BitLengthOfName | +--------------------+-----------------+ | Albert Einstein | 120 | | Robert Oppenheimer | 144 | +--------------------+-----------------+ 2 rows in set (0.01 sec)

To get something similar:

mysql> SELECT CustomerName, FORMAT_BYTES(BIT_LENGTH(CustomerName)*8) AS BitLengthOfName FROM Customers; +--------------------+-----------------+ | CustomerName | BitLengthOfName | +--------------------+-----------------+ | Albert Einstein | 960 bytes | | Robert Oppenheimer | 1.12 KiB | +--------------------+-----------------+ 2 rows in set (0.00 sec)

please clarify what you mean by "mixing actual output with description"

oh, got it. thank you @yibin87

functions-and-operators/string-functions.md

Co-authored-by: Daniël van Eeden <[email protected]>

…amples in CHAR

yibin87

There seems multiple commits in this PR: br-related, bit_length, char_length, tidb-global-sort and some others...

yibin87 · 2024-01-12T07:29:03Z

functions-and-operators/string-functions.md

+SELECT CustomerName, BIT_LENGTH(CustomerName) AS BitLengthOfName FROM Customers;
+| CustomerName|BitLengthOfName |
+|-------------|----------------|
+| Albert Einstein | 120 bits |


yibin87 · 2024-01-12T07:29:14Z

functions-and-operators/string-functions.md

+| BIT_LENGTH("PingCap 123") |
+----------+
+| 8 (P) + 8 (i) + 8 (n) + 8 (g) + 8 (C) + 8 (a) + 8 (p) + 8 () + 8 (1) + 8 (2) + 8 (3) = 88 bits |
+----------+


yibin87 · 2024-01-12T07:30:11Z

functions-and-operators/string-functions.md

+
+> **Note:**
+>
+> The second example operates under the assumption that there is a database with a record titled `Customers` and a field inside titled `CustomerName`


Not sure if word "record" is accurate, in my understanding, it is a table names "Customers" with "CustomerName" column.

i'm sure it is accurate. record (row) and field (column). admittedly, could have just used column and row tho

changed record to row, and field to column for simplicity, @yibin87

PitifulPete · 2024-01-12T08:09:26Z

There seems multiple commits in this PR: br-related, bit_length, char_length, tidb-global-sort and some others...

yes. not sure why that happened tho

yibin87 · 2024-01-12T08:47:33Z

There seems multiple commits in this PR: br-related, bit_length, char_length, tidb-global-sort and some others...

yes. not sure why that happened tho

Maybe you need to create mutilple different branches, all rebase from master, then one branch for one commit, and submit pr from different branches.

…ingcap#16057

functions-and-operators/string-functions.md

…d in pingcap#16087

yibin87

LGTM

ti-chi-bot · 2024-01-29T07:20:37Z

@yibin87: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ti-chi-bot · 2024-01-29T07:38:10Z

[LGTM Timeline notifier]

Timeline:

2024-01-29 06:54:04.062508585 +0000 UTC m=+1375685.626806288: ☑️ agreed by dveeden.
2024-01-29 07:38:09.078055318 +0000 UTC m=+1378330.642353022: ☑️ agreed by hfxsd.

qiancai · 2024-01-30T01:30:13Z

@PitifulPete do you need any additional help with this PR? It'd be great to get this merged by February 1 so that you also get points for a merged PR 😄

Hey @rpaik, I actually do not know why it hasn't been merged. Doesn't seem like there is any outstanding issue raised by any of the reviewers that i'm yet to attend to. Hey @qiancai, why haven't this PR and 16057 been merged?

Hi @PitifulPete, that was because some content in this PR was overlapped with #16057. I've cleaned them up in 32dc80e. Now this PR is ready for merge.

qiancai · 2024-01-30T01:42:59Z

/approve

ti-chi-bot · 2024-01-30T01:43:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

qiancai · 2024-01-30T03:50:04Z

/retest

PitifulPete and others added 4 commits January 10, 2024 14:47

functions-and-operators: enrich instructions for string functions CHA…

f4972cf

…R_LENGTH() and CHARACTER_LENGTH() improve content on string functions

functions-and-operators: fix table rendering error

ac47fca

Apply suggestions from code review

372b54d

Implemented corrections suggested by @dveeden and responded to one comment Co-authored-by: Daniël van Eeden <[email protected]>

functions-and-operators: enrich instructions for BIT_LENGTH and CHAR()

031d59d

improve string functions documentation

dveeden reviewed Jan 10, 2024

View reviewed changes

functions-and-operators/string-functions.md Outdated Show resolved Hide resolved

functions-and-operators/string-functions.md Outdated Show resolved Hide resolved

qiancai added 2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. translation/doing This PR's assignee is translating this PR. labels Jan 10, 2024

ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 10, 2024

qiancai requested a review from yibin87 January 11, 2024 08:20

PitifulPete and others added 6 commits January 11, 2024 14:51

functions-and-operators: enrich instructions for string functions CHA…

a9cb5d1

…R_LENGTH() and CHARACTER_LENGTH() improve content on string functions

functions-and-operators: fix table rendering error

83b3f6b

Apply suggestions from code review

f2ad58b

Implemented corrections suggested by @dveeden and responded to one comment Co-authored-by: Daniël van Eeden <[email protected]>

functions-and-operators: enrich instructions for BIT_LENGTH and CHAR()

0c232f2

improve string functions documentation

functions-and-operators: correct errors in descriptions of both funct…

4500edc

…ions and add new details add details and examples that modify previous descriptions

functions-and-operators: correct errors in descriptions of both funct…

7b23e52

…ions and add new details add details and examples that modify previous descriptions

ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 11, 2024

PitifulPete requested a review from dveeden January 11, 2024 14:26

dveeden reviewed Jan 11, 2024

View reviewed changes

PitifulPete and others added 2 commits January 11, 2024 17:57

Apply suggestions from code review

600dccf

Co-authored-by: Daniël van Eeden <[email protected]>

functions-and-operators: correct one example in BIT_LENGTH and two ex…

4b015b0

…amples in CHAR

yibin87 reviewed Jan 12, 2024

View reviewed changes

functions-and-operators: fix errors in BIT_LENGTH() examples

8280c1d

qiancai self-assigned this Jan 29, 2024

qiancai added 2 commits January 29, 2024 15:05

refine the output formats

9e97810

revert changes of CHAR() and CHAR_LENGTH()` as they are covered in p…

32dc80e

…ingcap#16057

qiancai reviewed Jan 29, 2024

View reviewed changes

functions-and-operators/string-functions.md Outdated Show resolved Hide resolved

qiancai reviewed Jan 29, 2024

View reviewed changes

functions-and-operators/string-functions.md Outdated Show resolved Hide resolved

revert changes

d5e14f0

qiancai added a commit to PitifulPete/tidb-docs that referenced this pull request Jan 29, 2024

revert changes of BIT_LENGTH() and CHAR() because they are covere…

d935406

…d in pingcap#16087

yibin87 approved these changes Jan 29, 2024

View reviewed changes

hfxsd approved these changes Jan 29, 2024

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jan 29, 2024

qiancai approved these changes Jan 30, 2024

View reviewed changes

ti-chi-bot bot added the approved label Jan 30, 2024

qiancai added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 30, 2024

qiancai removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved labels Jan 30, 2024

ti-chi-bot bot added the approved label Jan 30, 2024

ti-chi-bot bot merged commit f1b3e2b into pingcap:master Jan 30, 2024
9 checks passed

PitifulPete deleted the enrich/instructions-bitlength-char branch January 30, 2024 08:36

qiancai linked an issue Jan 31, 2024 that may be closed by this pull request

Enrich instructions for string functions BIT_LENGTH() and CHAR() #15482

Closed

This was referenced Jan 31, 2024

Enrich instructions for string functions BIT_LENGTH() and CHAR() #15482

Closed

function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 pingcap/docs-cn#16516

Merged

qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Feb 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 #16087

function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 #16087

PitifulPete commented Jan 10, 2024 •

edited

Loading

dveeden left a comment

dveeden commented Jan 10, 2024

dveeden Jan 11, 2024

PitifulPete Jan 11, 2024

dveeden Jan 11, 2024

PitifulPete Jan 11, 2024

yibin87 Jan 12, 2024

PitifulPete Jan 12, 2024

yibin87 left a comment

yibin87 Jan 12, 2024

yibin87 Jan 12, 2024

yibin87 Jan 12, 2024

PitifulPete Jan 12, 2024

PitifulPete Jan 12, 2024

PitifulPete commented Jan 12, 2024

yibin87 commented Jan 12, 2024

yibin87 left a comment

ti-chi-bot bot commented Jan 29, 2024

ti-chi-bot bot commented Jan 29, 2024

qiancai commented Jan 30, 2024 •

edited

Loading

qiancai commented Jan 30, 2024

ti-chi-bot bot commented Jan 30, 2024

qiancai commented Jan 30, 2024

function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 #16087

function-and-operators: enrich instructions for string functions BIT_LENGTH() and CHAR() #15482 #16087

Conversation

PitifulPete commented Jan 10, 2024 • edited Loading

What have you changed? (mandatory)

What are the type of the changes? (mandatory)

How has this PR been tested? (mandatory)

Does this PR affect documentation (docs/docs-cn) update? (mandatory)

Refer to a related PR or issue link (optional)

Benchmark result if necessary (optional)

Add a few positive/negative examples (optional)

dveeden left a comment

Choose a reason for hiding this comment

dveeden commented Jan 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yibin87 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PitifulPete commented Jan 12, 2024

yibin87 commented Jan 12, 2024

yibin87 left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Jan 29, 2024

ti-chi-bot bot commented Jan 29, 2024

[LGTM Timeline notifier]

qiancai commented Jan 30, 2024 • edited Loading

qiancai commented Jan 30, 2024

ti-chi-bot bot commented Jan 30, 2024

qiancai commented Jan 30, 2024

PitifulPete commented Jan 10, 2024 •

edited

Loading

qiancai commented Jan 30, 2024 •

edited

Loading