ClickHouse/dbms/src/Core/Protocol.h

128 lines
5.1 KiB
C++
Raw Normal View History

2012-03-09 15:46:52 +00:00
#pragma once
#include <Core/Types.h>
2012-03-09 15:46:52 +00:00
namespace DB
{
2017-04-17 19:26:59 +00:00
/// Client-server protocol.
///
/// Client opens a connection and sends Hello packet.
/// If client version is incompatible, the server can terminate the connection.
/// Server responds with Hello packet.
/// If server version is incompatible, the client can terminate the connection.
///
/// The main loop follows:
///
/// 1. The client sends Query packet.
///
/// Starting from version 50263 immediately after sending the Query packet the client starts
/// transfer of external (temporary) table (external storages) - one or several Data packets.
/// End of transmission is marked by an empty block.
/// At present, non-empty tables can be sent only along with SELECT query.
///
/// If the query is an INSERT (and thus requires data transfer from client), then the server transmits
/// Data packet containing empty block that describes the table structure.
/// Then the client sends one or several Data packets - data for insertion.
/// End of data is marked by the transmission of empty block.
/// Then the server sends EndOfStream packet.
///
/// If the query is a SELECT or a query of other type, then the server transmits packets of
/// one of the following types:
/// - Data - data corresponding to one block of query results.
/// - Progress - query execution progress.
/// - Exception - error description.
/// - EndOfStream - the end of data transmission.
///
/// The client should read packets until EndOfStream or Exception.
///
/// The client can also send Cancel packet - a request to cancel the query.
/// In this case the server can stop executing the query and return incomplete data,
/// but the client must still read until EndOfStream packet.
///
/// Also if there is profiling info and the client revision is recent enough, the server can
/// send one of the following packets before EndOfStream:
/// - Totals - a block with total values
/// - ProfileInfo - serialized BlockStreamProfileInfo structure.
///
/// If a query returns data, the server sends an empty header block containing
/// the description of resulting columns before executing the query.
/// Using this block the client can initialise the output formatter and display the prefix of resulting table
/// beforehand.
2012-03-09 15:46:52 +00:00
namespace Protocol
{
2017-04-17 19:26:59 +00:00
/// Packet types that server transmits.
namespace Server
{
enum Enum
{
2017-04-17 19:26:59 +00:00
Hello = 0, /// Name, version, revision.
Data = 1, /// A block of data (compressed or not).
Exception = 2, /// The exception during query execution.
Progress = 3, /// Query execution progress: rows read, bytes read.
Pong = 4, /// Ping response
EndOfStream = 5, /// All packets were transmitted
ProfileInfo = 6, /// Packet with profiling info.
Totals = 7, /// A block with totals (compressed or not).
Extremes = 8, /// A block with minimums and maximums (compressed or not).
TablesStatusResponse = 9, /// A response to TablesStatus request.
};
2012-05-23 19:51:30 +00:00
2017-04-17 19:26:59 +00:00
/// NOTE: If the type of packet argument would be Enum, the comparison packet >= 0 && packet < 10
/// would always be true because of compiler optimisation. That would lead to out-of-bounds error
/// if the packet is invalid.
/// See https://www.securecoding.cert.org/confluence/display/cplusplus/INT36-CPP.+Do+not+use+out-of-range+enumeration+values
inline const char * toString(UInt64 packet)
{
static const char * data[] = { "Hello", "Data", "Exception", "Progress", "Pong", "EndOfStream", "ProfileInfo", "Totals", "Extremes", "TablesStatusResponse" };
return packet < 10
? data[packet]
: "Unknown packet";
}
}
2012-03-09 15:46:52 +00:00
2017-04-17 19:26:59 +00:00
/// Packet types that client transmits.
namespace Client
{
enum Enum
{
2017-04-17 19:26:59 +00:00
Hello = 0, /// Name, version, revision, default DB
Query = 1, /// Query id, query settings, stage up to which the query must be executed,
/// whether the compression must be used,
/// query text (without data for INSERTs).
Data = 2, /// A block of data (compressed or not).
Cancel = 3, /// Cancel the query execution.
Ping = 4, /// Check that connection to the server is alive.
TablesStatusRequest = 5, /// Check status of tables on the server.
};
2012-05-23 19:51:30 +00:00
inline const char * toString(UInt64 packet)
{
static const char * data[] = { "Hello", "Query", "Data", "Cancel", "Ping", "TablesStatusRequest" };
return packet < 6
? data[packet]
: "Unknown packet";
}
}
2012-03-11 08:52:56 +00:00
2017-04-17 19:26:59 +00:00
/// Whether the compression must be used.
2017-10-03 14:52:08 +00:00
enum class Compression
{
2017-10-03 14:52:08 +00:00
Disable = 0,
Enable = 1,
};
2017-09-28 19:43:31 +00:00
/// Whether the ssl must be used.
2017-10-03 14:52:08 +00:00
enum class Encryption
2017-09-28 19:43:31 +00:00
{
2017-10-03 14:52:08 +00:00
Disable = 0,
Enable = 1,
};
2012-03-09 15:46:52 +00:00
}
}