Texte vergleichen

Finde den Unterschied zwischen zwei Textdateien

Live-Editor

Gleiches ausblenden

Zeilenumbruch aus

Ansicht

Vergleichsgenauigkeit

Syntaxhervorhebung

Diffchecker Desktop Der sicherste Weg, Diffchecker zu nutzen. Hol dir die Desktop-App: Deine Diffs verlassen nie deinen Computer!Desktop holen

native_protocol_v5.html-diff

Erstellt vor 3 WochenDiff läuft nie ab

361 Entfernungen

Zeilen
Gesamt
Entfernt

Zeichen
Gesamt
Entfernt

Um diese Funktion weiterhin zu nutzen, aktualisiere auf Diffchecker Pro Preise anzeigen

638 Zeilen

207 Hinzufügungen

Zeilen
Gesamt
Hinzugefügt

Zeichen
Gesamt
Hinzugefügt

Um diese Funktion weiterhin zu nutzen, aktualisiere auf Diffchecker Pro Preise anzeigen

548 Zeilen

<!DOCTYPE html>

<html>

<head>

<title>CQL BINARY PROTOCOL v5</title>

<style>

<title>CQL BINARY PROTOCOL v5</title>

nav ol {

<style>

margin: 0;

nav ol { margin: 0; padding: 0; padding-left: 1em; }

padding: 0;

nav li { list-style: none; }

padding-left: 1em;

nav.top ul { margin: 0; padding: 0; background: #eee; color: black; }

}

nav.top ul li { display: inline-block; }

nav li {

</style>

list-style: none;

}

nav.top ul {

margin: 0;

padding: 0;

background: #eee;

color: black;

}

nav.top ul li {

display: inline-block;

}

</style>

</head>

<body>

<h1>CQL BINARY PROTOCOL v5</h1>

<h2>Table of Contents</h2>

<nav>

<ol>

<li id="toc1">1

<a href="#s1">Overview</a>

</li>

<li id="toc2">2

<a href="#s2">Frame format</a>

<ol>

<li id="toc2.1">2.1

<h1>CQL BINARY PROTOCOL v5</h1>

<h2>Table of Contents</h2>

<nav>

<ol>

<a href="#s1">Overview</a>

</li>

<a href="#s2">Frame format</a>

<ol>

2.1

<a href="#s2.1">Uncompressed Format</a>

</li>

2.2

<li id="toc2.2">2.2

<a href="#s2.2">Compressed Format</a>

</li>

2.3

<li id="toc2.3">2.3

<a href="#s2.3">Protocol Negotiation</a>

<ol>

<li id="toc2.3.1">2.3.1

2.3.1

<a href="#s2.3.1">Initial Handshake</a>

</li>

2.3.2

<li id="toc2.3.2">2.3.2

<a href="#s2.3.2">Compression</a>

</li>

</ol>

</li>

2.4

<li id="toc2.4">2.4

<a href="#s2.4">Frame Payload</a>

<ol>

<li id="toc2.4.1.1">2.4.1.1

<a href="#s2.4.1.1">version</a>

<ol>

<li id="toc2.4.1.2">2.4.1.2

2.4.1.1

<a href="#s2.4.1.2">flags</a>

<a href="#s2.4.1.1">version</a>

<ol>

</li>

2.4.1.2

<li id="toc2.4.1.3">2.4.1.3

<a href="#s2.4.1.2">flags</a>

<a href="#s2.4.1.3">stream</a>

</li>

</li>

2.4.1.3

<a href="#s2.4.1.3">stream</a>

<li id="toc2.4.1.4">2.4.1.4

</li>

<a href="#s2.4.1.4">opcode</a>

2.4.1.4

</li>

<a href="#s2.4.1.4">opcode</a>

</li>

<li id="toc2.4.1.5">2.4.1.5

<a href="#s2.4.1.5">length</a>

2.4.1.5

<a href="#s2.4.1.5">length</a>

</li>

</ol>

</li>

</ol>

</li>

</ol>

</li>

</ol>

</li>

</ol>

</li>

<li id="toc3">3

<a href="#s3">Notations</a>

</li>

<li id="toc4">4

<a href="#s4">Messages</a>

<ol>

4.1

<li id="toc4.1">4.1

<a href="#s4.1">Requests</a>

<ol>

<li id="toc4.1.1">4.1.1

4.1.1

<a href="#s4.1.1">STARTUP</a>

</li>

4.1.2

<li id="toc4.1.2">4.1.2

<a href="#s4.1.2">AUTH_RESPONSE</a>

</li>

</li>

4.1.3

<a href="#s4.1.3">OPTIONS</a>

<li id="toc4.1.3">4.1.3

</li>

<a href="#s4.1.3">OPTIONS</a>

4.1.4

</li>

<a href="#s4.1.4">QUERY</a>

</li>

<li id="toc4.1.4">4.1.4

<a href="#s4.1.4">QUERY</a>

4.1.5

<a href="#s4.1.5">PREPARE</a>

</li>

<li id="toc4.1.5">4.1.5

4.1.6

<a href="#s4.1.5">PREPARE</a>

<a href="#s4.1.6">EXECUTE</a>

</li>

4.1.7

<li id="toc4.1.6">4.1.6

<a href="#s4.1.7">BATCH</a>

<a href="#s4.1.6">EXECUTE</a>

</li>

</li>

4.1.8

<a href="#s4.1.8">REGISTER</a>

<li id="toc4.1.7">4.1.7

</li>

<a href="#s4.1.7">BATCH</a>

</li>

<li id="toc4.1.8">4.1.8

<a href="#s4.1.8">REGISTER</a>

</li>

</ol>

</li>

4.2

<li id="toc4.2">4.2

<a href="#s4.2">Responses</a>

<ol>

<li id="toc4.2.1">4.2.1

<a href="#s4.2.1">ERROR</a>

</li>

<li id="toc4.2.2">4.2.2

<a href="#s4.2.2">READY</a>

</li>

<li id="toc4.2.3">4.2.3

<a href="#s4.2.3">AUTHENTICATE</a>

</li>

<li id="toc4.2.4">4.2.4

<a href="#s4.2.4">SUPPORTED</a>

</li>

<li id="toc4.2.5">4.2.5

<a href="#s4.2.5">RESULT</a>

<ol>

<li id="toc4.2.5.1">4.2.5.1

4.2.1

<a href="#s4.2.1">ERROR</a>

</li>

4.2.2

<li id="toc4.2.5.2">4.2.5.2

<a href="#s4.2.2">READY</a>

</li>

</li>

4.2.3

<a href="#s4.2.3">AUTHENTICATE</a>

<li id="toc4.2.5.3">4.2.5.3

</li>

<a href="#s4.2.5.3">Set_keyspace</a>

4.2.4

</li>

<a href="#s4.2.4">SUPPORTED</a>

</li>

<li id="toc4.2.5.4">4.2.5.4

<a href="#s4.2.5.4">Prepared</a>

4.2.5

<a href="#s4.2.5">RESULT</a>

</li>

<ol>

<li id="toc4.2.5.5">4.2.5.5

4.2.5.1

<a href="#s4.2.5.5">Schema_change</a>

</li>

4.2.5.2

</ol>

</li>

</li>

4.2.5.3

<a href="#s4.2.5.3">Set_keyspace</a>

<li id="toc4.2.6">4.2.6

</li>

<a href="#s4.2.6">EVENT</a>

4.2.5.4

</li>

<a href="#s4.2.5.4">Prepared</a>

</li>

<li id="toc4.2.7">4.2.7

<a href="#s4.2.7">AUTH_CHALLENGE</a>

4.2.5.5

<a href="#s4.2.5.5">Schema_change</a>

</li>

</ol>

<li id="toc4.2.8">4.2.8

</li>

<a href="#s4.2.8">AUTH_SUCCESS</a>

4.2.6

</li>

<a href="#s4.2.6">EVENT</a>

</li>

</ol>

4.2.7

<a href="#s4.2.7">AUTH_CHALLENGE</a>

</li>

4.2.8

</ol>

<a href="#s4.2.8">AUTH_SUCCESS</a>

</li>

<li id="toc5">5

<a href="#s5">Data Type Serialization Formats</a>

</li>

<li id="toc6">6

<a href="#s6">User Defined Type Serialization</a>

</li>

<li id="toc7">7

<a href="#s7">Result paging</a>

</li>

<li id="toc8">8

<a href="#s8">Error codes</a>

</li>

<li id="toc9">9

<a href="#s9">Changes from v4</a>

</li>

</ol>

</nav>

</li>

</ol>

</li>

<h2 id="s1">1 Overview</h2>

<a href="#s5">Data Type Serialization Formats</a>

<pre> The CQL binary protocol is a frame based protocol with frames comprising a header, payload

</li>

<a href="#s6">User Defined Type Serialization</a>

</li>

<a href="#s7">Result paging</a>

</li>

<a href="#s8">Error codes</a>

</li>

<a href="#s9">Changes from v4</a>

</li>

</ol>

</nav>

<h2 id="s1">1 Overview</h2>

<pre> The CQL binary protocol is a frame based protocol with frames comprising a header, payload

and trailer. In v5 there are two distinct frame formats, compressed and uncompressed and in

both cases the payload is a stream of CQL envelopes (<a href="#s2.4">Section 2.4</a>). Each envelope contains

a single CQL message, along with a metadata header. In effect, the framing format is a

simple wrapper around protocol v5.

In either format, a frame may or may not be self contained. If self contained, then the

payload includes one or more complete envelopes and can be fully processed immediately.

Otherwise, the payload contains some part of a large envelope, which has been split into

its own sequence of frames. These are expected to be transmitted/received in order, so

the receiver can accumulate them as they arrive and process them once all have been received.

The frame header contains length information for the payload, a flag to indicate whether

or not the frame is self contained and a CRC24 to assert the integrity of the header itself.

There are slight variations in the header format between the compressed and uncompressed

variants.

The payload is opaque as far as the framing format is concerned, modulo the self

contained variation.

The trailer contains a CRC32 to protect the integrity of the payload, covering all envelopes

(whole or partial) contained therein.

All the integers in the v5 framing format are little-endian.

</pre>

<h2 id="s2">2 Frame Format</h2>

<h3 id="s2.1">2.1 Uncompressed Format</h3>

<pre> The uncompressed variant uses a 6 byte header. The first 3 bytes contain payload length and

<h3 id="s2.1">2.1 Uncompressed Format</h3>

<pre> The uncompressed variant uses a 6 byte header. The first 3 bytes contain payload length and

self contained flag. The following 3 bytes contain the CRC24 for the header itself.

The max size for the payload is 128KiB, and is followed by its CRC32.

The first 3 bytes of the header represent a single unsigned little-endian integer. The self

contained flag is the 17th bit of that decoded integer.

1. Payload length (17 bits)

2. isSelfContained flag (1 bit)

3. Header padding (6 bits)

4. CRC24 of the header (24 bits)

5. Payload (up to 2 ^ 17 - 1 bytes)

6. Payload CRC32 (32 bits)

0 1 2 3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

| Payload Length |C| |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

CRC24 of Header | |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +

| |

+ +

| Payload |

+ +

| |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

| CRC32 of Payload |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The headed padding can be discarded.

The CRC24 of the header is calculated by initializing the CRC24 algorithm

with the value 0x875060 and using the polynomial 0x1974F0B.

</pre>

<h3 id="s2.2">2.2 LZ4 Compressed Format</h3>

<pre> The variant with LZ4 compression uses an 8 byte header. The first 4 bytes contain

an unsigned integer (little endian) containing the compressed and uncompressed

lengths of the payload and the self contained flag. The remaining 4 bytes are an

unsigned integer (little endian) representing the CRC24 for the header.

As with uncompressed frames, the max payload size is 128KiB and is followed

by a CRC32 trailer. This is the CRC of the compressed payload.

1. Compressed length (17 bits)

2. Uncompressed length (17 bits)

3. isSelfContained flag (1 bit)

4. Header padding (5 bits)

5. CRC24 of Header contents (24 bits)

6. Compressed Payload (up to 2 ^ 17 - 1 bits)

7. CRC32 of Compressed Payload (32 bits)

0 1 2 3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

| Compressed Length | Uncompressed Length

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

|C| | CRC24 of Header |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

| |

+ +

| Compressed Payload |

+ +

| |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

| CRC32 of Compressed Payload |

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The header padding can be discarded.

An uncompressed length of 0 signals that the compressed payload

should be used as-is and not decompressed.

The CRC24 of the header is calculated with the same parameters as for

the uncompressed format (<a href="#s2.1">Section 2.1</a>).

</pre>

<h3 id="s2.3">2.3 Protocol Negotiation</h3>

<h4 id="s2.3.1">2.3.1 Initial Handshake</h4>

<pre> In order to support both v5 and earlier formats, the v5 framing format is not

<h4 id="s2.3.1">2.3.1 Initial Handshake</h4>

<pre> In order to support both v5 and earlier formats, the v5 framing format is not

applied to message exchanges before an initial handshake is completed. Practically,

this means that the initial STARTUP message and any OPTIONS messages which precede

it are expected to be unframed. Likewise, the responses returned by the server,

SUPPORTED in response to OPTIONS and either READY or AUTHENTICATE in response to

STARTUP are transmitted unframed.

After sending the READY or AUTHENTICATE response to a STARTUP message, the server

will begin encoding and decoding all further transmissions according to the protocol

version of that STARTUP message. Compression of the frames is dictated by the

COMPRESSION option sent in the STARTUP message. Only LZ4 compression is currently

supported for v5.

Note: OPTIONS requests may be sent by the client at any time in the connection

lifecycle, both before and after the STARTUP exchange. As mentioned, those

transmitted before STARTUP, as well as the SUPPORTED responses the server returns

are unframed. Any OPTIONS/SUPPORTED exchanges after the STARTUP handshake are

formatted according to the negotiated protocol version, so for v5 these must be

framed.

</pre>

<h4 id="s2.3.2">2.3.2 Compression</h4>

<pre> Before being used, client and server must agree on a compression algorithm to

use, which is done in the STARTUP message. As a consequence, a STARTUP message

must never be compressed. However, once the STARTUP frame has been received

by the server, messages can be compressed (including the response to the STARTUP

request). Frames do not have to be compressed, however, even if compression has

been agreed upon (a sender may only compress frames above a certain size at its

discretion). Where compression has been agreed, the sender signals that the payload

is not compressed by setting the compressed length to 0.

As of v5 of the protocol, the only compression available is lz4

(<a href="https://code.google.com/p/lz4/">https://code.google.com/p/lz4/</a>).

</pre>

<h3 id="s2.4">2.4 Frame Payload</h3>

<pre> Envelopes are defined as:

0 8 16 24 32 40

+---------+---------+---------+---------+---------+

+---------+---------+---------+---------+---------+

| length |

+---------+---------+---------+---------+

| |

. ... body ... .

. .

+----------------------------------------

All values in an envelope are big-endian (network byte order).

Each envelope contains a fixed size header (9 bytes) followed by a variable size

body. The content of the body depends

on the header opcode value (the body can in particular be empty for some

opcode values). The list of allowed opcodes is defined in <a href="#s2.4.1.4">Section 2.4.1.4</a> and the

details of each corresponding message are described <a href="#s4">Section 4</a>.

The protocol distinguishes two types of envelope: requests and responses. Requests

are those envelopes sent by the client to the server. Responses are those envelopes sent

by the server to the client. Note, however, that the protocol supports server pushes

(events) so a response does not necessarily come right after a client request.

Note to client implementors: client libraries should always assume that the

body of a given envelope may contain more data than what is described in this

document. It will however always be safe to ignore the remainder of the body

in such cases. The reason is that this may enable extending the protocol

with optional features without needing to change the protocol version.

Envelope headers are designed to support backwards compatibility with earlier

protocol versions. For that reason, they include an unused leading byte in place

of the version field from previous protocol versions. This was always to some extent

redundant as the version is set and enforced at the connection level. It was also

previously possible to enable compression for an individual envelope. This is no

longer possible, as the framing format is responsible for compression, which is set for

the lifetime of a connection and applies to all messages transmitted throughout it

(see <a href="#s2.2">Section 2.2</a> for caveats). The compression flag is therefore deprecated and

ignored in protocol v5.

</pre>

<h5 id="s2.4.1.1">2.4.1.1 version</h5>

<pre> The version is a single byte that indicates both the direction of the message

(request or response) and the version of the protocol in use. The most

significant bit of version is used to define the direction of the message:

0 indicates a request, 1 indicates a response. This can be useful for protocol

analyzers to distinguish the nature of the packet from the direction in which

it is moving. The rest of that byte is the protocol version (5 for the protocol

defined in this document). In other words, for this version of the protocol,

version will be one of:

0x05 Request frame for this protocol version

0x85 Response frame for this protocol version

Please note that while every message ships with the version, only one version

of messages is accepted on a given connection. In other words, the first message

exchanged (STARTUP) sets the version for the connection for the lifetime of this

connection.

This document describes version 5 of the protocol. For the changes made since

version 4, see <a href="#s9">Section 9</a>.

</pre>

<h5 id="s2.4.1.2">2.4.1.2 flags</h5>

<pre> Flags applying to this envelope. The flags have the following meaning (described

by the mask that allows selecting them):

0x01: Compression flag. In protocol v5 this flag is deprecated and ignored.

0x02: Tracing flag. For a request, this indicates the client requires tracing

of the request. Note that only QUERY, PREPARE and EXECUTE queries

support tracing. Other requests will simply ignore the tracing flag if

set. If a request supports tracing and the tracing flag is set, the

response to this request will have the tracing flag set and contain

tracing information.

If a response has the tracing flag set, its body contains a tracing ID.

The tracing ID is a [uuid] and is the first thing in the body.

0x04: Custom payload flag. For a request or response, this indicates that a

generic key-value custom payload for a custom QueryHandler implementation

is present. Such a custom payload is simply ignored by the default

QueryHandler implementation. Currently, only QUERY, PREPARE, EXECUTE and

BATCH requests support custom payloads.

Type of custom payload is [bytes map] (see below). If either or both

of the tracing and warning flags are set, the custom payload will follow

those indicated elements in the body. If neither are set, the custom

payload will be the first value in the body.

0x08: Warning flag. The response contains warnings which were generated by the

server to go along with this response.

If a response has the warning flag set, its body will contain the text of

the warnings. The warnings are a [string list] and will be the first value

in the body if the tracing flag is not set, or directly after the tracing

ID if it is.

0x10: Use beta flag. Indicates that the client opts in to use protocol version

that is currently in beta. Server will respond with ERROR if protocol

version is marked as beta on server and client does not provide this flag.

The rest of flags is currently unused and ignored.

</pre>

<h5 id="s2.4.1.3">2.4.1.3 stream</h5>

<pre> An envelope has a stream id (a [short] value). When sending request messages, this

stream id must be set by the client to a non-negative value (negative stream id

are reserved for streams initiated by the server; currently all EVENT messages

(<a href="#s4.2.6">section 4.2.6</a>) have a streamId of -1). If a client sends a request message

with the stream id X, it is guaranteed that the stream id of the response to

that message will be X.

This helps to enable the asynchronous nature of the protocol. If a client

sends multiple messages simultaneously (without waiting for responses), there

is no guarantee on the order of the responses. For instance, if the client

writes REQ_1, REQ_2, REQ_3 on the wire (in that order), the server might

respond to REQ_3 (or REQ_2) first. Assigning different stream ids to these 3

requests allows the client to distinguish to which request a received answer

responds to. As there can only be 32768 different simultaneous streams, it is up

to the client to reuse stream id.

Note that clients are free to use the protocol synchronously (i.e. wait for

the response to REQ_N before sending REQ_N+1). In that case, the stream id

can be safely set to 0 as long as each frame contains only a single envelope.

Clients should also feel free to use only a subset of the 32768 maximum possible stream

ids if it is simpler for its implementation.

</pre>

<h5 id="s2.4.1.4">2.4.1.4 opcode</h5>

<pre> An integer byte that distinguishes the actual message:

0x00 ERROR

0x01 STARTUP

0x02 READY

0x03 AUTHENTICATE

0x05 OPTIONS

0x06 SUPPORTED

0x07 QUERY

0x08 RESULT

0x09 PREPARE

0x0A EXECUTE

0x0B REGISTER

0x0C EVENT

0x0D BATCH

0x0E AUTH_CHALLENGE

0x0F AUTH_RESPONSE

0x10 AUTH_SUCCESS

Messages are described in <a href="#s4">Section 4</a>.

(Note that there is no 0x04 message in this version of the protocol)

</pre>

<h5 id="s2.4.1.5">2.4.1.5 length</h5>

<pre> A 4 byte integer representing the length of the body of the envelope (note:

currently an envelope body is limited to 256MB in length).

</pre>

<h2 id="s3">3 Notations</h2>

<pre> To describe the layout of the envelope body for the messages in <a href="#s4">Section 4</a>, we

define the following:

[int] A 4 bytes integer

[long] A 8 bytes integer

[byte] A 1 byte unsigned integer

[short] A 2 bytes unsigned integer

[string] A [short] n, followed by n bytes representing an UTF-8

string.

[long string] An [int] n, followed by n bytes representing an UTF-8 string.

[uuid] A 16 bytes long uuid.

[string list] A [short] n, followed by n [string].

[bytes] A [int] n, followed by n bytes if n >= 0. If n < 0,

no byte should follow and the value represented is `null`.

[value] A [int] n, followed by n bytes if n >= 0.

If n == -1 no byte should follow and the value represented is `null`.

If n == -2 no byte should follow and the value represented is

`not set` not resulting in any change to the existing value.

n < -2 is an invalid value and results in an error.

[short bytes] A [short] n, followed by n bytes if n >= 0.

[unsigned vint] An unsigned variable length integer. A vint is encoded with the most significant byte (MSB) first.

The most significant byte will contains the information about how many extra bytes need to be read

as well as the most significant bits of the integer.

The number of extra bytes to read is encoded as 1 bits on the left side.

For example, if we need to read 2 more bytes the first byte will start with 110

(e.g. 256 000 will be encoded on 3 bytes as [110]00011 11101000 00000000)

If the encoded integer is 8 bytes long the vint will be encoded on 9 bytes and the first

byte will be: 11111111

[vint] A signed variable length integer. This is encoded using zig-zag encoding and then sent

like an [unsigned vint]. Zig-zag encoding converts numbers as follows:

0 = 0, -1 = 1, 1 = 2, -2 = 3, 2 = 4, -3 = 5, 3 = 6 and so forth.

The purpose is to send small negative values as small unsigned values, so that we save bytes on the wire.

To encode a value n use "(n >> 31) ^ (n << 1)" for 32 bit values, and "(n >> 63) ^ (n << 1)"

for 64 bit values where "^" is the xor operation, "<<" is the left shift operation and ">>" is

the arithmetic right shift operation (highest-order bit is replicated).

Decode with "(n >> 1) ^ -(n & 1)".

[option] A pair of <id><value> where <id> is a [short] representing

the option id and <value> depends on that option (and can be

of size 0). The supported id (and the corresp

Gespeicherte Diffs

Originaltext

Datei öffnen

<!DOCTYPE html>
<html>
<head>
    <title>CQL BINARY PROTOCOL v5</title>
    <style>
        nav ol {
            margin: 0;
            padding: 0;
            padding-left: 1em;
        }
        nav li {
            list-style: none;
        }
        nav.top ul {
            margin: 0;
            padding: 0;
            background: #eee;
            color: black;
        }
        nav.top ul li {
            display: inline-block;
        }
    </style>
</head>
<body>

<h1>CQL BINARY PROTOCOL v5</h1>
    <h2>Table of Contents</h2>
        <nav>
            <ol>
                
        <li id="toc1">1
            <a href="#s1">Overview</a>
        
        </li>
    
        <li id="toc2">2
            <a href="#s2">Frame format</a>
        
            <ol>
                
        <li id="toc2.1">2.1
            <a href="#s2.1">Uncompressed Format</a>
        
        </li>
    
        <li id="toc2.2">2.2
            <a href="#s2.2">Compressed Format</a>
        
        </li>
    
        <li id="toc2.3">2.3
            <a href="#s2.3">Protocol Negotiation</a>
        
            <ol>
                
        <li id="toc2.3.1">2.3.1
            <a href="#s2.3.1">Initial Handshake</a>
        
        </li>
    
        <li id="toc2.3.2">2.3.2
            <a href="#s2.3.2">Compression</a>
        
        </li>

</ol>
        
        </li>
    
        <li id="toc2.4">2.4
            <a href="#s2.4">Frame Payload</a>
        
            <ol>
                
        <li id="toc2.4.1.1">2.4.1.1
            <a href="#s2.4.1.1">version</a>
        
            <ol>
                
        <li id="toc2.4.1.2">2.4.1.2
            <a href="#s2.4.1.2">flags</a>
        
        </li>
    
        <li id="toc2.4.1.3">2.4.1.3
            <a href="#s2.4.1.3">stream</a>
        
        </li>
    
        <li id="toc2.4.1.4">2.4.1.4
            <a href="#s2.4.1.4">opcode</a>
        
        </li>
    
        <li id="toc2.4.1.5">2.4.1.5
            <a href="#s2.4.1.5">length</a>
        
        </li>

</ol>
        
        </li>

</ol>
        
        </li>
    
        <li id="toc3">3
            <a href="#s3">Notations</a>
        
        </li>
    
        <li id="toc4">4
            <a href="#s4">Messages</a>
        
            <ol>
                
        <li id="toc4.1">4.1
            <a href="#s4.1">Requests</a>
        
            <ol>
                
        <li id="toc4.1.1">4.1.1
            <a href="#s4.1.1">STARTUP</a>
        
        </li>
    
        <li id="toc4.1.2">4.1.2
            <a href="#s4.1.2">AUTH_RESPONSE</a>
        
        </li>
    
        <li id="toc4.1.3">4.1.3
            <a href="#s4.1.3">OPTIONS</a>
        
        </li>
    
        <li id="toc4.1.4">4.1.4
            <a href="#s4.1.4">QUERY</a>
        
        </li>
    
        <li id="toc4.1.5">4.1.5
            <a href="#s4.1.5">PREPARE</a>
        
        </li>
    
        <li id="toc4.1.6">4.1.6
            <a href="#s4.1.6">EXECUTE</a>
        
        </li>
    
        <li id="toc4.1.7">4.1.7
            <a href="#s4.1.7">BATCH</a>
        
        </li>
    
        <li id="toc4.1.8">4.1.8
            <a href="#s4.1.8">REGISTER</a>
        
        </li>

</ol>
        
        </li>
    
        <li id="toc4.2">4.2
            <a href="#s4.2">Responses</a>
        
            <ol>
                
        <li id="toc4.2.1">4.2.1
            <a href="#s4.2.1">ERROR</a>
        
        </li>
    
        <li id="toc4.2.2">4.2.2
            <a href="#s4.2.2">READY</a>
        
        </li>
    
        <li id="toc4.2.3">4.2.3
            <a href="#s4.2.3">AUTHENTICATE</a>
        
        </li>
    
        <li id="toc4.2.4">4.2.4
            <a href="#s4.2.4">SUPPORTED</a>
        
        </li>
    
        <li id="toc4.2.5">4.2.5
            <a href="#s4.2.5">RESULT</a>
        
            <ol>
                
        <li id="toc4.2.5.1">4.2.5.1
            <a href="#s4.2.5.1">Void</a>
        
        </li>
    
        <li id="toc4.2.5.2">4.2.5.2
            <a href="#s4.2.5.2">Rows</a>
        
        </li>
    
        <li id="toc4.2.5.3">4.2.5.3
            <a href="#s4.2.5.3">Set_keyspace</a>
        
        </li>
    
        <li id="toc4.2.5.4">4.2.5.4
            <a href="#s4.2.5.4">Prepared</a>
        
        </li>
    
        <li id="toc4.2.5.5">4.2.5.5
            <a href="#s4.2.5.5">Schema_change</a>
        
        </li>

</ol>
        
        </li>
    
        <li id="toc4.2.6">4.2.6
            <a href="#s4.2.6">EVENT</a>
        
        </li>
    
        <li id="toc4.2.7">4.2.7
            <a href="#s4.2.7">AUTH_CHALLENGE</a>
        
        </li>
    
        <li id="toc4.2.8">4.2.8
            <a href="#s4.2.8">AUTH_SUCCESS</a>
        
        </li>

</ol>
        
        </li>

</ol>
        
        </li>
    
        <li id="toc5">5
            <a href="#s5">Data Type Serialization Formats</a>
        
        </li>
    
        <li id="toc6">6
            <a href="#s6">User Defined Type Serialization</a>
        
        </li>
    
        <li id="toc7">7
            <a href="#s7">Result paging</a>
        
        </li>
    
        <li id="toc8">8
            <a href="#s8">Error codes</a>
        
        </li>
    
        <li id="toc9">9
            <a href="#s9">Changes from v4</a>
        
        </li>

</ol>
        </nav>
    
        <h2 id="s"> </h2>
        <pre></pre>
    
        <h2 id="s1">1 Overview</h2>
        <pre>  The CQL binary protocol is a frame based protocol with frames comprising a header, payload
  and trailer. In v5 there are two distinct frame formats, compressed and uncompressed and in
  both cases the payload is a stream of CQL envelopes (<a href="#s2.4">Section 2.4</a>). Each envelope contains
  a single CQL message, along with a metadata header. In effect, the framing format is a
  simple wrapper around protocol v5.

In either format, a frame may or may not be self contained. If self contained, then the
  payload includes one or more complete envelopes and can be fully processed immediately.
  Otherwise, the payload contains some part of a large envelope, which has been split into
  its own sequence of frames. These are expected to be transmitted/received in order, so
  the receiver can accumulate them as they arrive and process them once all have been received.

The frame header contains length information for the payload, a flag to indicate whether
  or not the frame is self contained and a CRC24 to assert the integrity of the header itself.
  There are slight variations in the header format between the compressed and uncompressed
  variants.

The payload is opaque as far as the framing format is concerned, modulo the self
  contained variation.

The trailer contains a CRC32 to protect the integrity of the payload, covering all envelopes
  (whole or partial) contained therein.

All the integers in the v5 framing format are little-endian.
</pre>
    
        <h2 id="s2">2 Frame Format</h2>
        <pre></pre>
    
        <h3 id="s2.1">2.1 Uncompressed Format</h3>
        <pre>  The uncompressed variant uses a 6 byte header. The first 3 bytes contain payload length and
  self contained flag. The following 3 bytes contain the CRC24 for the header itself.
  The max size for the payload is 128KiB, and is followed by its CRC32.

The first 3 bytes of the header represent a single unsigned little-endian integer. The self
  contained flag is the 17th bit of that decoded integer.

1. Payload length               (17 bits)
  2. isSelfContained flag         (1 bit)
  3. Header padding               (6 bits)
  4. CRC24 of the header          (24 bits)
  5. Payload                      (up to 2 ^ 17 - 1 bytes)
  6. Payload CRC32                (32 bits)

0                   1                   2                   3
  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |          Payload Length         |C|           |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
            CRC24 of Header       |                               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
  |                                                               |
  +                                                               +
  |                            Payload                            |
  +                                                               +
  |                                                               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                        CRC32 of Payload                       |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The headed padding can be discarded.

The CRC24 of the header is calculated by initializing the CRC24 algorithm
  with the value 0x875060 and using the polynomial 0x1974F0B.
</pre>
    
        <h3 id="s2.2">2.2 LZ4 Compressed Format</h3>
        <pre>  The variant with LZ4 compression uses an 8 byte header. The first 4 bytes contain
  an unsigned integer (little endian) containing the compressed and uncompressed
  lengths of the payload and the self contained flag. The remaining 4 bytes are an
  unsigned integer (little endian) representing the CRC24 for the header.
  As with uncompressed frames, the max payload size is 128KiB and is followed
  by a CRC32 trailer. This is the CRC of the compressed payload.

1. Compressed length            (17 bits)
  2. Uncompressed length          (17 bits)
  3. isSelfContained flag         (1 bit)
  4. Header padding               (5 bits)
  5. CRC24 of Header contents     (24 bits)
  6. Compressed Payload           (up to 2 ^ 17 - 1 bits)
  7. CRC32 of Compressed Payload  (32 bits)

0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |        Compressed Length        |     Uncompressed Length
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |C|         |                 CRC24 of Header               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                                                               |
  +                                                               +
  |                      Compressed Payload                       |
  +                                                               +
  |                                                               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                  CRC32 of Compressed Payload                  |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The header padding can be discarded.

An uncompressed length of 0 signals that the compressed payload
  should be used as-is and not decompressed.

The CRC24 of the header is calculated with the same parameters as for
  the uncompressed format (<a href="#s2.1">Section 2.1</a>).
</pre>
    
        <h3 id="s2.3">2.3 Protocol Negotiation</h3>
        <pre></pre>
    
        <h4 id="s2.3.1">2.3.1 Initial Handshake</h4>
        <pre>  In order to support both v5 and earlier formats, the v5 framing format is not
  applied to message exchanges before an initial handshake is completed. Practically,
  this means that the initial STARTUP message and any OPTIONS messages which precede
  it are expected to be unframed. Likewise, the responses returned by the server,
  SUPPORTED in response to OPTIONS and either READY or AUTHENTICATE in response to
  STARTUP are transmitted unframed.

After sending the READY or AUTHENTICATE response to a STARTUP message, the server
  will begin encoding and decoding all further transmissions according to the protocol
  version of that STARTUP message. Compression of the frames is dictated by the
  COMPRESSION option sent in the STARTUP message. Only LZ4 compression is currently
  supported for v5.

Note: OPTIONS requests may be sent by the client at any time in the connection
  lifecycle, both before and after the STARTUP exchange. As mentioned, those
  transmitted before STARTUP, as well as the SUPPORTED responses the server returns
  are unframed. Any OPTIONS/SUPPORTED exchanges after the STARTUP handshake are
  formatted according to the negotiated protocol version, so for v5 these must be
  framed.
</pre>
    
        <h4 id="s2.3.2">2.3.2 Compression</h4>
        <pre>  Before being used, client and server must agree on a compression algorithm to
  use, which is done in the STARTUP message. As a consequence, a STARTUP message
  must never be compressed.  However, once the STARTUP frame has been received
  by the server, messages can be compressed (including the response to the STARTUP
  request). Frames do not have to be compressed, however, even if compression has
  been agreed upon (a sender may only compress frames above a certain size at its
  discretion). Where compression has been agreed, the sender signals that the payload
  is not compressed by setting the compressed length to 0.

As of v5 of the protocol, the only compression available is lz4
  (<a href="https://code.google.com/p/lz4/">https://code.google.com/p/lz4/</a>).

</pre>
    
        <h3 id="s2.4">2.4 Frame Payload</h3>
        <pre>  Envelopes are defined as:

0         8        16        24        32         40
      +---------+---------+---------+---------+---------+
      | version |  flags  |      stream       | opcode  |
      +---------+---------+---------+---------+---------+
      |                length                 |
      +---------+---------+---------+---------+
      |                                       |
      .            ...  body ...              .
      .                                       .
      .                                       .
      +----------------------------------------

All values in an envelope are big-endian (network byte order).

Each envelope contains a fixed size header (9 bytes) followed by a variable size
  body. The content of the body depends
  on the header opcode value (the body can in particular be empty for some
  opcode values). The list of allowed opcodes is defined in <a href="#s2.4.1.4">Section 2.4.1.4</a> and the
  details of each corresponding message are described <a href="#s4">Section 4</a>.

The protocol distinguishes two types of envelope: requests and responses. Requests
  are those envelopes sent by the client to the server. Responses are those envelopes sent
  by the server to the client. Note, however, that the protocol supports server pushes
  (events) so a response does not necessarily come right after a client request.

Note to client implementors: client libraries should always assume that the
  body of a given envelope may contain more data than what is described in this
  document. It will however always be safe to ignore the remainder of the body
  in such cases. The reason is that this may enable extending the protocol
  with optional features without needing to change the protocol version.

Envelope headers are designed to support backwards compatibility with earlier
  protocol versions. For that reason, they include an unused leading byte in place
  of the version field from previous protocol versions. This was always to some extent
  redundant as the version is set and enforced at the connection level. It was also
  previously possible to enable compression for an individual envelope. This is no
  longer possible, as the framing format is responsible for compression, which is set for
  the lifetime of a connection and applies to all messages transmitted throughout it
  (see <a href="#s2.2">Section 2.2</a> for caveats). The compression flag is therefore deprecated and
  ignored in protocol v5.
</pre>
    
        <h5 id="s2.4.1.1">2.4.1.1 version</h5>
        <pre>  The version is a single byte that indicates both the direction of the message
  (request or response) and the version of the protocol in use. The most
  significant bit of version is used to define the direction of the message:
  0 indicates a request, 1 indicates a response. This can be useful for protocol
  analyzers to distinguish the nature of the packet from the direction in which
  it is moving. The rest of that byte is the protocol version (5 for the protocol
  defined in this document). In other words, for this version of the protocol,
  version will be one of:
    0x05    Request frame for this protocol version
    0x85    Response frame for this protocol version

Please note that while every message ships with the version, only one version
  of messages is accepted on a given connection. In other words, the first message
  exchanged (STARTUP) sets the version for the connection for the lifetime of this
  connection.

This document describes version 5 of the protocol. For the changes made since
  version 4, see <a href="#s9">Section 9</a>.
</pre>
    
        <h5 id="s2.4.1.2">2.4.1.2 flags</h5>
        <pre>  Flags applying to this envelope. The flags have the following meaning (described
  by the mask that allows selecting them):
    0x01: Compression flag. In protocol v5 this flag is deprecated and ignored.
    0x02: Tracing flag. For a request, this indicates the client requires tracing
          of the request. Note that only QUERY, PREPARE and EXECUTE queries
          support tracing. Other requests will simply ignore the tracing flag if
          set. If a request supports tracing and the tracing flag is set, the
          response to this request will have the tracing flag set and contain
          tracing information.
          If a response has the tracing flag set, its body contains a tracing ID.
          The tracing ID is a [uuid] and is the first thing in the body.
    0x04: Custom payload flag. For a request or response, this indicates that a
          generic key-value custom payload for a custom QueryHandler implementation
          is present. Such a custom payload is simply ignored by the default
          QueryHandler implementation. Currently, only QUERY, PREPARE, EXECUTE and
          BATCH requests support custom payloads.
          Type of custom payload is [bytes map] (see below). If either or both
          of the tracing and warning flags are set, the custom payload will follow
          those indicated elements in the body. If neither are set, the custom
          payload will be the first value in the body.
    0x08: Warning flag. The response contains warnings which were generated by the
          server to go along with this response.
          If a response has the warning flag set, its body will contain the text of
          the warnings. The warnings are a [string list] and will be the first value
          in the body if the tracing flag is not set, or directly after the tracing
          ID if it is.
    0x10: Use beta flag. Indicates that the client opts in to use protocol version
          that is currently in beta. Server will respond with ERROR if protocol
          version is marked as beta on server and client does not provide this flag.

The rest of flags is currently unused and ignored.
</pre>
    
        <h5 id="s2.4.1.3">2.4.1.3 stream</h5>
        <pre>  An envelope has a stream id (a [short] value). When sending request messages, this
  stream id must be set by the client to a non-negative value (negative stream id
  are reserved for streams initiated by the server; currently all EVENT messages
  (<a href="#s4.2.6">section 4.2.6</a>) have a streamId of -1). If a client sends a request message
  with the stream id X, it is guaranteed that the stream id of the response to
  that message will be X.

This helps to enable the asynchronous nature of the protocol. If a client
  sends multiple messages simultaneously (without waiting for responses), there
  is no guarantee on the order of the responses. For instance, if the client
  writes REQ_1, REQ_2, REQ_3 on the wire (in that order), the server might
  respond to REQ_3 (or REQ_2) first. Assigning different stream ids to these 3
  requests allows the client to distinguish to which request a received answer
  responds to. As there can only be 32768 different simultaneous streams, it is up
  to the client to reuse stream id.

Note that clients are free to use the protocol synchronously (i.e. wait for
  the response to REQ_N before sending REQ_N+1). In that case, the stream id
  can be safely set to 0 as long as each frame contains only a single envelope.
  Clients should also feel free to use only a subset of the 32768 maximum possible stream
  ids if it is simpler for its implementation.
</pre>
    
        <h5 id="s2.4.1.4">2.4.1.4 opcode</h5>
        <pre>  An integer byte that distinguishes the actual message:
    0x00    ERROR
    0x01    STARTUP
    0x02    READY
    0x03    AUTHENTICATE
    0x05    OPTIONS
    0x06    SUPPORTED
    0x07    QUERY
    0x08    RESULT
    0x09    PREPARE
    0x0A    EXECUTE
    0x0B    REGISTER
    0x0C    EVENT
    0x0D    BATCH
    0x0E    AUTH_CHALLENGE
    0x0F    AUTH_RESPONSE
    0x10    AUTH_SUCCESS

Messages are described in <a href="#s4">Section 4</a>.

(Note that there is no 0x04 message in this version of the protocol)
</pre>
    
        <h5 id="s2.4.1.5">2.4.1.5 length</h5>
        <pre>  A 4 byte integer representing the length of the body of the envelope (note:
  currently an envelope body is limited to 256MB in length).

</pre>
    
        <h2 id="s3">3 Notations</h2>
        <pre>  To describe the layout of the envelope body for the messages in <a href="#s4">Section 4</a>, we
  define the following:

[int]             A 4 bytes integer
    [long]            A 8 bytes integer
    [byte]            A 1 byte unsigned integer
    [short]           A 2 bytes unsigned integer
    [string]          A [short] n, followed by n bytes representing an UTF-8
                      string.
    [long string]     An [int] n, followed by n bytes representing an UTF-8 string.
    [uuid]            A 16 bytes long uuid.
    [string list]     A [short] n, followed by n [string].
    [bytes]           A [int] n, followed by n bytes if n &gt;= 0. If n &lt; 0,
                      no byte should follow and the value represented is `null`.
    [value]           A [int] n, followed by n bytes if n &gt;= 0.
                      If n == -1 no byte should follow and the value represented is `null`.
                      If n == -2 no byte should follow and the value represented is
                      `not set` not resulting in any change to the existing value.
                      n &lt; -2 is an invalid value and results in an error.
    [short bytes]     A [short] n, followed by n bytes if n &gt;= 0.

[unsigned vint]   An unsigned variable length integer. A vint is encoded with the most significant byte (MSB) first.
                      The most significant byte will contains the information about how many extra bytes need to be read
                      as well as the most significant bits of the integer.
                      The number of extra bytes to read is encoded as 1 bits on the left side.
                      For example, if we need to read 2 more bytes the first byte will start with 110
                      (e.g. 256 000 will be encoded on 3 bytes as [110]00011 11101000 00000000)
                      If the encoded integer is 8 bytes long the vint will be encoded on 9 bytes and the first
                      byte will be: 11111111

[vint]             A signed variable length integer. This is encoded using zig-zag encoding and then sent
                      like an [unsigned vint]. Zig-zag encoding converts numbers as follows:
                      0 = 0, -1 = 1, 1 = 2, -2 = 3, 2 = 4, -3 = 5, 3 = 6 and so forth.
                      The purpose is to send small negative values as small unsigned values, so that we save bytes on the wire.
                      To encode a value n use &#34;(n &gt;&gt; 31) ^ (n &lt;&lt; 1)&#34; for 32 bit values, and &#34;(n &gt;&gt; 63) ^ (n &lt;&lt; 1)&#34;
                      for 64 bit values where &#34;^&#34; is the xor operation, &#34;&lt;&lt;&#34; is the left shift operation and &#34;&gt;&gt;&#34; is
                      the arithmetic right shift operation (highest-order bit is replicated).
                      Decode with &#34;(n &gt;&gt; 1) ^ -(n &amp; 1)&#34;.

[option]          A pair of &lt;id&gt;&lt;value&gt; where &lt;id&gt; is a [short] representing
                      the option id and &lt;value&gt; depends on that option (and can be
                      of size 0). The supported id (and the corresponding &lt;value&gt;)
                      will be described when this is used.
    [option list]     A [short] n, followed by n [option].
    [inet]            An address (ip and port) to a node. It consists of one
                      [byte] n, that represents the address size, followed by n
                      [byte] representing the IP address (in practice n can only be
                      either 4 (IPv4) or 16 (IPv6)), following by one [int]
                      representing the port.
    [inetaddr]        An IP address (without a port) to a node. It consists of one
                      [byte] n, that represents the address size, followed by n
                      [byte] representing the IP address.
    [consistency]     A consistency level specification. This is a [short]
                      representing a consistency level with the following
                      correspondence:
                        0x0000    ANY
                        0x0001    ONE
                        0x0002    TWO
                        0x0003    THREE
                        0x0004    QUORUM
                        0x0005    ALL
                        0x0006    LOCAL_QUORUM
                        0x0007    EACH_QUORUM
                        0x0008    SERIAL
                        0x0009    LOCAL_SERIAL
                        0x000A    LOCAL_ONE

[string map]      A [short] n, followed by n pair &lt;k&gt;&lt;v&gt; where &lt;k&gt; and &lt;v&gt;
                      are [string].
    [string multimap] A [short] n, followed by n pair &lt;k&gt;&lt;v&gt; where &lt;k&gt; is a
                      [string] and &lt;v&gt; is a [string list].
    [bytes map]       A [short] n, followed by n pair &lt;k&gt;&lt;v&gt; where &lt;k&gt; is a
                      [string] and &lt;v&gt; is a [bytes].

</pre>
    
        <h2 id="s4">4 Messages</h2>
        <pre>  Dependant on the flags specified in the header, the layout of the message body must be:
    [&lt;tracing_id&gt;][&lt;warnings&gt;][&lt;custom_payload&gt;]&lt;message&gt;
  where:
    - &lt;tracing_id&gt; is a UUID tracing ID, present if this is a request message and the Tracing flag is set.
    - &lt;warnings&gt; is a string list of warnings (if this is a request message and the Warning flag is set.
    - &lt;custom_payload&gt; is bytes map for the serialised custom payload present if this is one of the message types
      which support custom payloads (QUERY, PREPARE, EXECUTE and BATCH) and the Custom payload flag is set.
    - &lt;message&gt; as defined below through sections <a href="#s4">4</a> and <a href="#s5">5</a>.
</pre>
    
        <h3 id="s4.1">4.1 Requests</h3>
        <pre>  Note that outside of their normal responses (described below), all requests
  can get an ERROR message (<a href="#s4.2.1">Section 4.2.1</a>) as response.
</pre>
    
        <h4 id="s4.1.1">4.1.1 STARTUP</h4>
        <pre>  Initialize the connection. The server will respond by either a READY message
  (in which case the connection is ready for queries) or an AUTHENTICATE message
  (in which case credentials will need to be provided using AUTH_RESPONSE).

This must be the first message of the connection, except for OPTIONS that can
  be sent before to find out the options supported by the server. Once the
  connection has been initialized, a client should not send any more STARTUP
  messages.

The body is a [string map] of options. Possible options are:
    - &#34;CQL_VERSION&#34;: the version of CQL to use. This option is mandatory and
      currently the only version supported is &#34;3.0.0&#34;. Note that this is
      different from the protocol version.
    - &#34;COMPRESSION&#34;: the compression algorithm to use for frames (See <a href="#s2.3.2">section 2.3.2</a>).
      This is optional; if not specified no compression will be used.
    - &#34;DRIVER_NAME&#34;: allows clients to supply a free-form label representing the driver
      implementation. This is displayed in the output of `nodetool clientstats`
    - &#34;DRIVER_VERSION&#34;: allows clients to supply a free-form label representing the driver
      version. This is displayed in the output of `nodetool clientstats`
    - &#34;THROW_ON_OVERLOAD&#34;: flag to specify server behaviour where the incoming message
      rate is too high. An [string] value of &#34;1&#34; instructs the server to respond with
      and Error when its resources are exhausted. Any other value, or if the the key
      is not present, and the server will apply backpressure to the connection until it
      has cleared its backlog of inbound messages.

As mentioned in <a href="#s2.3">Section 2.3</a>, STARTUP messages must not be sent in the framed format. STARTUP,
  any OPTIONS requests which precede them, as well as the server&#39;s responses to those messages
  must be unframed to support protocol negotiation with older clients.
</pre>
    
        <h4 id="s4.1.2">4.1.2 AUTH_RESPONSE</h4>
        <pre>  Answers a server authentication challenge.

Authentication in the protocol is SASL based. The server sends authentication
  challenges (a bytes token) to which the client answers with this message. Those
  exchanges continue until the server accepts the authentication by sending a
  AUTH_SUCCESS message after a client AUTH_RESPONSE. Note that the exchange
  begins with the client sending an initial AUTH_RESPONSE in response to a
  server AUTHENTICATE request.

The body of this message is a single [bytes] token. The details of what this
  token contains (and when it can be null/empty, if ever) depends on the actual
  authenticator used.

The response to a AUTH_RESPONSE is either a follow-up AUTH_CHALLENGE message,
  an AUTH_SUCCESS message or an ERROR message.

</pre>
    
        <h4 id="s4.1.3">4.1.3 OPTIONS</h4>
        <pre>  Asks the server to return which STARTUP options are supported. The body of an
  OPTIONS message should be empty and the server will respond with a SUPPORTED
  message.

</pre>
    
        <h4 id="s4.1.4">4.1.4 QUERY</h4>
        <pre>  Performs a CQL query. The body of the message must be:
    &lt;query&gt;&lt;query_parameters&gt;
  where &lt;query&gt; is a [long string] representing the query and
  &lt;query_parameters&gt; must be
    &lt;consistency&gt;&lt;flags&gt;[&lt;n&gt;[name_1]&lt;value_1&gt;...[name_n]&lt;value_n&gt;][&lt;result_page_size&gt;][&lt;paging_state&gt;][&lt;serial_consistency&gt;][&lt;timestamp&gt;][&lt;keyspace&gt;][&lt;now_in_seconds&gt;]
  where:
    - &lt;consistency&gt; is the [consistency] level for the operation.
    - &lt;flags&gt; is a [int] whose bits define the options for this query and
      in particular influence what the remainder of the message contains.
      A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x0001: Values. If set, a [short] &lt;n&gt; followed by &lt;n&gt; [value]
                values are provided. Those values are used for bound variables in
                the query. Optionally, if the 0x40 flag is present, each value
                will be preceded by a [string] name, representing the name of
                the marker the value must be bound to.
        0x0002: Skip_metadata. If set, the Result Set returned as a response
                to the query (if any) will have the NO_METADATA flag (see
                <a href="#s4.2.5.2">Section 4.2.5.2</a>).
        0x0004: Page_size. If set, &lt;result_page_size&gt; is an [int]
                controlling the desired page size of the result (in CQL3 rows).
                See the section on paging (<a href="#s7">Section 7</a>) for more details.
        0x0008: With_paging_state. If set, &lt;paging_state&gt; should be present.
                &lt;paging_state&gt; is a [bytes] value that should have been returned
                in a result set (<a href="#s4.2.5.2">Section 4.2.5.2</a>). The query will be
                executed but starting from a given paging state. This is also to
                continue paging on a different node than the one where it
                started (See <a href="#s7">Section 7</a> for more details).
        0x0010: With serial consistency. If set, &lt;serial_consistency&gt; should be
                present. &lt;serial_consistency&gt; is the [consistency] level for the
                serial phase of conditional updates. Consistency can be
                either SERIAL or LOCAL_SERIAL, if not present, it defaults to
                SERIAL. This option will be ignored for anything else other than a
                conditional update/insert.
        0x0020: With default timestamp. If set, &lt;timestamp&gt; must be present.
                &lt;timestamp&gt; is a [long] representing the default timestamp for the query
                in microseconds (negative values are forbidden). This will
                replace the server side assigned timestamp as default timestamp.
                Note that a timestamp in the query itself will still override
                this timestamp. This is entirely optional.
        0x0040: With names for values. This only makes sense if the 0x01 flag is set and
                is ignored otherwise. If present, the values from the 0x01 flag will
                be preceded by a name (see above). Note that this is only useful for
                QUERY requests where named bind markers are used; for EXECUTE statements,
                since the names for the expected values was returned during preparation,
                a client can always provide values in the right order without any names
                and using this flag, while supported, is almost surely inefficient.
        0x0080: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
                [string] indicating the keyspace that the query should be executed in.
                It supersedes the keyspace that the connection is bound to, if any.
        0x0100: With now in seconds. If set, &lt;now_in_seconds&gt; must be present.
                &lt;now_in_seconds&gt; is an [int] representing the current time (now) for
                the query. Affects TTL cell liveness in read queries and local deletion
                time for tombstones and TTL cells in update requests. It&#39;s intended
                for testing purposes and is optional.

Note that the consistency is ignored by some queries (USE, CREATE, ALTER,
  TRUNCATE, ...).

The server will respond to a QUERY message with a RESULT message, the content
  of which depends on the query.

</pre>
    
        <h4 id="s4.1.5">4.1.5 PREPARE</h4>
        <pre>  Prepare a query for later execution (through EXECUTE). The body of the message must be:
    &lt;query&gt;&lt;flags&gt;[&lt;keyspace&gt;]
  where:
    - &lt;query&gt; is a [long string] representing the CQL query.
    - &lt;flags&gt; is a [int] whose bits define the options for this statement and in particular
      influence what the remainder of the message contains.
      A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x01: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
              [string] indicating the keyspace that the query should be executed in.
              It supersedes the keyspace that the connection is bound to, if any.

The server will respond with a RESULT message with a `prepared` kind (0x0004,
  see <a href="#s4.2.5">Section 4.2.5</a>).

</pre>
    
        <h4 id="s4.1.6">4.1.6 EXECUTE</h4>
        <pre>  Executes a prepared query. The body of the message must be:
  &lt;id&gt;&lt;result_metadata_id&gt;&lt;query_parameters&gt;
  where
    - &lt;id&gt; is the prepared query ID. It&#39;s the [short bytes] returned as a
      response to a PREPARE message.
    - &lt;result_metadata_id&gt; is the ID of the result set metadata that was sent
      along with response to PREPARE message. If a RESULT/Rows message reports
      changed result set metadata with the Metadata_changed flag, the reported new
      result set metadata must be used in subsequent executions.
    - &lt;query_parameters&gt; has the exact same definition as in QUERY (see <a href="#s4.1.4">Section 4.1.4</a>).

</pre>
    
        <h4 id="s4.1.7">4.1.7 BATCH</h4>
        <pre>  Allows executing a list of queries (prepared or not) as a batch (note that
  only DML statements are accepted in a batch). The body of the message must
  be:
    &lt;type&gt;&lt;n&gt;&lt;query_1&gt;...&lt;query_n&gt;&lt;consistency&gt;&lt;flags&gt;[&lt;serial_consistency&gt;][&lt;timestamp&gt;][&lt;keyspace&gt;][&lt;now_in_seconds&gt;]
  where:
    - &lt;type&gt; is a [byte] indicating the type of batch to use:
        - If &lt;type&gt; == 0, the batch will be &#34;logged&#34;. This is equivalent to a
          normal CQL3 batch statement.
        - If &lt;type&gt; == 1, the batch will be &#34;unlogged&#34;.
        - If &lt;type&gt; == 2, the batch will be a &#34;counter&#34; batch (and non-counter
          statements will be rejected).
    - &lt;flags&gt; is a [int] whose bits define the options for this query and
      in particular influence what the remainder of the message contains. It is similar
      to the &lt;flags&gt; from QUERY and EXECUTE methods, except that the 4 rightmost
      bits must always be 0 as their corresponding options do not make sense for
      Batch. A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x0010: With serial consistency. If set, &lt;serial_consistency&gt; should be
                present. &lt;serial_consistency&gt; is the [consistency] level for the
                serial phase of conditional updates. Consistency can be
                either SERIAL or LOCAL_SERIAL, if not present, it defaults to
                SERIAL. This option will be ignored for anything else other than a
                conditional update/insert.
        0x0020: With default timestamp. If set, &lt;timestamp&gt; should be present.
                &lt;timestamp&gt; is a [long] representing the default timestamp for the query
                in microseconds. This will replace the server side assigned
                timestamp as default timestamp. Note that a timestamp in the query itself
                will still override this timestamp. This is entirely optional.
        0x0040: With names for values. If set, then all values for all &lt;query_i&gt; must be
                preceded by a [string] &lt;name_i&gt; that have the same meaning as in QUERY
                requests [IMPORTANT NOTE: this feature does not work and should not be
                used. It is specified in a way that makes it impossible for the server
                to implement. This will be fixed in a future version of the native
                protocol. See <a href="https://issues.apache.org/jira/browse/CASSANDRA-10246">https://issues.apache.org/jira/browse/CASSANDRA-10246</a> for
                more details].
        0x0080: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
                [string] indicating the keyspace that the query should be executed in.
                It supersedes the keyspace that the connection is bound to, if any.
        0x0100: With now in seconds. If set, &lt;now_in_seconds&gt; must be present.
                &lt;now_in_seconds&gt; is an [int] representing the current time (now) for
                the query. Affects TTL cell liveness in read queries and local deletion
                time for tombstones and TTL cells in update requests. It&#39;s intended
                for testing purposes and is optional.
    - &lt;n&gt; is a [short] indicating the number of following queries.
    - &lt;query_1&gt;...&lt;query_n&gt; are the queries to execute. A &lt;query_i&gt; must be of the
      form:
        &lt;kind&gt;&lt;string_or_id&gt;&lt;n&gt;[&lt;name_1&gt;]&lt;value_1&gt;...[&lt;name_n&gt;]&lt;value_n&gt;
      where:
       - &lt;kind&gt; is a [byte] indicating whether the following query is a prepared
         one or not. &lt;kind&gt; value must be either 0 or 1.
       - &lt;string_or_id&gt; depends on the value of &lt;kind&gt;. If &lt;kind&gt; == 0, it should be
         a [long string] query string (as in QUERY, the query string might contain
         bind markers). Otherwise (that is, if &lt;kind&gt; == 1), it should be a
         [short bytes] representing a prepared query ID.
       - &lt;n&gt; is a [short] indicating the number (possibly 0) of following values.
       - &lt;name_i&gt; is the optional name of the following &lt;value_i&gt;. It must be present
         if and only if the 0x40 flag is provided for the batch.
       - &lt;value_i&gt; is the [value] to use for bound variable i (of bound variable &lt;name_i&gt;
         if the 0x40 flag is used).
    - &lt;consistency&gt; is the [consistency] level for the operation.
    - &lt;serial_consistency&gt; is only present if the 0x10 flag is set. In that case,
      &lt;serial_consistency&gt; is the [consistency] level for the serial phase of
      conditional updates. Consistency can be either SERIAL or
      LOCAL_SERIAL, if not present, it defaults to SERIAL. This option will
      be ignored for anything else other than a conditional update/insert.

The server will respond with a RESULT message.

</pre>
    
        <h4 id="s4.1.8">4.1.8 REGISTER</h4>
        <pre>  Register this connection to receive some types of events. The body of the
  message is a [string list] representing the event types to register for. See
  <a href="#s4.2.6">section 4.2.6</a> for the list of valid event types.

The response to a REGISTER message will be a READY message.

Please note that if a client driver maintains multiple connections to a
  Cassandra node and/or connections to multiple nodes, it is advised to
  dedicate a handful of connections to receive events, but to *not* register
  for events on all connections, as this would only result in receiving
  multiple times the same event messages, wasting bandwidth.

</pre>
    
        <h3 id="s4.2">4.2 Responses</h3>
        <pre>  This section describes the content of the frame body for the different
  responses. Please note that to make room for future evolution, clients should
  support extra information (that they should simply discard) to the one
  described in this document at the end of the frame body.
</pre>
    
        <h4 id="s4.2.1">4.2.1 ERROR</h4>
        <pre>  Indicates an error processing a request. The body of the message will be an
  error code ([int]) followed by a [string] error message. Then, depending on
  the exception, more content may follow. The error codes are defined in
  <a href="#s8">Section 8</a>, along with their additional content if any.

</pre>
    
        <h4 id="s4.2.2">4.2.2 READY</h4>
        <pre>  Indicates that the server is ready to process queries. This message will be
  sent by the server either after a STARTUP message if no authentication is
  required (if authentication is required, the server indicates readiness by
  sending a AUTH_RESPONSE message).

The body of a READY message is empty.

</pre>
    
        <h4 id="s4.2.3">4.2.3 AUTHENTICATE</h4>
        <pre>  Indicates that the server requires authentication, and which authentication
  mechanism to use.

The authentication is SASL based and thus consists of a number of server
  challenges (AUTH_CHALLENGE, <a href="#s4.2.7">Section 4.2.7</a>) followed by client responses
  (AUTH_RESPONSE, <a href="#s4.1.2">Section 4.1.2</a>). The initial exchange is however bootstrapped
  by an initial client response. The details of that exchange (including how
  many challenge-response pairs are required) are specific to the authenticator
  in use. The exchange ends when the server sends an AUTH_SUCCESS message or
  an ERROR message.

This message will be sent following a STARTUP message if authentication is
  required and must be answered by a AUTH_RESPONSE message from the client.

The body consists of a single [string] indicating the full class name of the
  IAuthenticator in use.

</pre>
    
        <h4 id="s4.2.4">4.2.4 SUPPORTED</h4>
        <pre>  Indicates which startup options are supported by the server. This message
  comes as a response to an OPTIONS message.

The body of a SUPPORTED message is a [string multimap]. This multimap gives
  for each of the supported STARTUP options, the list of supported values. It
  also includes:
      - &#34;PROTOCOL_VERSIONS&#34;: the list of native protocol versions that are
      supported, encoded as the version number followed by a slash and the
      version description. For example: 3/v3, 4/v4, 5/v5-beta. If a version is
      in beta, it will have the word &#34;beta&#34; in its description.

</pre>
    
        <h4 id="s4.2.5">4.2.5 RESULT</h4>
        <pre>  The result to a query (QUERY, PREPARE, EXECUTE or BATCH messages).

The first element of the body of a RESULT message is an [int] representing the
  `kind` of result. The rest of the body depends on the kind. The kind can be
  one of:
    0x0001    Void: for results carrying no information.
    0x0002    Rows: for results to select queries, returning a set of rows.
    0x0003    Set_keyspace: the result to a `use` query.
    0x0004    Prepared: result to a PREPARE message.
    0x0005    Schema_change: the result to a schema altering query.

The body for each kind (after the [int] kind) is defined below.

</pre>
    
        <h5 id="s4.2.5.1">4.2.5.1 Void</h5>
        <pre>  The rest of the body for a Void result is empty. It indicates that a query was
  successful without providing more information.

</pre>
    
        <h5 id="s4.2.5.2">4.2.5.2 Rows</h5>
        <pre>  Indicates a set of rows. The rest of the body of a Rows result is:
    &lt;metadata&gt;&lt;rows_count&gt;&lt;rows_content&gt;
  where:
    - &lt;metadata&gt; is composed of:
        &lt;flags&gt;&lt;columns_count&gt;[&lt;paging_state&gt;][&lt;new_metadata_id&gt;][&lt;global_table_spec&gt;?&lt;col_spec_1&gt;...&lt;col_spec_n&gt;]
      where:
        - &lt;flags&gt; is an [int]. The bits of &lt;flags&gt; provides information on the
          formatting of the remaining information. A flag is set if the bit
          corresponding to its `mask` is set. Supported flags are, given their
          mask:
            0x0001    Global_tables_spec: if set, only one table spec (keyspace
                      and table name) is provided as &lt;global_table_spec&gt;. If not
                      set, &lt;global_table_spec&gt; is not present.
            0x0002    Has_more_pages: indicates whether this is not the last
                      page of results and more should be retrieved. If set, the
                      &lt;paging_state&gt; will be present. The &lt;paging_state&gt; is a
                      [bytes] value that should be used in QUERY/EXECUTE to
                      continue paging and retrieve the remainder of the result for
                      this query (See <a href="#s7">Section 7</a> for more details).
            0x0004    No_metadata: if set, the &lt;metadata&gt; is only composed of
                      these &lt;flags&gt;, the &lt;column_count&gt; and optionally the
                      &lt;paging_state&gt; (depending on the Has_more_pages flag) but
                      no other information (so no &lt;global_table_spec&gt; nor &lt;col_spec_i&gt;).
                      This will only ever be the case if this was requested
                      during the query (see QUERY and RESULT messages).
            0x0008    Metadata_changed: if set, the No_metadata flag has to be unset
                      and &lt;new_metadata_id&gt; has to be supplied. This flag is to be
                      used to avoid a round trip in case of metadata changes for queries
                      that requested metadata to be skipped.
        - &lt;columns_count&gt; is an [int] representing the number of columns selected
          by the query that produced this result. It defines the number of &lt;col_spec_i&gt;
          elements in and the number of elements for each row in &lt;rows_content&gt;.
        - &lt;new_metadata_id&gt; is [short bytes] representing the new, changed result set
           metadata. The new metadata ID must also be used in subsequent executions of
           the corresponding prepared statement, if any.
        - &lt;global_table_spec&gt; is present if the Global_tables_spec is set in
          &lt;flags&gt;. It is composed of two [string] representing the
          (unique) keyspace name and table name the columns belong to.
        - &lt;col_spec_i&gt; specifies the columns returned in the query. There are
          &lt;column_count&gt; such column specifications that are composed of:
            (&lt;ks_name&gt;&lt;table_name&gt;)?&lt;name&gt;&lt;type&gt;
          The initial &lt;ks_name&gt; and &lt;table_name&gt; are two [string] and are only present
          if the Global_tables_spec flag is not set. The &lt;column_name&gt; is a
          [string] and &lt;type&gt; is an [option] that corresponds to the description
          (what this description is depends a bit on the context: in results to
          selects, this will be either the user chosen alias or the selection used
          (often a colum name, but it can be a function call too). In results to
          a PREPARE, this will be either the name of the corresponding bind variable
          or the column name for the variable if it is &#34;anonymous&#34;) and type of
          the corresponding result. The option for &lt;type&gt; is either a native
          type (see below), in which case the option has no value, or a
          &#39;custom&#39; type, in which case the value is a [string] representing
          the fully qualified class name of the type represented. Valid option
          ids are:
            0x0000    Custom: the value is a [string], see above.
            0x0001    Ascii
            0x0002    Bigint
            0x0003    Blob
            0x0004    Boolean
            0x0005    Counter
            0x0006    Decimal
            0x0007    Double
            0x0008    Float
            0x0009    Int
            0x000B    Timestamp
            0x000C    Uuid
            0x000D    Varchar
            0x000E    Varint
            0x000F    Timeuuid
            0x0010    Inet
            0x0011    Date
            0x0012    Time
            0x0013    Smallint
            0x0014    Tinyint
            0x0015    Duration
            0x0020    List: the value is an [option], representing the type
                            of the elements of the list.
            0x0021    Map: the value is two [option], representing the types of the
                           keys and values of the map
            0x0022    Set: the value is an [option], representing the type
                            of the elements of the set
            0x0030    UDT: the value is &lt;ks&gt;&lt;udt_name&gt;&lt;n&gt;&lt;name_1&gt;&lt;type_1&gt;...&lt;name_n&gt;&lt;type_n&gt;
                           where:
                              - &lt;ks&gt; is a [string] representing the keyspace name this
                                UDT is part of.
                              - &lt;udt_name&gt; is a [string] representing the UDT name.
                              - &lt;n&gt; is a [short] representing the number of fields of
                                the UDT, and thus the number of &lt;name_i&gt;&lt;type_i&gt; pairs
                                following
                              - &lt;name_i&gt; is a [string] representing the name of the
                                i_th field of the UDT.
                              - &lt;type_i&gt; is an [option] representing the type of the
                                i_th field of the UDT.
            0x0031    Tuple: the value is &lt;n&gt;&lt;type_1&gt;...&lt;type_n&gt; where &lt;n&gt; is a [short]
                             representing the number of values in the type, and &lt;type_i&gt;
                             are [option] representing the type of the i_th component
                             of the tuple

- &lt;rows_count&gt; is an [int] representing the number of rows present in this
      result. Those rows are serialized in the &lt;rows_content&gt; part.
    - &lt;rows_content&gt; is composed of &lt;row_1&gt;...&lt;row_m&gt; where m is &lt;rows_count&gt;.
      Each &lt;row_i&gt; is composed of &lt;value_1&gt;...&lt;value_n&gt; where n is
      &lt;columns_count&gt; and where &lt;value_j&gt; is a [bytes] representing the value
      returned for the jth column of the ith row. In other words, &lt;rows_content&gt;
      is composed of (&lt;rows_count&gt; * &lt;columns_count&gt;) [bytes].

</pre>
    
        <h5 id="s4.2.5.3">4.2.5.3 Set_keyspace</h5>
        <pre>  The result to a `use` query. The body (after the kind [int]) is a single
  [string] indicating the name of the keyspace that has been set.

</pre>
    
        <h5 id="s4.2.5.4">4.2.5.4 Prepared</h5>
        <pre>  The result to a PREPARE message. The body of a Prepared result is:
    &lt;id&gt;&lt;result_metadata_id&gt;&lt;metadata&gt;&lt;result_metadata&gt;
  where:
    - &lt;id&gt; is [short bytes] representing the prepared query ID.
    - &lt;result_metadata_id&gt; is [short bytes] representing the result set metadata ID.
    - &lt;metadata&gt; is composed of:
        &lt;flags&gt;&lt;columns_count&gt;&lt;pk_count&gt;[&lt;pk_index_1&gt;...&lt;pk_index_n&gt;][&lt;global_table_spec&gt;?&lt;col_spec_1&gt;...&lt;col_spec_n&gt;]
      where:
        - &lt;flags&gt; is an [int]. The bits of &lt;flags&gt; provides information on the
          formatting of the remaining information. A flag is set if the bit
          corresponding to its `mask` is set. Supported masks and their flags
          are:
            0x0001    Global_tables_spec: if set, only one table spec (keyspace
                      and table name) is provided as &lt;global_table_spec&gt;. If not
                      set, &lt;global_table_spec&gt; is not present.
        - &lt;columns_count&gt; is an [int] representing the number of bind markers
          in the prepared statement.  It defines the number of &lt;col_spec_i&gt;
          elements.
        - &lt;pk_count&gt; is an [int] representing the number of &lt;pk_index_i&gt;
          elements to follow. If this value is zero, at least one of the
          partition key columns in the table that the statement acts on
          did not have a corresponding bind marker (or the bind marker
          was wrapped in a function call).
        - &lt;pk_index_i&gt; is a short that represents the index of the bind marker
          that corresponds to the partition key column in position i.
          For example, a &lt;pk_index&gt; sequence of [2, 0, 1] indicates that the
          table has three partition key columns; the full partition key
          can be constructed by creating a composite of the values for
          the bind markers at index 2, at index 0, and at index 1.
          This allows implementations with token-aware routing to correctly
          construct the partition key without needing to inspect table
          metadata.
        - &lt;global_table_spec&gt; is present if the Global_tables_spec is set in
          &lt;flags&gt;. If present, it is composed of two [string]s. The first
          [string] is the name of the keyspace that the statement acts on.
          The second [string] is the name of the table that the columns
          represented by the bind markers belong to.
        - &lt;col_spec_i&gt; specifies the bind markers in the prepared statement.
          There are &lt;column_count&gt; such column specifications, each with the
          following format:
            (&lt;ks_name&gt;&lt;table_name&gt;)?&lt;name&gt;&lt;type&gt;
          The initial &lt;ks_name&gt; and &lt;table_name&gt; are two [string] that are only
          present if the Global_tables_spec flag is not set. The &lt;name&gt; field
          is a [string] that holds the name of the bind marker (if named),
          or the name of the column, field, or expression that the bind marker
          corresponds to (if the bind marker is &#34;anonymous&#34;).  The &lt;type&gt;
          field is an [option] that represents the expected type of values for
          the bind marker.  See the Rows documentation (<a href="#s4.2.5.2">section 4.2.5.2</a>) for
          full details on the &lt;type&gt; field.

- &lt;result_metadata&gt; is defined exactly the same as &lt;metadata&gt; in the Rows
      documentation (<a href="#s4.2.5.2">section 4.2.5.2</a>).  This describes the metadata for the
      result set that will be returned when this prepared statement is executed.
      Note that &lt;result_metadata&gt; may be empty (have the No_metadata flag and
      0 columns, See <a href="#s4.2.5.2">section 4.2.5.2</a>) and will be for any query that is not a
      Select. In fact, there is never a guarantee that this will be non-empty, so
      implementations should protect themselves accordingly. This result metadata
      is an optimization that allows implementations to later execute the
      prepared statement without requesting the metadata (see the Skip_metadata
      flag in EXECUTE).  Clients can safely discard this metadata if they do not
      want to take advantage of that optimization.

Note that the prepared query ID returned is global to the node on which the query
  has been prepared. It can be used on any connection to that node
  until the node is restarted (after which the query must be re-prepared).
</pre>
    
        <h5 id="s4.2.5.5">4.2.5.5 Schema_change</h5>
        <pre>  The result to a schema altering query (creation/update/drop of a
  keyspace/table/index). The body (after the kind [int]) is the same
  as the body for a &#34;SCHEMA_CHANGE&#34; event, so 3 strings:
    &lt;change_type&gt;&lt;target&gt;&lt;options&gt;
  Please refer to <a href="#s4.2.6">section 4.2.6</a> below for the meaning of those fields.

Note that a query to create or drop an index is considered to be a change
  to the table the index is on.

</pre>
    
        <h4 id="s4.2.6">4.2.6 EVENT</h4>
        <pre>  An event pushed by the server. A client will only receive events for the
  types it has REGISTER-ed to. The body of an EVENT message will start with a
  [string] representing the event type. The rest of the message depends on the
  event type. The valid event types are:
    - &#34;TOPOLOGY_CHANGE&#34;: events related to change in the cluster topology.
      Currently, events are sent when new nodes are added to the cluster, and
      when nodes are removed. The body of the message (after the event type)
      consists of a [string] and an [inet], corresponding respectively to the
      type of change (&#34;NEW_NODE&#34; or &#34;REMOVED_NODE&#34;) followed by the address of
      the new/removed node.
    - &#34;STATUS_CHANGE&#34;: events related to change of node status. Currently,
      up/down events are sent. The body of the message (after the event type)
      consists of a [string] and an [inet], corresponding respectively to the
      type of status change (&#34;UP&#34; or &#34;DOWN&#34;) followed by the address of the
      concerned node.
    - &#34;SCHEMA_CHANGE&#34;: events related to schema change. After the event type,
      the rest of the message will be &lt;change_type&gt;&lt;target&gt;&lt;options&gt; where:
        - &lt;change_type&gt; is a [string] representing the type of changed involved.
          It will be one of &#34;CREATED&#34;, &#34;UPDATED&#34; or &#34;DROPPED&#34;.
        - &lt;target&gt; is a [string] that can be one of &#34;KEYSPACE&#34;, &#34;TABLE&#34;, &#34;TYPE&#34;,
          &#34;FUNCTION&#34; or &#34;AGGREGATE&#34; and describes what has been modified
          (&#34;TYPE&#34; stands for modifications related to user types, &#34;FUNCTION&#34;
          for modifications related to user defined functions, &#34;AGGREGATE&#34;
          for modifications related to user defined aggregates).
        - &lt;options&gt; depends on the preceding &lt;target&gt;:
          - If &lt;target&gt; is &#34;KEYSPACE&#34;, then &lt;options&gt; will be a single [string]
            representing the keyspace changed.
          - If &lt;target&gt; is &#34;TABLE&#34; or &#34;TYPE&#34;, then
            &lt;options&gt; will be 2 [string]: the first one will be the keyspace
            containing the affected object, and the second one will be the name
            of said affected object (either the table, user type, function, or
            aggregate name).
          - If &lt;target&gt; is &#34;FUNCTION&#34; or &#34;AGGREGATE&#34;, multiple arguments follow:
            - [string] keyspace containing the user defined function / aggregate
            - [string] the function/aggregate name
            - [string list] one string for each argument type (as CQL type)

All EVENT messages have a streamId of -1 (<a href="#s2.4.1.3">Section 2.4.1.3</a>).

Please note that &#34;NEW_NODE&#34; and &#34;UP&#34; events are sent based on internal Gossip
  communication and as such may be sent a short delay before the binary
  protocol server on the newly up node is fully started. Clients are thus
  advised to wait a short time before trying to connect to the node (1 second
  should be enough), otherwise they may experience a connection refusal at
  first.
</pre>
    
        <h4 id="s4.2.7">4.2.7 AUTH_CHALLENGE</h4>
        <pre>  A server authentication challenge (see AUTH_RESPONSE (<a href="#s4.1.2">Section 4.1.2</a>) for more
  details).

The body of this message is a single [bytes] token. The details of what this
  token contains (and when it can be null/empty, if ever) depends on the actual
  authenticator used.

Clients are expected to answer the server challenge with an AUTH_RESPONSE
  message.
</pre>
    
        <h4 id="s4.2.8">4.2.8 AUTH_SUCCESS</h4>
        <pre>  Indicates the success of the authentication phase. See <a href="#s4.2.3">Section 4.2.3</a> for more
  details.

The body of this message is a single [bytes] token holding final information
  from the server that the client may require to finish the authentication
  process. What that token contains and whether it can be null depends on the
  actual authenticator used.

</pre>
    
        <h2 id="s5">5 Data Type Serialization Formats</h2>
        <pre>  This sections describes the serialization formats for all CQL data types
  supported by Cassandra through the native protocol.  These serialization
  formats should be used by client drivers to encode values for EXECUTE
  messages.  Cassandra will use these formats when returning values in
  RESULT messages.

All values are represented as [bytes] in EXECUTE and RESULT messages.
  The [bytes] format includes an int prefix denoting the length of the value.
  For that reason, the serialization formats described here will not include
  a length component.

For legacy compatibility reasons, note that most non-string types support
  &#34;empty&#34; values (i.e. a value with zero length).  An empty value is distinct
  from NULL, which is encoded with a negative length.

As with the rest of the native protocol, all encodings are big-endian.
</pre>
    
        <h3 id="s5.1">5.1 ascii</h3>
        <pre>  A sequence of bytes in the ASCII range [0, 127].  Bytes with values outside of
  this range will result in a validation error.
</pre>
    
        <h3 id="s5.2">5.2 bigint</h3>
        <pre>  An eight-byte two&#39;s complement integer.
</pre>
    
        <h3 id="s5.3">5.3 blob</h3>
        <pre>  Any sequence of bytes.
</pre>
    
        <h3 id="s5.4">5.4 boolean</h3>
        <pre>  A single byte.  A value of 0 denotes &#34;false&#34;; any other value denotes &#34;true&#34;.
  (However, it is recommended that a value of 1 be used to represent &#34;true&#34;.)
</pre>
    
        <h3 id="s5.5">5.5 date</h3>
        <pre>  An unsigned integer representing days with epoch centered at 2^31.
  (unix epoch January 1st, 1970).
  A few examples:
    0:    -5877641-06-23
    2^31: 1970-1-1
    2^32: 5881580-07-11
</pre>
    
        <h3 id="s5.6">5.6 decimal</h3>
        <pre>  The decimal format represents an arbitrary-precision number.  It contains an
  [int] &#34;scale&#34; component followed by a varint encoding (see <a href="#s5.24">section 5.24</a>)
  of the unscaled value.  The encoded value represents &#34;&lt;unscaled&gt;E&lt;-scale&gt;&#34;.
  In other words, &#34;&lt;unscaled&gt; * 10 ^ (-1 * &lt;scale&gt;)&#34;.
</pre>
    
        <h3 id="s5.7">5.7 double</h3>
        <pre>  An 8 byte floating point number in the IEEE 754 binary64 format.
</pre>
    
        <h3 id="s5.8">5.8 duration</h3>
        <pre>  A duration is composed of 3 signed variable length integers ([vint]s).
  The first [vint] represents a number of months, the second [vint] represents
  a number of days, and the last [vint] represents a number of nanoseconds.
  The number of months and days must be valid 32 bits integers whereas the
  number of nanoseconds must be a valid 64 bits integer.
  A duration can either be positive or negative. If a duration is positive
  all the integers must be positive or zero. If a duration is
  negative all the numbers must be negative or zero.
</pre>
    
        <h3 id="s5.9">5.9 float</h3>
        <pre>  A 4 byte floating point number in the IEEE 754 binary32 format.
</pre>
    
        <h3 id="s5.10">5.10 inet</h3>
        <pre>  A 4 byte or 16 byte sequence denoting an IPv4 or IPv6 address, respectively.
</pre>
    
        <h3 id="s5.11">5.11 int</h3>
        <pre>  A 4 byte two&#39;s complement integer.
</pre>
    
        <h3 id="s5.12">5.12 list</h3>
        <pre>  A [int] n indicating the number of elements in the list, followed by n
  elements.  Each element is [bytes] representing the serialized value.
</pre>
    
        <h3 id="s5.13">5.13 map</h3>
        <pre>  A [int] n indicating the number of key/value pairs in the map, followed by
  n entries.  Each entry is composed of two [bytes] representing the key
  and value.
</pre>
    
        <h3 id="s5.14">5.14 set</h3>
        <pre>  A [int] n indicating the number of elements in the set, followed by n
  elements.  Each element is [bytes] representing the serialized value.
</pre>
    
        <h3 id="s5.15">5.15 smallint</h3>
        <pre>  A 2 byte two&#39;s complement integer.
</pre>
    
        <h3 id="s5.16">5.16 text</h3>
        <pre>  A sequence of bytes conforming to the UTF-8 specifications.
</pre>
    
        <h3 id="s5.17">5.17 time</h3>
        <pre>  An 8 byte two&#39;s complement long representing nanoseconds since midnight.
  Valid values are in the range 0 to 86399999999999
</pre>
    
        <h3 id="s5.18">5.18 timestamp</h3>
        <pre>  An 8 byte two&#39;s complement integer representing a millisecond-precision
  offset from the unix epoch (00:00:00, January 1st, 1970).  Negative values
  represent a negative offset from the epoch.
</pre>
    
        <h3 id="s5.19">5.19 timeuuid</h3>
        <pre>  A 16 byte sequence representing a version 1 UUID as defined by RFC 4122.
</pre>
    
        <h3 id="s5.20">5.20 tinyint</h3>
        <pre>  A 1 byte two&#39;s complement integer.
</pre>
    
        <h3 id="s5.21">5.21 tuple</h3>
        <pre>  A sequence of [bytes] values representing the items in a tuple.  The encoding
  of each element depends on the data type for that position in the tuple.
  Null values may be represented by using length -1 for the [bytes]
  representation of an element.
</pre>
    
        <h3 id="s5.22">5.22 uuid</h3>
        <pre>  A 16 byte sequence representing any valid UUID as defined by RFC 4122.
</pre>
    
        <h3 id="s5.23">5.23 varchar</h3>
        <pre>  An alias of the &#34;text&#34; type.
</pre>
    
        <h3 id="s5.24">5.24 varint</h3>
        <pre>  A variable-length two&#39;s complement encoding of a signed integer.

The following examples may help implementors of this spec:

Value | Encoding
  ------|---------
      0 |     0x00
      1 |     0x01
    127 |     0x7F
    128 |   0x0080
    129 |   0x0081
     -1 |     0xFF
   -128 |     0x80
   -129 |   0xFF7F

Note that positive numbers must use a most-significant byte with a value
  less than 0x80, because a most-significant bit of 1 indicates a negative
  value.  Implementors should pad positive values that have a MSB &gt;= 0x80
  with a leading 0x00 byte.
</pre>
    
        <h3 id="s5.25">5.25 vector</h3>
        <pre>  For a vector of n dimensions of a fixed-length type, a sequence of those n elements.
  For a vector with variable-length elements, the size of the elements will precede
  each element.  Each element is the [bytes] representing the serialized value.  The
  number of dimensions is not encoded, since it&#39;s part of the type definition.

</pre>
    
        <h2 id="s6">6 User Defined Types</h2>
        <pre>  This section describes the serialization format for User defined types (UDT),
  as described in <a href="#s4.2.5.2">section 4.2.5.2</a>.

A UDT value is composed of successive [bytes] values, one for each field of the UDT
  value (in the order defined by the type). A UDT value will generally have one value
  for each field of the type it represents, but it is allowed to have less values than
  the type has fields.

</pre>
    
        <h2 id="s7">7 Result paging</h2>
        <pre>  The protocol allows for paging the result of queries. For that, the QUERY and
  EXECUTE messages have a &lt;result_page_size&gt; value that indicate the desired
  page size in CQL3 rows.

If a positive value is provided for &lt;result_page_size&gt;, the result set of the
  RESULT message returned for the query will contain at most the
  &lt;result_page_size&gt; first rows of the query result. If that first page of results
  contains the full result set for the query, the RESULT message (of kind `Rows`)
  will have the Has_more_pages flag *not* set. However, if some results are not
  part of the first response, the Has_more_pages flag will be set and the result
  will contain a &lt;paging_state&gt; value. In that case, the &lt;paging_state&gt; value
  should be used in a QUERY or EXECUTE message (that has the *same* query as
  the original one or the behavior is undefined) to retrieve the next page of
  results.

Only CQL3 queries that return a result set (RESULT message with a Rows `kind`)
  support paging. For other type of queries, the &lt;result_page_size&gt; value is
  ignored.

Note to client implementors:
  - While &lt;result_page_size&gt; can be as low as 1, it will likely be detrimental
    to performance to pick a value too low. A value below 100 is probably too
    low for most use cases.
  - Clients should not rely on the actual size of the result set returned to
    decide if there are more results to fetch or not. Instead, they should always
    check the Has_more_pages flag (unless they did not enable paging for the query
    obviously). Clients should also not assert that no result will have more than
    &lt;result_page_size&gt; results. While the current implementation always respects
    the exact value of &lt;result_page_size&gt;, we reserve the right to return
    slightly smaller or bigger pages in the future for performance reasons.
  - The &lt;paging_state&gt; is specific to a protocol version and drivers should not
    send a &lt;paging_state&gt; returned by a node using the protocol v3 to query a node
    using the protocol v4 for instance.

</pre>
    
        <h2 id="s8">8 Error codes</h2>
        <pre>  Let us recall that an ERROR message is composed of &lt;code&gt;&lt;message&gt;[...]
  (see 4.2.1 for details). The supported error codes, as well as any additional
  information the message may contain after the &lt;message&gt; are described below:
    0x0000    Server error: something unexpected happened. This indicates a
              server-side bug.
    0x000A    Protocol error: some client message triggered a protocol
              violation (for instance a QUERY message is sent before a STARTUP
              one has been sent)
    0x0100    Authentication error: authentication was required and failed. The
              possible reason for failing depends on the authenticator in use,
              which may or may not include more detail in the accompanying
              error message.
    0x1000    Unavailable exception. The rest of the ERROR message body will be
                &lt;cl&gt;&lt;required&gt;&lt;alive&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query that triggered
                     the exception.
                &lt;required&gt; is an [int] representing the number of nodes that
                           should be alive to respect &lt;cl&gt;
                &lt;alive&gt; is an [int] representing the number of replicas that
                        were known to be alive when the request had been
                        processed (since an unavailable exception has been
                        triggered, there will be &lt;alive&gt; &lt; &lt;required&gt;)
    0x1001    Overloaded: the request cannot be processed because the
              coordinator node is overloaded
    0x1002    Is_bootstrapping: the request was a read request but the
              coordinator node is bootstrapping
    0x1003    Truncate_error: error during a truncation error.
    0x1100    Write_timeout: Timeout exception during a write request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;writeType&gt;&lt;contentions&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           acknowledged the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;writeType&gt; is a [string] that describe the type of the write
                            that timed out. The value of that string can be one
                            of:
                             - &#34;SIMPLE&#34;: the write was a non-batched
                               non-counter write.
                             - &#34;BATCH&#34;: the write was a (logged) batch write.
                               If this type is received, it means the batch log
                               has been successfully written (otherwise a
                               &#34;BATCH_LOG&#34; type would have been sent instead).
                             - &#34;UNLOGGED_BATCH&#34;: the write was an unlogged
                               batch. No batch log write has been attempted.
                             - &#34;COUNTER&#34;: the write was a counter write
                               (batched or not).
                             - &#34;BATCH_LOG&#34;: the timeout occurred during the
                               write to the batch log when a (logged) batch
                               write was requested.
                             - &#34;CAS&#34;: the timeout occurred during the Compare And Set write/update.
                             - &#34;VIEW&#34;: the timeout occurred when a write involves
                               VIEW update and failure to acquire local view(MV)
                               lock for key within timeout
                             - &#34;CDC&#34;: the timeout occurred when cdc_total_space is
                               exceeded when doing a write to data tracked by cdc.
                &lt;contentions&gt; is a [short] that describes the number of contentions occurred during the CAS operation.
                              The field only presents when the &lt;writeType&gt; is &#34;CAS&#34;.
    0x1200    Read_timeout: Timeout exception during a read request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;data_present&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           response is required to achieve &lt;cl&gt;. Please note that
                           it is possible to have &lt;received&gt; &gt;= &lt;blockfor&gt; if
                           &lt;data_present&gt; is false. Also in the (unlikely)
                           case where &lt;cl&gt; is achieved but the coordinator node
                           times out while waiting for read-repair acknowledgement.
                &lt;data_present&gt; is a single byte. If its value is 0, it means
                               the replica that was asked for data has not
                               responded. Otherwise, the value is != 0.
    0x1300    Read_failure: A non-timeout exception during a read request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;reason_map&gt;&lt;data_present&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;reason_map&gt; is a map of endpoint to failure reason codes. This maps
                            the endpoints of the replica nodes that failed when
                            executing the request to a code representing the reason
                            for the failure. The map is encoded starting with an [int] n
                            followed by n pairs of &lt;endpoint&gt;&lt;failure_code&gt; where
                            &lt;endpoint&gt; is an [inetaddr] and &lt;failure_code&gt; is a [short].
                            The currently defined &lt;failure_code&gt; values are:
                             - 0x0000  UNKNOWN: the failure reason is
                               unknown. This code is also used when the
                               coordinator receives an unrecognized code
                               from a replica running a newer version, for
                               forward compatibility. Clients should handle
                               unknown failure codes gracefully.
                             - 0x0001  READ_TOO_MANY_TOMBSTONES: the read
                               scanned too many tombstones on the replica
                               and was aborted. The threshold is configured
                               by tombstone_failure_threshold in
                               cassandra.yaml (default: 100000).
                             - 0x0002  TIMEOUT: the replica did not respond
                               to the coordinator within the expected
                               timeout for this operation. This is a
                               per-replica failure reported within the
                               &lt;reason_map&gt;; it differs from Read_timeout
                               (0x1200) and Write_timeout (0x1100), which
                               indicate that the overall consistency level
                               could not be met.
                             - 0x0003  INCOMPATIBLE_SCHEMA: the replica
                               could not process the request because its
                               schema differs from the coordinator&#39;s (e.g.
                               a column or table referenced in the request
                               is not recognized). This can occur during
                               rolling upgrades or when schema changes have
                               not yet propagated to all nodes.
                             - 0x0004  READ_SIZE: the amount of data read
                               on the replica exceeded a configured size
                               threshold and the read was aborted. The
                               thresholds are local_read_size_fail_threshold
                               and row_index_read_size_fail_threshold in
                               cassandra.yaml (both disabled by default;
                               require read_thresholds_enabled: true).
                             - 0x0005  NODE_DOWN: the replica was known to
                               be down when the coordinator was assembling
                               the request. The replica was never contacted.
                             - 0x0006  INDEX_NOT_AVAILABLE: a secondary
                               index required by the query is not yet
                               available on the replica. This can occur
                               after a node restart, before the index has
                               completed its initial build or recovery.
                             - 0x0007  READ_TOO_MANY_INDEXES: the read
                               referenced more SSTable indexes via SAI
                               (Storage-Attached Indexes) than the
                               configured guardrail allows. The threshold
                               is sai_sstable_indexes_per_query_fail_threshold
                               in cassandra.yaml.
                             - 0x0008  NOT_CMS: the request was sent to a
                               node that is not a member of the Cluster
                               Metadata Service (CMS), but the operation
                               requires a CMS member.
                             - 0x0009  INVALID_ROUTING: the replica does
                               not own the token or token range for the
                               requested data according to its current
                               cluster metadata. This typically indicates
                               that the coordinator&#39;s topology view is
                               stale.
                             - 0x000A  COORDINATOR_BEHIND: the coordinator&#39;s
                               cluster metadata is behind the replica&#39;s
                               (e.g. it references a table that has been
                               dropped, or does not yet know about a table
                               that has been created). The coordinator
                               needs to update its metadata before retrying.
                             - 0x000B  RETRY_ON_DIFFERENT_TRANSACTION_SYSTEM:
                               the operation was attempted using one
                               transaction system (Accord or Paxos) but
                               must be retried using the other, because
                               the data is managed by or conflicts with
                               operations on the other system.
                             - 0x01F7  INDEX_BUILD_IN_PROGRESS: a secondary
                               index required by the query is currently
                               being rebuilt on the replica and cannot
                               serve reads until the build completes. This
                               is a more specific form of
                               INDEX_NOT_AVAILABLE (0x0006).
                &lt;data_present&gt; is a single byte. If its value is 0, it means
                               the replica that was asked for data had not
                               responded. Otherwise, the value is != 0.
    0x1400    Function_failure: A (user defined) function failed during execution.
              The rest of the ERROR message body will be
                &lt;keyspace&gt;&lt;function&gt;&lt;arg_types&gt;
              where:
                &lt;keyspace&gt; is the keyspace [string] of the failed function
                &lt;function&gt; is the name [string] of the failed function
                &lt;arg_types&gt; [string list] one string for each argument type (as CQL type) of the failed function
    0x1500    Write_failure: A non-timeout exception during a write request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;reason_map&gt;&lt;write_type&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;reason_map&gt; is a map of endpoint to failure reason codes. This maps
                            the endpoints of the replica nodes that failed when
                            executing the request to a code representing the reason
                            for the failure. The map is encoded starting with an [int] n
                            followed by n pairs of &lt;endpoint&gt;&lt;failure_code&gt; where
                            &lt;endpoint&gt; is an [inetaddr] and &lt;failure_code&gt; is a [short].
                            See the &lt;failure_code&gt; values defined in
                            Read_failure (0x1300) above. The same set of
                            codes applies to write failures.
                &lt;writeType&gt; is a [string] that describes the type of the write
                            that failed. The value of that string can be one
                            of:
                             - &#34;SIMPLE&#34;: the write was a non-batched
                               non-counter write.
                             - &#34;BATCH&#34;: the write was a (logged) batch write.
                               If this type is received, it means the batch log
                               has been successfully written (otherwise a
                               &#34;BATCH_LOG&#34; type would have been sent instead).
                             - &#34;UNLOGGED_BATCH&#34;: the write was an unlogged
                               batch. No batch log write has been attempted.
                             - &#34;COUNTER&#34;: the write was a counter write
                               (batched or not).
                             - &#34;BATCH_LOG&#34;: the failure occurred during the
                               write to the batch log when a (logged) batch
                               write was requested.
                             - &#34;CAS&#34;: the failure occurred during the Compare And Set write/update.
                             - &#34;VIEW&#34;: the failure occurred when a write involves
                               VIEW update and failure to acquire local view(MV)
                               lock for key within timeout
                             - &#34;CDC&#34;: the failure occurred when cdc_total_space is
                               exceeded when doing a write to data tracked by cdc.
    0x1600    CDC_WRITE_FAILURE: // todo
    0x1700    CAS_WRITE_UNKNOWN: An exception occurred due to contended Compare And Set write/update.
              The CAS operation was only partially completed and the operation may or may not get completed by
              the contending CAS write or SERIAL/LOCAL_SERIAL read. The rest of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           acknowledged the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.

0x2000    Syntax_error: The submitted query has a syntax error.
    0x2100    Unauthorized: The logged user doesn&#39;t have the right to perform
              the query.
    0x2200    Invalid: The query is syntactically correct but invalid.
    0x2300    Config_error: The query is invalid because of some configuration issue
    0x2400    Already_exists: The query attempted to create a keyspace or a
              table that was already existing. The rest of the ERROR message
              body will be &lt;ks&gt;&lt;table&gt; where:
                &lt;ks&gt; is a [string] representing either the keyspace that
                     already exists, or the keyspace in which the table that
                     already exists is.
                &lt;table&gt; is a [string] representing the name of the table that
                        already exists. If the query was attempting to create a
                        keyspace, &lt;table&gt; will be present but will be the empty
                        string.
    0x2500    Unprepared: Can be thrown while a prepared statement tries to be
              executed if the provided prepared statement ID is not known by
              this host. The rest of the ERROR message body will be [short
              bytes] representing the unknown ID.
</pre>
    
        <h2 id="s9">9 Changes from v4</h2>
        <pre>  * Added result set metadata id to Prepared responses (<a href="#s4.2.5.4">Section 4.2.5.4</a>)
  * Beta protocol flag for v5 native protocol is added (<a href="#s2.2">Section 2.2</a>)
  * &lt;num_failures&gt; in Read_failure and Write_failure error message bodies (<a href="#s9">Section 9</a>)
    has been replaced with &lt;reason_map&gt;. The &lt;reason_map&gt; maps node IP addresses to
    a failure reason code which indicates why the request failed on that node.
  * Enlarged flag&#39;s bitmaps for QUERY, EXECUTE and BATCH messages from [byte] to [int]
    (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.6">4.1.6</a> and <a href="#s4.1.7">4.1.7</a>).
  * Add the duration data type
  * Added keyspace field in QUERY, PREPARE, and BATCH messages (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.5">4.1.5</a>, and <a href="#s4.1.7">4.1.7</a>).
  * Added now_in_seconds field in QUERY, EXECUTE, and BATCH messages (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.6">4.1.6</a>, and <a href="#s4.1.7">4.1.7</a>).
  * Added [int] flags field in PREPARE message (<a href="#s4.1.5">Section 4.1.5</a>).
  * Removed NO_COMPACT startup option (<a href="#s4.1.1">Section 4.1.1</a>.)
  * Introduces outer framing format wrapping the &#34;frames&#34; of v4 and earlier, which are
    now referred to as &#34;envelopes&#34; (Sections <a href="#s2.1">2.1</a>, <a href="#s2.2">2.2</a> and <a href="#s2.3">2.3</a>)
</pre>
    
</body>
</html>

Bearbeitung

Datei öffnen

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>CQL BINARY PROTOCOL v5</title>
  <style>
    nav ol { margin: 0; padding: 0; padding-left: 1em; }
    nav li { list-style: none; }
    nav.top ul { margin: 0; padding: 0; background: #eee; color: black; }
    nav.top ul li { display: inline-block; }
  </style>
</head>
<body>
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  <h1>CQL BINARY PROTOCOL v5</h1>
  <h2>Table of Contents</h2>
  <nav>
    <ol>
      <li id="toc1">
        1
        <a href="#s1">Overview</a>
      </li>
      <li id="toc2">
        2
        <a href="#s2">Frame format</a>
        <ol>
          <li id="toc2.1">
            2.1
            <a href="#s2.1">Uncompressed Format</a>
          </li>
          <li id="toc2.2">
            2.2
            <a href="#s2.2">Compressed Format</a>
          </li>
          <li id="toc2.3">
            2.3
            <a href="#s2.3">Protocol Negotiation</a>
            <ol>
              <li id="toc2.3.1">
                2.3.1
                <a href="#s2.3.1">Initial Handshake</a>
              </li>
              <li id="toc2.3.2">
                2.3.2
                <a href="#s2.3.2">Compression</a>
              </li>
            </ol>
          </li>
          <li id="toc2.4">
            2.4
            <a href="#s2.4">Frame Payload</a>
            <ol>
              <li id="toc2.4.1.1">
                2.4.1.1
                <a href="#s2.4.1.1">version</a>
                <ol>
                  <li id="toc2.4.1.2">
                    2.4.1.2
                    <a href="#s2.4.1.2">flags</a>
                  </li>
                  <li id="toc2.4.1.3">
                    2.4.1.3
                    <a href="#s2.4.1.3">stream</a>
                  </li>
                  <li id="toc2.4.1.4">
                    2.4.1.4
                    <a href="#s2.4.1.4">opcode</a>
                  </li>
                  <li id="toc2.4.1.5">
                    2.4.1.5
                    <a href="#s2.4.1.5">length</a>
                  </li>
                </ol>
              </li>
            </ol>
          </li>
        </ol>
      </li>
      <li id="toc3">
        3
        <a href="#s3">Notations</a>
      </li>
      <li id="toc4">
        4
        <a href="#s4">Messages</a>
        <ol>
          <li id="toc4.1">
            4.1
            <a href="#s4.1">Requests</a>
            <ol>
              <li id="toc4.1.1">
                4.1.1
                <a href="#s4.1.1">STARTUP</a>
              </li>
              <li id="toc4.1.2">
                4.1.2
                <a href="#s4.1.2">AUTH_RESPONSE</a>
              </li>
              <li id="toc4.1.3">
                4.1.3
                <a href="#s4.1.3">OPTIONS</a>
              </li>
              <li id="toc4.1.4">
                4.1.4
                <a href="#s4.1.4">QUERY</a>
              </li>
              <li id="toc4.1.5">
                4.1.5
                <a href="#s4.1.5">PREPARE</a>
              </li>
              <li id="toc4.1.6">
                4.1.6
                <a href="#s4.1.6">EXECUTE</a>
              </li>
              <li id="toc4.1.7">
                4.1.7
                <a href="#s4.1.7">BATCH</a>
              </li>
              <li id="toc4.1.8">
                4.1.8
                <a href="#s4.1.8">REGISTER</a>
              </li>
            </ol>
          </li>
          <li id="toc4.2">
            4.2
            <a href="#s4.2">Responses</a>
            <ol>
              <li id="toc4.2.1">
                4.2.1
                <a href="#s4.2.1">ERROR</a>
              </li>
              <li id="toc4.2.2">
                4.2.2
                <a href="#s4.2.2">READY</a>
              </li>
              <li id="toc4.2.3">
                4.2.3
                <a href="#s4.2.3">AUTHENTICATE</a>
              </li>
              <li id="toc4.2.4">
                4.2.4
                <a href="#s4.2.4">SUPPORTED</a>
              </li>
              <li id="toc4.2.5">
                4.2.5
                <a href="#s4.2.5">RESULT</a>
                <ol>
                  <li id="toc4.2.5.1">
                    4.2.5.1
                    <a href="#s4.2.5.1">Void</a>
                  </li>
                  <li id="toc4.2.5.2">
                    4.2.5.2
                    <a href="#s4.2.5.2">Rows</a>
                  </li>
                  <li id="toc4.2.5.3">
                    4.2.5.3
                    <a href="#s4.2.5.3">Set_keyspace</a>
                  </li>
                  <li id="toc4.2.5.4">
                    4.2.5.4
                    <a href="#s4.2.5.4">Prepared</a>
                  </li>
                  <li id="toc4.2.5.5">
                    4.2.5.5
                    <a href="#s4.2.5.5">Schema_change</a>
                  </li>
                </ol>
              </li>
              <li id="toc4.2.6">
                4.2.6
                <a href="#s4.2.6">EVENT</a>
              </li>
              <li id="toc4.2.7">
                4.2.7
                <a href="#s4.2.7">AUTH_CHALLENGE</a>
              </li>
              <li id="toc4.2.8">
                4.2.8
                <a href="#s4.2.8">AUTH_SUCCESS</a>
              </li>
            </ol>
          </li>
        </ol>
      </li>
      <li id="toc5">
        5
        <a href="#s5">Data Type Serialization Formats</a>
      </li>
      <li id="toc6">
        6
        <a href="#s6">User Defined Type Serialization</a>
      </li>
      <li id="toc7">
        7
        <a href="#s7">Result paging</a>
      </li>
      <li id="toc8">
        8
        <a href="#s8">Error codes</a>
      </li>
      <li id="toc9">
        9
        <a href="#s9">Changes from v4</a>
      </li>
    </ol>
  </nav>
  <h2 id="s1">1 Overview</h2>
  <pre>  The CQL binary protocol is a frame based protocol with frames comprising a header, payload
  and trailer. In v5 there are two distinct frame formats, compressed and uncompressed and in
  both cases the payload is a stream of CQL envelopes (<a href="#s2.4">Section 2.4</a>). Each envelope contains
  a single CQL message, along with a metadata header. In effect, the framing format is a
  simple wrapper around protocol v5.

The payload is opaque as far as the framing format is concerned, modulo the self
  contained variation.

The trailer contains a CRC32 to protect the integrity of the payload, covering all envelopes
  (whole or partial) contained therein.

All the integers in the v5 framing format are little-endian.
</pre>
  <h2 id="s2">2 Frame Format</h2>
  <pre></pre>
  <h3 id="s2.1">2.1 Uncompressed Format</h3>
  <pre>  The uncompressed variant uses a 6 byte header. The first 3 bytes contain payload length and
  self contained flag. The following 3 bytes contain the CRC24 for the header itself.
  The max size for the payload is 128KiB, and is followed by its CRC32.

The first 3 bytes of the header represent a single unsigned little-endian integer. The self
  contained flag is the 17th bit of that decoded integer.

The headed padding can be discarded.

The CRC24 of the header is calculated by initializing the CRC24 algorithm
  with the value 0x875060 and using the polynomial 0x1974F0B.
</pre>
  <h3 id="s2.2">2.2 LZ4 Compressed Format</h3>
  <pre>  The variant with LZ4 compression uses an 8 byte header. The first 4 bytes contain
  an unsigned integer (little endian) containing the compressed and uncompressed
  lengths of the payload and the self contained flag. The remaining 4 bytes are an
  unsigned integer (little endian) representing the CRC24 for the header.
  As with uncompressed frames, the max payload size is 128KiB and is followed
  by a CRC32 trailer. This is the CRC of the compressed payload.

The header padding can be discarded.

An uncompressed length of 0 signals that the compressed payload
  should be used as-is and not decompressed.

The CRC24 of the header is calculated with the same parameters as for
  the uncompressed format (<a href="#s2.1">Section 2.1</a>).
</pre>
  <h3 id="s2.3">2.3 Protocol Negotiation</h3>
  <pre></pre>
  <h4 id="s2.3.1">2.3.1 Initial Handshake</h4>
  <pre>  In order to support both v5 and earlier formats, the v5 framing format is not
  applied to message exchanges before an initial handshake is completed. Practically,
  this means that the initial STARTUP message and any OPTIONS messages which precede
  it are expected to be unframed. Likewise, the responses returned by the server,
  SUPPORTED in response to OPTIONS and either READY or AUTHENTICATE in response to
  STARTUP are transmitted unframed.

Note: OPTIONS requests may be sent by the client at any time in the connection
  lifecycle, both before and after the STARTUP exchange. As mentioned, those
  transmitted before STARTUP, as well as the SUPPORTED responses the server returns
  are unframed. Any OPTIONS/SUPPORTED exchanges after the STARTUP handshake are
  formatted according to the negotiated protocol version, so for v5 these must be
  framed.
</pre>
  <h4 id="s2.3.2">2.3.2 Compression</h4>
  <pre>  Before being used, client and server must agree on a compression algorithm to
  use, which is done in the STARTUP message. As a consequence, a STARTUP message
  must never be compressed.  However, once the STARTUP frame has been received
  by the server, messages can be compressed (including the response to the STARTUP
  request). Frames do not have to be compressed, however, even if compression has
  been agreed upon (a sender may only compress frames above a certain size at its
  discretion). Where compression has been agreed, the sender signals that the payload
  is not compressed by setting the compressed length to 0.

As of v5 of the protocol, the only compression available is lz4
  (<a href="https://code.google.com/p/lz4/">https://code.google.com/p/lz4/</a>).

</pre>
  <h3 id="s2.4">2.4 Frame Payload</h3>
  <pre>  Envelopes are defined as:

All values in an envelope are big-endian (network byte order).

Envelope headers are designed to support backwards compatibility with earlier
  protocol versions. For that reason, they include an unused leading byte in place
  of the version field from previous protocol versions. This was always to some extent
  redundant as the version is set and enforced at the connection level. It was also
  previously possible to enable compression for an individual envelope. This is no
  longer possible, as the framing format is responsible for compression, which is set for
  the lifetime of a connection and applies to all messages transmitted throughout it
  (see <a href="#s2.2">Section 2.2</a> for caveats). The compression flag is therefore deprecated and
  ignored in protocol v5.
</pre>
  <h5 id="s2.4.1.1">2.4.1.1 version</h5>
  <pre>  The version is a single byte that indicates both the direction of the message
  (request or response) and the version of the protocol in use. The most
  significant bit of version is used to define the direction of the message:
  0 indicates a request, 1 indicates a response. This can be useful for protocol
  analyzers to distinguish the nature of the packet from the direction in which
  it is moving. The rest of that byte is the protocol version (5 for the protocol
  defined in this document). In other words, for this version of the protocol,
  version will be one of:
    0x05    Request frame for this protocol version
    0x85    Response frame for this protocol version

This document describes version 5 of the protocol. For the changes made since
  version 4, see <a href="#s9">Section 9</a>.
</pre>
  <h5 id="s2.4.1.2">2.4.1.2 flags</h5>
  <pre>  Flags applying to this envelope. The flags have the following meaning (described
  by the mask that allows selecting them):
    0x01: Compression flag. In protocol v5 this flag is deprecated and ignored.
    0x02: Tracing flag. For a request, this indicates the client requires tracing
          of the request. Note that only QUERY, PREPARE and EXECUTE queries
          support tracing. Other requests will simply ignore the tracing flag if
          set. If a request supports tracing and the tracing flag is set, the
          response to this request will have the tracing flag set and contain
          tracing information.
          If a response has the tracing flag set, its body contains a tracing ID.
          The tracing ID is a [uuid] and is the first thing in the body.
    0x04: Custom payload flag. For a request or response, this indicates that a
          generic key-value custom payload for a custom QueryHandler implementation
          is present. Such a custom payload is simply ignored by the default
          QueryHandler implementation. Currently, only QUERY, PREPARE, EXECUTE and
          BATCH requests support custom payloads.
          Type of custom payload is [bytes map] (see below). If either or both
          of the tracing and warning flags are set, the custom payload will follow
          those indicated elements in the body. If neither are set, the custom
          payload will be the first value in the body.
    0x08: Warning flag. The response contains warnings which were generated by the
          server to go along with this response.
          If a response has the warning flag set, its body will contain the text of
          the warnings. The warnings are a [string list] and will be the first value
          in the body if the tracing flag is not set, or directly after the tracing
          ID if it is.
    0x10: Use beta flag. Indicates that the client opts in to use protocol version
          that is currently in beta. Server will respond with ERROR if protocol
          version is marked as beta on server and client does not provide this flag.

The rest of flags is currently unused and ignored.
</pre>
  <h5 id="s2.4.1.3">2.4.1.3 stream</h5>
  <pre>  An envelope has a stream id (a [short] value). When sending request messages, this
  stream id must be set by the client to a non-negative value (negative stream id
  are reserved for streams initiated by the server; currently all EVENT messages
  (<a href="#s4.2.6">section 4.2.6</a>) have a streamId of -1). If a client sends a request message
  with the stream id X, it is guaranteed that the stream id of the response to
  that message will be X.

Note that clients are free to use the protocol synchronously (i.e. wait for
  the response to REQ_N before sending REQ_N+1). In that case, the stream id
  can be safely set to 0 as long as each frame contains only a single envelope.
  Clients should also feel free to use only a subset of the 32768 maximum possible stream
  ids if it is simpler for its implementation.
</pre>
  <h5 id="s2.4.1.4">2.4.1.4 opcode</h5>
  <pre>  An integer byte that distinguishes the actual message:
    0x00    ERROR
    0x01    STARTUP
    0x02    READY
    0x03    AUTHENTICATE
    0x05    OPTIONS
    0x06    SUPPORTED
    0x07    QUERY
    0x08    RESULT
    0x09    PREPARE
    0x0A    EXECUTE
    0x0B    REGISTER
    0x0C    EVENT
    0x0D    BATCH
    0x0E    AUTH_CHALLENGE
    0x0F    AUTH_RESPONSE
    0x10    AUTH_SUCCESS

Messages are described in <a href="#s4">Section 4</a>.

(Note that there is no 0x04 message in this version of the protocol)
</pre>
  <h5 id="s2.4.1.5">2.4.1.5 length</h5>
  <pre>  A 4 byte integer representing the length of the body of the envelope (note:
  currently an envelope body is limited to 256MB in length).

</pre>
  <h2 id="s3">3 Notations</h2>
  <pre>  To describe the layout of the envelope body for the messages in <a href="#s4">Section 4</a>, we
  define the following:

</pre>
  <h2 id="s4">4 Messages</h2>
  <pre>  Dependant on the flags specified in the header, the layout of the message body must be:
    [&lt;tracing_id&gt;][&lt;warnings&gt;][&lt;custom_payload&gt;]&lt;message&gt;
  where:
    - &lt;tracing_id&gt; is a UUID tracing ID, present if this is a request message and the Tracing flag is set.
    - &lt;warnings&gt; is a string list of warnings (if this is a request message and the Warning flag is set.
    - &lt;custom_payload&gt; is bytes map for the serialised custom payload present if this is one of the message types
      which support custom payloads (QUERY, PREPARE, EXECUTE and BATCH) and the Custom payload flag is set.
    - &lt;message&gt; as defined below through sections <a href="#s4">4</a> and <a href="#s5">5</a>.
</pre>
  <h3 id="s4.1">4.1 Requests</h3>
  <pre>  Note that outside of their normal responses (described below), all requests
  can get an ERROR message (<a href="#s4.2.1">Section 4.2.1</a>) as response.
</pre>
  <h4 id="s4.1.1">4.1.1 STARTUP</h4>
  <pre>  Initialize the connection. The server will respond by either a READY message
  (in which case the connection is ready for queries) or an AUTHENTICATE message
  (in which case credentials will need to be provided using AUTH_RESPONSE).

As mentioned in <a href="#s2.3">Section 2.3</a>, STARTUP messages must not be sent in the framed format. STARTUP,
  any OPTIONS requests which precede them, as well as the server&#39;s responses to those messages
  must be unframed to support protocol negotiation with older clients.
</pre>
  <h4 id="s4.1.2">4.1.2 AUTH_RESPONSE</h4>
  <pre>  Answers a server authentication challenge.

The body of this message is a single [bytes] token. The details of what this
  token contains (and when it can be null/empty, if ever) depends on the actual
  authenticator used.

The response to a AUTH_RESPONSE is either a follow-up AUTH_CHALLENGE message,
  an AUTH_SUCCESS message or an ERROR message.

</pre>
  <h4 id="s4.1.3">4.1.3 OPTIONS</h4>
  <pre>  Asks the server to return which STARTUP options are supported. The body of an
  OPTIONS message should be empty and the server will respond with a SUPPORTED
  message.

</pre>
  <h4 id="s4.1.4">4.1.4 QUERY</h4>
  <pre>  Performs a CQL query. The body of the message must be:
    &lt;query&gt;&lt;query_parameters&gt;
  where &lt;query&gt; is a [long string] representing the query and
  &lt;query_parameters&gt; must be
    &lt;consistency&gt;&lt;flags&gt;[&lt;n&gt;[name_1]&lt;value_1&gt;...[name_n]&lt;value_n&gt;][&lt;result_page_size&gt;][&lt;paging_state&gt;][&lt;serial_consistency&gt;][&lt;timestamp&gt;][&lt;keyspace&gt;][&lt;now_in_seconds&gt;]
  where:
    - &lt;consistency&gt; is the [consistency] level for the operation.
    - &lt;flags&gt; is a [int] whose bits define the options for this query and
      in particular influence what the remainder of the message contains.
      A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x0001: Values. If set, a [short] &lt;n&gt; followed by &lt;n&gt; [value]
                values are provided. Those values are used for bound variables in
                the query. Optionally, if the 0x40 flag is present, each value
                will be preceded by a [string] name, representing the name of
                the marker the value must be bound to.
        0x0002: Skip_metadata. If set, the Result Set returned as a response
                to the query (if any) will have the NO_METADATA flag (see
                <a href="#s4.2.5.2">Section 4.2.5.2</a>).
        0x0004: Page_size. If set, &lt;result_page_size&gt; is an [int]
                controlling the desired page size of the result (in CQL3 rows).
                See the section on paging (<a href="#s7">Section 7</a>) for more details.
        0x0008: With_paging_state. If set, &lt;paging_state&gt; should be present.
                &lt;paging_state&gt; is a [bytes] value that should have been returned
                in a result set (<a href="#s4.2.5.2">Section 4.2.5.2</a>). The query will be
                executed but starting from a given paging state. This is also to
                continue paging on a different node than the one where it
                started (See <a href="#s7">Section 7</a> for more details).
        0x0010: With serial consistency. If set, &lt;serial_consistency&gt; should be
                present. &lt;serial_consistency&gt; is the [consistency] level for the
                serial phase of conditional updates. Consistency can be
                either SERIAL or LOCAL_SERIAL, if not present, it defaults to
                SERIAL. This option will be ignored for anything else other than a
                conditional update/insert.
        0x0020: With default timestamp. If set, &lt;timestamp&gt; must be present.
                &lt;timestamp&gt; is a [long] representing the default timestamp for the query
                in microseconds (negative values are forbidden). This will
                replace the server side assigned timestamp as default timestamp.
                Note that a timestamp in the query itself will still override
                this timestamp. This is entirely optional.
        0x0040: With names for values. This only makes sense if the 0x01 flag is set and
                is ignored otherwise. If present, the values from the 0x01 flag will
                be preceded by a name (see above). Note that this is only useful for
                QUERY requests where named bind markers are used; for EXECUTE statements,
                since the names for the expected values was returned during preparation,
                a client can always provide values in the right order without any names
                and using this flag, while supported, is almost surely inefficient.
        0x0080: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
                [string] indicating the keyspace that the query should be executed in.
                It supersedes the keyspace that the connection is bound to, if any.
        0x0100: With now in seconds. If set, &lt;now_in_seconds&gt; must be present.
                &lt;now_in_seconds&gt; is an [int] representing the current time (now) for
                the query. Affects TTL cell liveness in read queries and local deletion
                time for tombstones and TTL cells in update requests. It&#39;s intended
                for testing purposes and is optional.

Note that the consistency is ignored by some queries (USE, CREATE, ALTER,
  TRUNCATE, ...).

The server will respond to a QUERY message with a RESULT message, the content
  of which depends on the query.

</pre>
  <h4 id="s4.1.5">4.1.5 PREPARE</h4>
  <pre>  Prepare a query for later execution (through EXECUTE). The body of the message must be:
    &lt;query&gt;&lt;flags&gt;[&lt;keyspace&gt;]
  where:
    - &lt;query&gt; is a [long string] representing the CQL query.
    - &lt;flags&gt; is a [int] whose bits define the options for this statement and in particular
      influence what the remainder of the message contains.
      A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x01: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
              [string] indicating the keyspace that the query should be executed in.
              It supersedes the keyspace that the connection is bound to, if any.

The server will respond with a RESULT message with a `prepared` kind (0x0004,
  see <a href="#s4.2.5">Section 4.2.5</a>).

</pre>
  <h4 id="s4.1.6">4.1.6 EXECUTE</h4>
  <pre>  Executes a prepared query. The body of the message must be:
  &lt;id&gt;&lt;result_metadata_id&gt;&lt;query_parameters&gt;
  where
    - &lt;id&gt; is the prepared query ID. It&#39;s the [short bytes] returned as a
      response to a PREPARE message.
    - &lt;result_metadata_id&gt; is the ID of the result set metadata that was sent
      along with response to PREPARE message. If a RESULT/Rows message reports
      changed result set metadata with the Metadata_changed flag, the reported new
      result set metadata must be used in subsequent executions.
    - &lt;query_parameters&gt; has the exact same definition as in QUERY (see <a href="#s4.1.4">Section 4.1.4</a>).

</pre>
  <h4 id="s4.1.7">4.1.7 BATCH</h4>
  <pre>  Allows executing a list of queries (prepared or not) as a batch (note that
  only DML statements are accepted in a batch). The body of the message must
  be:
    &lt;type&gt;&lt;n&gt;&lt;query_1&gt;...&lt;query_n&gt;&lt;consistency&gt;&lt;flags&gt;[&lt;serial_consistency&gt;][&lt;timestamp&gt;][&lt;keyspace&gt;][&lt;now_in_seconds&gt;]
  where:
    - &lt;type&gt; is a [byte] indicating the type of batch to use:
        - If &lt;type&gt; == 0, the batch will be &#34;logged&#34;. This is equivalent to a
          normal CQL3 batch statement.
        - If &lt;type&gt; == 1, the batch will be &#34;unlogged&#34;.
        - If &lt;type&gt; == 2, the batch will be a &#34;counter&#34; batch (and non-counter
          statements will be rejected).
    - &lt;flags&gt; is a [int] whose bits define the options for this query and
      in particular influence what the remainder of the message contains. It is similar
      to the &lt;flags&gt; from QUERY and EXECUTE methods, except that the 4 rightmost
      bits must always be 0 as their corresponding options do not make sense for
      Batch. A flag is set if the bit corresponding to its `mask` is set. Supported
      flags are, given their mask:
        0x0010: With serial consistency. If set, &lt;serial_consistency&gt; should be
                present. &lt;serial_consistency&gt; is the [consistency] level for the
                serial phase of conditional updates. Consistency can be
                either SERIAL or LOCAL_SERIAL, if not present, it defaults to
                SERIAL. This option will be ignored for anything else other than a
                conditional update/insert.
        0x0020: With default timestamp. If set, &lt;timestamp&gt; should be present.
                &lt;timestamp&gt; is a [long] representing the default timestamp for the query
                in microseconds. This will replace the server side assigned
                timestamp as default timestamp. Note that a timestamp in the query itself
                will still override this timestamp. This is entirely optional.
        0x0040: With names for values. If set, then all values for all &lt;query_i&gt; must be
                preceded by a [string] &lt;name_i&gt; that have the same meaning as in QUERY
                requests [IMPORTANT NOTE: this feature does not work and should not be
                used. It is specified in a way that makes it impossible for the server
                to implement. This will be fixed in a future version of the native
                protocol. See <a href="https://issues.apache.org/jira/browse/CASSANDRA-10246">https://issues.apache.org/jira/browse/CASSANDRA-10246</a> for
                more details].
        0x0080: With keyspace. If set, &lt;keyspace&gt; must be present. &lt;keyspace&gt; is a
                [string] indicating the keyspace that the query should be executed in.
                It supersedes the keyspace that the connection is bound to, if any.
        0x0100: With now in seconds. If set, &lt;now_in_seconds&gt; must be present.
                &lt;now_in_seconds&gt; is an [int] representing the current time (now) for
                the query. Affects TTL cell liveness in read queries and local deletion
                time for tombstones and TTL cells in update requests. It&#39;s intended
                for testing purposes and is optional.
    - &lt;n&gt; is a [short] indicating the number of following queries.
    - &lt;query_1&gt;...&lt;query_n&gt; are the queries to execute. A &lt;query_i&gt; must be of the
      form:
        &lt;kind&gt;&lt;string_or_id&gt;&lt;n&gt;[&lt;name_1&gt;]&lt;value_1&gt;...[&lt;name_n&gt;]&lt;value_n&gt;
      where:
       - &lt;kind&gt; is a [byte] indicating whether the following query is a prepared
         one or not. &lt;kind&gt; value must be either 0 or 1.
       - &lt;string_or_id&gt; depends on the value of &lt;kind&gt;. If &lt;kind&gt; == 0, it should be
         a [long string] query string (as in QUERY, the query string might contain
         bind markers). Otherwise (that is, if &lt;kind&gt; == 1), it should be a
         [short bytes] representing a prepared query ID.
       - &lt;n&gt; is a [short] indicating the number (possibly 0) of following values.
       - &lt;name_i&gt; is the optional name of the following &lt;value_i&gt;. It must be present
         if and only if the 0x40 flag is provided for the batch.
       - &lt;value_i&gt; is the [value] to use for bound variable i (of bound variable &lt;name_i&gt;
         if the 0x40 flag is used).
    - &lt;consistency&gt; is the [consistency] level for the operation.
    - &lt;serial_consistency&gt; is only present if the 0x10 flag is set. In that case,
      &lt;serial_consistency&gt; is the [consistency] level for the serial phase of
      conditional updates. Consistency can be either SERIAL or
      LOCAL_SERIAL, if not present, it defaults to SERIAL. This option will
      be ignored for anything else other than a conditional update/insert.

The server will respond with a RESULT message.

</pre>
  <h4 id="s4.1.8">4.1.8 REGISTER</h4>
  <pre>  Register this connection to receive some types of events. The body of the
  message is a [string list] representing the event types to register for. See
  <a href="#s4.2.6">section 4.2.6</a> for the list of valid event types.

The response to a REGISTER message will be a READY message.

</pre>
  <h3 id="s4.2">4.2 Responses</h3>
  <pre>  This section describes the content of the frame body for the different
  responses. Please note that to make room for future evolution, clients should
  support extra information (that they should simply discard) to the one
  described in this document at the end of the frame body.
</pre>
  <h4 id="s4.2.1">4.2.1 ERROR</h4>
  <pre>  Indicates an error processing a request. The body of the message will be an
  error code ([int]) followed by a [string] error message. Then, depending on
  the exception, more content may follow. The error codes are defined in
  <a href="#s8">Section 8</a>, along with their additional content if any.

</pre>
  <h4 id="s4.2.2">4.2.2 READY</h4>
  <pre>  Indicates that the server is ready to process queries. This message will be
  sent by the server either after a STARTUP message if no authentication is
  required (if authentication is required, the server indicates readiness by
  sending a AUTH_RESPONSE message).

The body of a READY message is empty.

</pre>
  <h4 id="s4.2.3">4.2.3 AUTHENTICATE</h4>
  <pre>  Indicates that the server requires authentication, and which authentication
  mechanism to use.

This message will be sent following a STARTUP message if authentication is
  required and must be answered by a AUTH_RESPONSE message from the client.

The body consists of a single [string] indicating the full class name of the
  IAuthenticator in use.

</pre>
  <h4 id="s4.2.4">4.2.4 SUPPORTED</h4>
  <pre>  Indicates which startup options are supported by the server. This message
  comes as a response to an OPTIONS message.

</pre>
  <h4 id="s4.2.5">4.2.5 RESULT</h4>
  <pre>  The result to a query (QUERY, PREPARE, EXECUTE or BATCH messages).

The body for each kind (after the [int] kind) is defined below.

</pre>
  <h5 id="s4.2.5.1">4.2.5.1 Void</h5>
  <pre>  The rest of the body for a Void result is empty. It indicates that a query was
  successful without providing more information.

</pre>
  <h5 id="s4.2.5.2">4.2.5.2 Rows</h5>
  <pre>  Indicates a set of rows. The rest of the body of a Rows result is:
    &lt;metadata&gt;&lt;rows_count&gt;&lt;rows_content&gt;
  where:
    - &lt;metadata&gt; is composed of:
        &lt;flags&gt;&lt;columns_count&gt;[&lt;paging_state&gt;][&lt;new_metadata_id&gt;][&lt;global_table_spec&gt;?&lt;col_spec_1&gt;...&lt;col_spec_n&gt;]
      where:
        - &lt;flags&gt; is an [int]. The bits of &lt;flags&gt; provides information on the
          formatting of the remaining information. A flag is set if the bit
          corresponding to its `mask` is set. Supported flags are, given their
          mask:
            0x0001    Global_tables_spec: if set, only one table spec (keyspace
                      and table name) is provided as &lt;global_table_spec&gt;. If not
                      set, &lt;global_table_spec&gt; is not present.
            0x0002    Has_more_pages: indicates whether this is not the last
                      page of results and more should be retrieved. If set, the
                      &lt;paging_state&gt; will be present. The &lt;paging_state&gt; is a
                      [bytes] value that should be used in QUERY/EXECUTE to
                      continue paging and retrieve the remainder of the result for
                      this query (See <a href="#s7">Section 7</a> for more details).
            0x0004    No_metadata: if set, the &lt;metadata&gt; is only composed of
                      these &lt;flags&gt;, the &lt;column_count&gt; and optionally the
                      &lt;paging_state&gt; (depending on the Has_more_pages flag) but
                      no other information (so no &lt;global_table_spec&gt; nor &lt;col_spec_i&gt;).
                      This will only ever be the case if this was requested
                      during the query (see QUERY and RESULT messages).
            0x0008    Metadata_changed: if set, the No_metadata flag has to be unset
                      and &lt;new_metadata_id&gt; has to be supplied. This flag is to be
                      used to avoid a round trip in case of metadata changes for queries
                      that requested metadata to be skipped.
        - &lt;columns_count&gt; is an [int] representing the number of columns selected
          by the query that produced this result. It defines the number of &lt;col_spec_i&gt;
          elements in and the number of elements for each row in &lt;rows_content&gt;.
        - &lt;new_metadata_id&gt; is [short bytes] representing the new, changed result set
           metadata. The new metadata ID must also be used in subsequent executions of
           the corresponding prepared statement, if any.
        - &lt;global_table_spec&gt; is present if the Global_tables_spec is set in
          &lt;flags&gt;. It is composed of two [string] representing the
          (unique) keyspace name and table name the columns belong to.
        - &lt;col_spec_i&gt; specifies the columns returned in the query. There are
          &lt;column_count&gt; such column specifications that are composed of:
            (&lt;ks_name&gt;&lt;table_name&gt;)?&lt;name&gt;&lt;type&gt;
          The initial &lt;ks_name&gt; and &lt;table_name&gt; are two [string] and are only present
          if the Global_tables_spec flag is not set. The &lt;column_name&gt; is a
          [string] and &lt;type&gt; is an [option] that corresponds to the description
          (what this description is depends a bit on the context: in results to
          selects, this will be either the user chosen alias or the selection used
          (often a colum name, but it can be a function call too). In results to
          a PREPARE, this will be either the name of the corresponding bind variable
          or the column name for the variable if it is &#34;anonymous&#34;) and type of
          the corresponding result. The option for &lt;type&gt; is either a native
          type (see below), in which case the option has no value, or a
          &#39;custom&#39; type, in which case the value is a [string] representing
          the fully qualified class name of the type represented. Valid option
          ids are:
            0x0000    Custom: the value is a [string], see above.
            0x0001    Ascii
            0x0002    Bigint
            0x0003    Blob
            0x0004    Boolean
            0x0005    Counter
            0x0006    Decimal
            0x0007    Double
            0x0008    Float
            0x0009    Int
            0x000B    Timestamp
            0x000C    Uuid
            0x000D    Varchar
            0x000E    Varint
            0x000F    Timeuuid
            0x0010    Inet
            0x0011    Date
            0x0012    Time
            0x0013    Smallint
            0x0014    Tinyint
            0x0015    Duration
            0x0020    List: the value is an [option], representing the type
                            of the elements of the list.
            0x0021    Map: the value is two [option], representing the types of the
                           keys and values of the map
            0x0022    Set: the value is an [option], representing the type
                            of the elements of the set
            0x0030    UDT: the value is &lt;ks&gt;&lt;udt_name&gt;&lt;n&gt;&lt;name_1&gt;&lt;type_1&gt;...&lt;name_n&gt;&lt;type_n&gt;
                           where:
                              - &lt;ks&gt; is a [string] representing the keyspace name this
                                UDT is part of.
                              - &lt;udt_name&gt; is a [string] representing the UDT name.
                              - &lt;n&gt; is a [short] representing the number of fields of
                                the UDT, and thus the number of &lt;name_i&gt;&lt;type_i&gt; pairs
                                following
                              - &lt;name_i&gt; is a [string] representing the name of the
                                i_th field of the UDT.
                              - &lt;type_i&gt; is an [option] representing the type of the
                                i_th field of the UDT.
            0x0031    Tuple: the value is &lt;n&gt;&lt;type_1&gt;...&lt;type_n&gt; where &lt;n&gt; is a [short]
                             representing the number of values in the type, and &lt;type_i&gt;
                             are [option] representing the type of the i_th component
                             of the tuple

</pre>
  <h5 id="s4.2.5.3">4.2.5.3 Set_keyspace</h5>
  <pre>  The result to a `use` query. The body (after the kind [int]) is a single
  [string] indicating the name of the keyspace that has been set.

</pre>
  <h5 id="s4.2.5.4">4.2.5.4 Prepared</h5>
  <pre>  The result to a PREPARE message. The body of a Prepared result is:
    &lt;id&gt;&lt;result_metadata_id&gt;&lt;metadata&gt;&lt;result_metadata&gt;
  where:
    - &lt;id&gt; is [short bytes] representing the prepared query ID.
    - &lt;result_metadata_id&gt; is [short bytes] representing the result set metadata ID.
    - &lt;metadata&gt; is composed of:
        &lt;flags&gt;&lt;columns_count&gt;&lt;pk_count&gt;[&lt;pk_index_1&gt;...&lt;pk_index_n&gt;][&lt;global_table_spec&gt;?&lt;col_spec_1&gt;...&lt;col_spec_n&gt;]
      where:
        - &lt;flags&gt; is an [int]. The bits of &lt;flags&gt; provides information on the
          formatting of the remaining information. A flag is set if the bit
          corresponding to its `mask` is set. Supported masks and their flags
          are:
            0x0001    Global_tables_spec: if set, only one table spec (keyspace
                      and table name) is provided as &lt;global_table_spec&gt;. If not
                      set, &lt;global_table_spec&gt; is not present.
        - &lt;columns_count&gt; is an [int] representing the number of bind markers
          in the prepared statement.  It defines the number of &lt;col_spec_i&gt;
          elements.
        - &lt;pk_count&gt; is an [int] representing the number of &lt;pk_index_i&gt;
          elements to follow. If this value is zero, at least one of the
          partition key columns in the table that the statement acts on
          did not have a corresponding bind marker (or the bind marker
          was wrapped in a function call).
        - &lt;pk_index_i&gt; is a short that represents the index of the bind marker
          that corresponds to the partition key column in position i.
          For example, a &lt;pk_index&gt; sequence of [2, 0, 1] indicates that the
          table has three partition key columns; the full partition key
          can be constructed by creating a composite of the values for
          the bind markers at index 2, at index 0, and at index 1.
          This allows implementations with token-aware routing to correctly
          construct the partition key without needing to inspect table
          metadata.
        - &lt;global_table_spec&gt; is present if the Global_tables_spec is set in
          &lt;flags&gt;. If present, it is composed of two [string]s. The first
          [string] is the name of the keyspace that the statement acts on.
          The second [string] is the name of the table that the columns
          represented by the bind markers belong to.
        - &lt;col_spec_i&gt; specifies the bind markers in the prepared statement.
          There are &lt;column_count&gt; such column specifications, each with the
          following format:
            (&lt;ks_name&gt;&lt;table_name&gt;)?&lt;name&gt;&lt;type&gt;
          The initial &lt;ks_name&gt; and &lt;table_name&gt; are two [string] that are only
          present if the Global_tables_spec flag is not set. The &lt;name&gt; field
          is a [string] that holds the name of the bind marker (if named),
          or the name of the column, field, or expression that the bind marker
          corresponds to (if the bind marker is &#34;anonymous&#34;).  The &lt;type&gt;
          field is an [option] that represents the expected type of values for
          the bind marker.  See the Rows documentation (<a href="#s4.2.5.2">section 4.2.5.2</a>) for
          full details on the &lt;type&gt; field.

Note that the prepared query ID returned is global to the node on which the query
  has been prepared. It can be used on any connection to that node
  until the node is restarted (after which the query must be re-prepared).
</pre>
  <h5 id="s4.2.5.5">4.2.5.5 Schema_change</h5>
  <pre>  The result to a schema altering query (creation/update/drop of a
  keyspace/table/index). The body (after the kind [int]) is the same
  as the body for a &#34;SCHEMA_CHANGE&#34; event, so 3 strings:
    &lt;change_type&gt;&lt;target&gt;&lt;options&gt;
  Please refer to <a href="#s4.2.6">section 4.2.6</a> below for the meaning of those fields.

Note that a query to create or drop an index is considered to be a change
  to the table the index is on.

</pre>
  <h4 id="s4.2.6">4.2.6 EVENT</h4>
  <pre>  An event pushed by the server. A client will only receive events for the
  types it has REGISTER-ed to. The body of an EVENT message will start with a
  [string] representing the event type. The rest of the message depends on the
  event type. The valid event types are:
    - &#34;TOPOLOGY_CHANGE&#34;: events related to change in the cluster topology.
      Currently, events are sent when new nodes are added to the cluster, and
      when nodes are removed. The body of the message (after the event type)
      consists of a [string] and an [inet], corresponding respectively to the
      type of change (&#34;NEW_NODE&#34; or &#34;REMOVED_NODE&#34;) followed by the address of
      the new/removed node.
    - &#34;STATUS_CHANGE&#34;: events related to change of node status. Currently,
      up/down events are sent. The body of the message (after the event type)
      consists of a [string] and an [inet], corresponding respectively to the
      type of status change (&#34;UP&#34; or &#34;DOWN&#34;) followed by the address of the
      concerned node.
    - &#34;SCHEMA_CHANGE&#34;: events related to schema change. After the event type,
      the rest of the message will be &lt;change_type&gt;&lt;target&gt;&lt;options&gt; where:
        - &lt;change_type&gt; is a [string] representing the type of changed involved.
          It will be one of &#34;CREATED&#34;, &#34;UPDATED&#34; or &#34;DROPPED&#34;.
        - &lt;target&gt; is a [string] that can be one of &#34;KEYSPACE&#34;, &#34;TABLE&#34;, &#34;TYPE&#34;,
          &#34;FUNCTION&#34; or &#34;AGGREGATE&#34; and describes what has been modified
          (&#34;TYPE&#34; stands for modifications related to user types, &#34;FUNCTION&#34;
          for modifications related to user defined functions, &#34;AGGREGATE&#34;
          for modifications related to user defined aggregates).
        - &lt;options&gt; depends on the preceding &lt;target&gt;:
          - If &lt;target&gt; is &#34;KEYSPACE&#34;, then &lt;options&gt; will be a single [string]
            representing the keyspace changed.
          - If &lt;target&gt; is &#34;TABLE&#34; or &#34;TYPE&#34;, then
            &lt;options&gt; will be 2 [string]: the first one will be the keyspace
            containing the affected object, and the second one will be the name
            of said affected object (either the table, user type, function, or
            aggregate name).
          - If &lt;target&gt; is &#34;FUNCTION&#34; or &#34;AGGREGATE&#34;, multiple arguments follow:
            - [string] keyspace containing the user defined function / aggregate
            - [string] the function/aggregate name
            - [string list] one string for each argument type (as CQL type)

All EVENT messages have a streamId of -1 (<a href="#s2.4.1.3">Section 2.4.1.3</a>).

Please note that &#34;NEW_NODE&#34; and &#34;UP&#34; events are sent based on internal Gossip
  communication and as such may be sent a short delay before the binary
  protocol server on the newly up node is fully started. Clients are thus
  advised to wait a short time before trying to connect to the node (1 second
  should be enough), otherwise they may experience a connection refusal at
  first.
</pre>
  <h4 id="s4.2.7">4.2.7 AUTH_CHALLENGE</h4>
  <pre>  A server authentication challenge (see AUTH_RESPONSE (<a href="#s4.1.2">Section 4.1.2</a>) for more
  details).

The body of this message is a single [bytes] token. The details of what this
  token contains (and when it can be null/empty, if ever) depends on the actual
  authenticator used.

Clients are expected to answer the server challenge with an AUTH_RESPONSE
  message.
</pre>
  <h4 id="s4.2.8">4.2.8 AUTH_SUCCESS</h4>
  <pre>  Indicates the success of the authentication phase. See <a href="#s4.2.3">Section 4.2.3</a> for more
  details.

</pre>
  <h2 id="s5">5 Data Type Serialization Formats</h2>
  <pre>  This sections describes the serialization formats for all CQL data types
  supported by Cassandra through the native protocol.  These serialization
  formats should be used by client drivers to encode values for EXECUTE
  messages.  Cassandra will use these formats when returning values in
  RESULT messages.

As with the rest of the native protocol, all encodings are big-endian.
</pre>
  <h3 id="s5.1">5.1 ascii</h3>
  <pre>  A sequence of bytes in the ASCII range [0, 127].  Bytes with values outside of
  this range will result in a validation error.
</pre>
  <h3 id="s5.2">5.2 bigint</h3>
  <pre>  An eight-byte two&#39;s complement integer.
</pre>
  <h3 id="s5.3">5.3 blob</h3>
  <pre>  Any sequence of bytes.
</pre>
  <h3 id="s5.4">5.4 boolean</h3>
  <pre>  A single byte.  A value of 0 denotes &#34;false&#34;; any other value denotes &#34;true&#34;.
  (However, it is recommended that a value of 1 be used to represent &#34;true&#34;.)
</pre>
  <h3 id="s5.5">5.5 date</h3>
  <pre>  An unsigned integer representing days with epoch centered at 2^31.
  (unix epoch January 1st, 1970).
  A few examples:
    0:    -5877641-06-23
    2^31: 1970-1-1
    2^32: 5881580-07-11
</pre>
  <h3 id="s5.6">5.6 decimal</h3>
  <pre>  The decimal format represents an arbitrary-precision number.  It contains an
  [int] &#34;scale&#34; component followed by a varint encoding (see <a href="#s5.24">section 5.24</a>)
  of the unscaled value.  The encoded value represents &#34;&lt;unscaled&gt;E&lt;-scale&gt;&#34;.
  In other words, &#34;&lt;unscaled&gt; * 10 ^ (-1 * &lt;scale&gt;)&#34;.
</pre>
  <h3 id="s5.7">5.7 double</h3>
  <pre>  An 8 byte floating point number in the IEEE 754 binary64 format.
</pre>
  <h3 id="s5.8">5.8 duration</h3>
  <pre>  A duration is composed of 3 signed variable length integers ([vint]s).
  The first [vint] represents a number of months, the second [vint] represents
  a number of days, and the last [vint] represents a number of nanoseconds.
  The number of months and days must be valid 32 bits integers whereas the
  number of nanoseconds must be a valid 64 bits integer.
  A duration can either be positive or negative. If a duration is positive
  all the integers must be positive or zero. If a duration is
  negative all the numbers must be negative or zero.
</pre>
  <h3 id="s5.9">5.9 float</h3>
  <pre>  A 4 byte floating point number in the IEEE 754 binary32 format.
</pre>
  <h3 id="s5.10">5.10 inet</h3>
  <pre>  A 4 byte or 16 byte sequence denoting an IPv4 or IPv6 address, respectively.
</pre>
  <h3 id="s5.11">5.11 int</h3>
  <pre>  A 4 byte two&#39;s complement integer.
</pre>
  <h3 id="s5.12">5.12 list</h3>
  <pre>  A [int] n indicating the number of elements in the list, followed by n
  elements.  Each element is [bytes] representing the serialized value.
</pre>
  <h3 id="s5.13">5.13 map</h3>
  <pre>  A [int] n indicating the number of key/value pairs in the map, followed by
  n entries.  Each entry is composed of two [bytes] representing the key
  and value.
</pre>
  <h3 id="s5.14">5.14 set</h3>
  <pre>  A [int] n indicating the number of elements in the set, followed by n
  elements.  Each element is [bytes] representing the serialized value.
</pre>
  <h3 id="s5.15">5.15 smallint</h3>
  <pre>  A 2 byte two&#39;s complement integer.
</pre>
  <h3 id="s5.16">5.16 text</h3>
  <pre>  A sequence of bytes conforming to the UTF-8 specifications.
</pre>
  <h3 id="s5.17">5.17 time</h3>
  <pre>  An 8 byte two&#39;s complement long representing nanoseconds since midnight.
  Valid values are in the range 0 to 86399999999999
</pre>
  <h3 id="s5.18">5.18 timestamp</h3>
  <pre>  An 8 byte two&#39;s complement integer representing a millisecond-precision
  offset from the unix epoch (00:00:00, January 1st, 1970).  Negative values
  represent a negative offset from the epoch.
</pre>
  <h3 id="s5.19">5.19 timeuuid</h3>
  <pre>  A 16 byte sequence representing a version 1 UUID as defined by RFC 4122.
</pre>
  <h3 id="s5.20">5.20 tinyint</h3>
  <pre>  A 1 byte two&#39;s complement integer.
</pre>
  <h3 id="s5.21">5.21 tuple</h3>
  <pre>  A sequence of [bytes] values representing the items in a tuple.  The encoding
  of each element depends on the data type for that position in the tuple.
  Null values may be represented by using length -1 for the [bytes]
  representation of an element.
</pre>
  <h3 id="s5.22">5.22 uuid</h3>
  <pre>  A 16 byte sequence representing any valid UUID as defined by RFC 4122.
</pre>
  <h3 id="s5.23">5.23 varchar</h3>
  <pre>  An alias of the &#34;text&#34; type.
</pre>
  <h3 id="s5.24">5.24 varint</h3>
  <pre>  A variable-length two&#39;s complement encoding of a signed integer.

The following examples may help implementors of this spec:

Value | Encoding
  ------|---------
      0 |     0x00
      1 |     0x01
    127 |     0x7F
    128 |   0x0080
    129 |   0x0081
     -1 |     0xFF
   -128 |     0x80
   -129 |   0xFF7F

Note that positive numbers must use a most-significant byte with a value
  less than 0x80, because a most-significant bit of 1 indicates a negative
  value.  Implementors should pad positive values that have a MSB &gt;= 0x80
  with a leading 0x00 byte.
</pre>
  <h3 id="s5.25">5.25 vector</h3>
  <pre>  For a vector of n dimensions of a fixed-length type, a sequence of those n elements.
  For a vector with variable-length elements, the size of the elements will precede
  each element.  Each element is the [bytes] representing the serialized value.  The
  number of dimensions is not encoded, since it&#39;s part of the type definition.

</pre>
  <h2 id="s6">6 User Defined Types</h2>
  <pre>  This section describes the serialization format for User defined types (UDT),
  as described in <a href="#s4.2.5.2">section 4.2.5.2</a>.

</pre>
  <h2 id="s7">7 Result paging</h2>
  <pre>  The protocol allows for paging the result of queries. For that, the QUERY and
  EXECUTE messages have a &lt;result_page_size&gt; value that indicate the desired
  page size in CQL3 rows.

Only CQL3 queries that return a result set (RESULT message with a Rows `kind`)
  support paging. For other type of queries, the &lt;result_page_size&gt; value is
  ignored.

</pre>
  <h2 id="s8">8 Error codes</h2>
  <pre>  Let us recall that an ERROR message is composed of &lt;code&gt;&lt;message&gt;[...]
  (see 4.2.1 for details). The supported error codes, as well as any additional
  information the message may contain after the &lt;message&gt; are described below:
    0x0000    Server error: something unexpected happened. This indicates a
              server-side bug.
    0x000A    Protocol error: some client message triggered a protocol
              violation (for instance a QUERY message is sent before a STARTUP
              one has been sent)
    0x0100    Authentication error: authentication was required and failed. The
              possible reason for failing depends on the authenticator in use,
              which may or may not include more detail in the accompanying
              error message.
    0x1000    Unavailable exception. The rest of the ERROR message body will be
                &lt;cl&gt;&lt;required&gt;&lt;alive&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query that triggered
                     the exception.
                &lt;required&gt; is an [int] representing the number of nodes that
                           should be alive to respect &lt;cl&gt;
                &lt;alive&gt; is an [int] representing the number of replicas that
                        were known to be alive when the request had been
                        processed (since an unavailable exception has been
                        triggered, there will be &lt;alive&gt; &lt; &lt;required&gt;)
    0x1001    Overloaded: the request cannot be processed because the
              coordinator node is overloaded
    0x1002    Is_bootstrapping: the request was a read request but the
              coordinator node is bootstrapping
    0x1003    Truncate_error: error during a truncation error.
    0x1100    Write_timeout: Timeout exception during a write request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;writeType&gt;&lt;contentions&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           acknowledged the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;writeType&gt; is a [string] that describe the type of the write
                            that timed out. The value of that string can be one
                            of:
                             - &#34;SIMPLE&#34;: the write was a non-batched
                               non-counter write.
                             - &#34;BATCH&#34;: the write was a (logged) batch write.
                               If this type is received, it means the batch log
                               has been successfully written (otherwise a
                               &#34;BATCH_LOG&#34; type would have been sent instead).
                             - &#34;UNLOGGED_BATCH&#34;: the write was an unlogged
                               batch. No batch log write has been attempted.
                             - &#34;COUNTER&#34;: the write was a counter write
                               (batched or not).
                             - &#34;BATCH_LOG&#34;: the timeout occurred during the
                               write to the batch log when a (logged) batch
                               write was requested.
                             - &#34;CAS&#34;: the timeout occurred during the Compare And Set write/update.
                             - &#34;VIEW&#34;: the timeout occurred when a write involves
                               VIEW update and failure to acquire local view(MV)
                               lock for key within timeout
                             - &#34;CDC&#34;: the timeout occurred when cdc_total_space is
                               exceeded when doing a write to data tracked by cdc.
                &lt;contentions&gt; is a [short] that describes the number of contentions occurred during the CAS operation.
                              The field only presents when the &lt;writeType&gt; is &#34;CAS&#34;.
    0x1200    Read_timeout: Timeout exception during a read request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;data_present&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           response is required to achieve &lt;cl&gt;. Please note that
                           it is possible to have &lt;received&gt; &gt;= &lt;blockfor&gt; if
                           &lt;data_present&gt; is false. Also in the (unlikely)
                           case where &lt;cl&gt; is achieved but the coordinator node
                           times out while waiting for read-repair acknowledgement.
                &lt;data_present&gt; is a single byte. If its value is 0, it means
                               the replica that was asked for data has not
                               responded. Otherwise, the value is != 0.
    0x1300    Read_failure: A non-timeout exception during a read request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;reason_map&gt;&lt;data_present&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;reason_map&gt; is a map of endpoint to failure reason codes. This maps
                            the endpoints of the replica nodes that failed when
                            executing the request to a code representing the reason
                            for the failure. The map is encoded starting with an [int] n
                            followed by n pairs of &lt;endpoint&gt;&lt;failure_code&gt; where
                            &lt;endpoint&gt; is an [inetaddr] and &lt;failure_code&gt; is a [short].
                            The currently defined &lt;failure_code&gt; values are:
                             - 0x0000  UNKNOWN: the failure reason is
                               unknown. This code is also used when the
                               coordinator receives an unrecognized code
                               from a replica running a newer version, for
                               forward compatibility. Clients should handle
                               unknown failure codes gracefully.
                             - 0x0001  READ_TOO_MANY_TOMBSTONES: the read
                               scanned too many tombstones on the replica
                               and was aborted. The threshold is configured
                               by tombstone_failure_threshold in
                               cassandra.yaml (default: 100000).
                             - 0x0002  TIMEOUT: the replica did not respond
                               to the coordinator within the expected
                               timeout for this operation. This is a
                               per-replica failure reported within the
                               &lt;reason_map&gt;; it differs from Read_timeout
                               (0x1200) and Write_timeout (0x1100), which
                               indicate that the overall consistency level
                               could not be met.
                             - 0x0003  INCOMPATIBLE_SCHEMA: the replica
                               could not process the request because its
                               schema differs from the coordinator&#39;s (e.g.
                               a column or table referenced in the request
                               is not recognized). This can occur during
                               rolling upgrades or when schema changes have
                               not yet propagated to all nodes.
                             - 0x0004  READ_SIZE: the amount of data read
                               on the replica exceeded a configured size
                               threshold and the read was aborted. The
                               thresholds are local_read_size_fail_threshold
                               and row_index_read_size_fail_threshold in
                               cassandra.yaml (both disabled by default;
                               require read_thresholds_enabled: true).
                             - 0x0005  NODE_DOWN: the replica was known to
                               be down when the coordinator was assembling
                               the request. The replica was never contacted.
                             - 0x0006  INDEX_NOT_AVAILABLE: a secondary
                               index required by the query is not yet
                               available on the replica. This can occur
                               after a node restart, before the index has
                               completed its initial build or recovery.
                             - 0x0007  READ_TOO_MANY_INDEXES: the read
                               referenced more SSTable indexes via SAI
                               (Storage-Attached Indexes) than the
                               configured guardrail allows. The threshold
                               is sai_sstable_indexes_per_query_fail_threshold
                               in cassandra.yaml.
                             - 0x0008  NOT_CMS: the request was sent to a
                               node that is not a member of the Cluster
                               Metadata Service (CMS), but the operation
                               requires a CMS member.
                             - 0x0009  INVALID_ROUTING: the replica does
                               not own the token or token range for the
                               requested data according to its current
                               cluster metadata. This typically indicates
                               that the coordinator&#39;s topology view is
                               stale.
                             - 0x000A  COORDINATOR_BEHIND: the coordinator&#39;s
                               cluster metadata is behind the replica&#39;s
                               (e.g. it references a table that has been
                               dropped, or does not yet know about a table
                               that has been created). The coordinator
                               needs to update its metadata before retrying.
                             - 0x000B  RETRY_ON_DIFFERENT_TRANSACTION_SYSTEM:
                               the operation was attempted using one
                               transaction system (Accord or Paxos) but
                               must be retried using the other, because
                               the data is managed by or conflicts with
                               operations on the other system.
                             - 0x01F7  INDEX_BUILD_IN_PROGRESS: a secondary
                               index required by the query is currently
                               being rebuilt on the replica and cannot
                               serve reads until the build completes. This
                               is a more specific form of
                               INDEX_NOT_AVAILABLE (0x0006).
                &lt;data_present&gt; is a single byte. If its value is 0, it means
                               the replica that was asked for data had not
                               responded. Otherwise, the value is != 0.
    0x1400    Function_failure: A (user defined) function failed during execution.
              The rest of the ERROR message body will be
                &lt;keyspace&gt;&lt;function&gt;&lt;arg_types&gt;
              where:
                &lt;keyspace&gt; is the keyspace [string] of the failed function
                &lt;function&gt; is the name [string] of the failed function
                &lt;arg_types&gt; [string list] one string for each argument type (as CQL type) of the failed function
    0x1500    Write_failure: A non-timeout exception during a write request. The rest
              of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;&lt;reason_map&gt;&lt;write_type&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           answered the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.
                &lt;reason_map&gt; is a map of endpoint to failure reason codes. This maps
                            the endpoints of the replica nodes that failed when
                            executing the request to a code representing the reason
                            for the failure. The map is encoded starting with an [int] n
                            followed by n pairs of &lt;endpoint&gt;&lt;failure_code&gt; where
                            &lt;endpoint&gt; is an [inetaddr] and &lt;failure_code&gt; is a [short].
                            See the &lt;failure_code&gt; values defined in
                            Read_failure (0x1300) above. The same set of
                            codes applies to write failures.
                &lt;writeType&gt; is a [string] that describes the type of the write
                            that failed. The value of that string can be one
                            of:
                             - &#34;SIMPLE&#34;: the write was a non-batched
                               non-counter write.
                             - &#34;BATCH&#34;: the write was a (logged) batch write.
                               If this type is received, it means the batch log
                               has been successfully written (otherwise a
                               &#34;BATCH_LOG&#34; type would have been sent instead).
                             - &#34;UNLOGGED_BATCH&#34;: the write was an unlogged
                               batch. No batch log write has been attempted.
                             - &#34;COUNTER&#34;: the write was a counter write
                               (batched or not).
                             - &#34;BATCH_LOG&#34;: the failure occurred during the
                               write to the batch log when a (logged) batch
                               write was requested.
                             - &#34;CAS&#34;: the failure occurred during the Compare And Set write/update.
                             - &#34;VIEW&#34;: the failure occurred when a write involves
                               VIEW update and failure to acquire local view(MV)
                               lock for key within timeout
                             - &#34;CDC&#34;: the failure occurred when cdc_total_space is
                               exceeded when doing a write to data tracked by cdc.
    0x1600    CDC_WRITE_FAILURE: // todo
    0x1700    CAS_WRITE_UNKNOWN: An exception occurred due to contended Compare And Set write/update.
              The CAS operation was only partially completed and the operation may or may not get completed by
              the contending CAS write or SERIAL/LOCAL_SERIAL read. The rest of the ERROR message body will be
                &lt;cl&gt;&lt;received&gt;&lt;blockfor&gt;
              where:
                &lt;cl&gt; is the [consistency] level of the query having triggered
                     the exception.
                &lt;received&gt; is an [int] representing the number of nodes having
                           acknowledged the request.
                &lt;blockfor&gt; is an [int] representing the number of replicas whose
                           acknowledgement is required to achieve &lt;cl&gt;.

0x2000    Syntax_error: The submitted query has a syntax error.
    0x2100    Unauthorized: The logged user doesn&#39;t have the right to perform
              the query.
    0x2200    Invalid: The query is syntactically correct but invalid.
    0x2300    Config_error: The query is invalid because of some configuration issue
    0x2400    Already_exists: The query attempted to create a keyspace or a
              table that was already existing. The rest of the ERROR message
              body will be &lt;ks&gt;&lt;table&gt; where:
                &lt;ks&gt; is a [string] representing either the keyspace that
                     already exists, or the keyspace in which the table that
                     already exists is.
                &lt;table&gt; is a [string] representing the name of the table that
                        already exists. If the query was attempting to create a
                        keyspace, &lt;table&gt; will be present but will be the empty
                        string.
    0x2500    Unprepared: Can be thrown while a prepared statement tries to be
              executed if the provided prepared statement ID is not known by
              this host. The rest of the ERROR message body will be [short
              bytes] representing the unknown ID.
</pre>
  <h2 id="s9">9 Changes from v4</h2>
  <pre>  * Added result set metadata id to Prepared responses (<a href="#s4.2.5.4">Section 4.2.5.4</a>)
  * Beta protocol flag for v5 native protocol is added (<a href="#s2.2">Section 2.2</a>)
  * &lt;num_failures&gt; in Read_failure and Write_failure error message bodies (<a href="#s9">Section 9</a>)
    has been replaced with &lt;reason_map&gt;. The &lt;reason_map&gt; maps node IP addresses to
    a failure reason code which indicates why the request failed on that node.
  * Enlarged flag&#39;s bitmaps for QUERY, EXECUTE and BATCH messages from [byte] to [int]
    (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.6">4.1.6</a> and <a href="#s4.1.7">4.1.7</a>).
  * Add the duration data type
  * Added keyspace field in QUERY, PREPARE, and BATCH messages (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.5">4.1.5</a>, and <a href="#s4.1.7">4.1.7</a>).
  * Added now_in_seconds field in QUERY, EXECUTE, and BATCH messages (Sections <a href="#s4.1.4">4.1.4</a>, <a href="#s4.1.6">4.1.6</a>, and <a href="#s4.1.7">4.1.7</a>).
  * Added [int] flags field in PREPARE message (<a href="#s4.1.5">Section 4.1.5</a>).
  * Removed NO_COMPACT startup option (<a href="#s4.1.1">Section 4.1.1</a>.)
  * Introduces outer framing format wrapping the &#34;frames&#34; of v4 and earlier, which are
    now referred to as &#34;envelopes&#34; (Sections <a href="#s2.1">2.1</a>, <a href="#s2.2">2.2</a> and <a href="#s2.3">2.3</a>)</pre>
</body>
</html>