Skip to content

Fix superscripts lost in the vendored protocol docs #2

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
m13m merged 1 commit into from
Oct 28, 2026
Merged

Fix superscripts lost in the vendored protocol docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/mysql-protocol/page_protocol_basic_compression_packet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ c0 c0 62 94 48 32 00 ea 67 05 eb 07 00 8d f9 1c ..b.H2..g.......
**Definition:** jit_executor_value.cc:373

Note
sending a MySQL Packet of the size 224-5 to 224-1 via compression leads to at least one extra compressed packet. If the uncompressed MySQL Packet is like
sending a MySQL Packet of the size 2^24-5 to 2^24-1 via compression leads to at least one extra compressed packet. If the uncompressed MySQL Packet is like

fe ff ff 03 ... -- [length](https://dev.mysql.com/doc/dev/mysql-server/latest/namespacegis.html#a1e3bf735dbe640151561b282f0f4dba5) = 2^24-2, [sequence](https://dev.mysql.com/doc/dev/mysql-server/latest/udf__example_8cc.html#aa48a6c218d5a51dadae7378c4e83c109) id = 3

Expand Down
6 changes: 3 additions & 3 deletions docs/mysql-protocol/page_protocol_basic_dt_integers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ To convert a number value into a length-encoded integer:
| Greater or equal | Lower than | Stored as |
| --- | --- | --- |
| 0 | 251 | 1-byte integer |
| 251 | 216 | 0xFC + 2-byte integer |
| 216 | 224 | 0xFD + 3-byte integer |
| 224 | 264 | 0xFE + 8-byte integer |
| 251 | 2^16 | 0xFC + 2-byte integer |
| 2^16 | 2^24 | 0xFD + 3-byte integer |
| 2^24 | 2^64 | 0xFE + 8-byte integer |

Similarly, to convert a length-encoded integer into its numeric value check the first byte.

Expand Down
6 changes: 3 additions & 3 deletions docs/mysql-protocol/page_protocol_basic_packets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Source: <https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_p

If a MySQL client or server wants to send data, it:

* Splits the data into packets of size 224 bytes
* Splits the data into packets of size 2^24 bytes
* Prepends to each chunk a packet header

# Protocol::Packet
Expand All @@ -27,9 +27,9 @@ See also

# Sending More Than 16Mb

If the payload is larger than or equal to 224-1 bytes the length is set to 224-1 (`ff ff ff`) and a additional packets are sent with the rest of the payload until the payload of a packet is less than 224-1 bytes.
If the payload is larger than or equal to 2^24-1 bytes the length is set to 2^24-1 (`ff ff ff`) and a additional packets are sent with the rest of the payload until the payload of a packet is less than 2^24-1 bytes.

Sending a payload of 16 777 215 (224-1) bytes looks like:
Sending a payload of 16 777 215 (2^24-1) bytes looks like:

ff ff ff 00 ...

Expand Down
Loading