Expand description
MySQL Client/Server Protocol Implementation: https://dev.mysql.com/doc/internals/en/client-server-protocol.html
Modules§
- format
- Protocol Serialization Format Fragments
Structs§
- Auth
More Data - More data sent from server while authentication flow: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthMoreData
- Auth
More Data Response - AuthMoreData or ERR_Packet
- Binary
Resultset Row - Single row in binary protocol representation: https://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html
- Binary
Resultset RowValues - An iterator decoding values from a binary protocol row
- Byte
String - ByteString style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- Capability
Flags - Client/Server Capability Flags: https://dev.mysql.com/doc/internals/en/capability-flags.html#packet-Protocol::CapabilityFlags
- Column
Definition41 - Double
- Double style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- EOFPacket41
- EOF_Packet(4.1 Protocol): https://dev.mysql.com/doc/internals/en/packet-EOF_Packet.html
- EOFPacket41
Format - Format Fragment of EOFPacket41.
- ErrPacket
- ERR_Packet: https://dev.mysql.com/doc/internals/en/packet-ERR_Packet.html
- Float
- Float style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- GenericOK
ErrPacket - OK_Packet or ERR_Packet, with sequence id.
- Handshake
Response41 - Handshake Response(new): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse41
- Handshake
Response320 - Handshake Response(old): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse320
- Handshake
V9 - Handshake V9(old protocol): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
- Handshake
V9Format - Format Fragment for
HandshakeV9 - Handshake
V10Long - Handshake V10(fullset): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
- Handshake
V10Short - Handshake V10(least common payload): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
- Handshake
V10Short Format - Format Fragment for
HandshakeV10Short - Int
- Int style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- Invalid
Column Type Error - Length
Encoded Integer - Length-Encoded Integer Format implementation: https://dev.mysql.com/doc/internals/en/integer.html#length-encoded-integer
- Long
Long - LongLong style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- OKPacket
- OK_Packet: https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
- Packet
Header - The header of all MySQL packets: https://dev.mysql.com/doc/internals/en/mysql-packet.html
- Public
KeyRequest - Request for “public key retrieval” in sha2 authentication: https://dev.mysql.com/doc/internals/en/public-key-retrieval.html
- Query
Command - Quit
Command - Tells to server to close the connection: https://dev.mysql.com/doc/internals/en/com-quit.html
- RawColumn
Definition41 - RawColumn
Definition41 Format - RawEOF
Packet41 - RawEOF
Packet41 Format - RawHandshake
V9 - RawHandshake
V9Format - RawHandshake
V10Short - RawHandshake
V10Short Protocol Format - RawStmt
Prepare Ok - RawStmt
Prepare OkFormat - Resultset
Row - Resultset
Value Decomposer - SSLRequest
- SSL Connection Request: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::SSLRequest
- Short
- Short style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
- Status
Flags - Server Status Flags: https://dev.mysql.com/doc/internals/en/status-flags.html#packet-Protocol::StatusFlags
- Stmt
Close Command - Deallocates a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-close.html
- Stmt
Execute Command - Execute a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-execute.html
- Stmt
Execute Flags - Execution Flags for Prepared Statement: https://dev.mysql.com/doc/internals/en/com-stmt-execute.html
- Stmt
Prepare Command - Creates a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-prepare.html
- Stmt
Prepare Ok - OK Response for Prepared Statement: https://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html
- Stmt
Prepare OkFormat - Format Fragment for
StmtPrepareOk - Stmt
Prepare Result - Statement Prepare OK or Errored
- Stmt
Reset Command - Resets prepared statement data: https://dev.mysql.com/doc/internals/en/com-stmt-reset.html
- Tiny
- Tiny style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
Enums§
- Binary
Resultset41 - Resultset packet in binary protocol
- Column
Type - A Column Type byte: https://dev.mysql.com/doc/internals/en/com-query-response.html#column-type
- Handshake
- Handshake Packet from Server: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
- OKPacket
Capability Extra Data - Capability dependent data in OKPacket.
- Query
Command Response - Resultset41
- Resultset
Value - Stmt
Execute Result - Result of Prepared Statement Execution: https://dev.mysql.com/doc/internals/en/com-stmt-execute-response.html
- Value
- A value in resultset/sql
Traits§
- Async
Receive Packet - A packet that knows how to receive it from server asynchronously.
- Binary
Protocol Value - An value of binary protocol
- Client
Packet - The client-side packet.
- Client
PacketIO - Client Packet(Self) - Server Packet Communication Definition.
- Receive
Packet - A packet that knows how to receive it from server synchronously.
- Value
Format - Binary Protocol Value format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
Functions§
- drop_
packet - Drops single packet(non-blocking op).
- drop_
packet_ sync - Drops single packet(blocking op).
- request
- Blocking communication between client and server.
- request_
async - Non-blocking communication between client and server.
- serialize_
null_ bitmap - Serialize a null bitmap into bytes
- serialize_
value_ types - Serialize value types into bytes
- serialize_
values - Serialize values into bytes
- write_
packet - Writes a packet(non-blocking op).
- write_
packet_ sync - Writes a packet(blocking op).
Type Aliases§
- Handshake
Result - Final packet of Handshake flow