Bolt (network protocol)


The Bolt Protocol is a connection oriented network protocol used for client-server communication in database applications. It operates over a TCP connection or WebSocket.
Bolt is statement-oriented, allowing a client to send messages containing a statement consisting of a single string and a set of typed parameters. The server responds to each statement with a result message and an optional stream of result records.
Developed for use in the Neo4j graph database, Bolt was heavily inspired by the binary network protocol of PostgreSQL and features a data interchange format derived from MessagePack.

History

The Bolt protocol was first introduced to the public in November 2015, during an interview conducted by Duncan Brown and published on . The first release of software implementing the protocol occurred in December 2015, as part of a milestone release of Neo4j Server. In April 2016, Neo4j Server 3.0 was released and contained the first server implementation of the protocol, accompanied by a suite of Bolt client drivers. This release received attention from several mainstream media outlets.

Versioning

The protocol supports explicit versioning and version negotiation between the client and the server. There is only one published version of the protocol: version 1.

Protocol Overview - Version 1

Messaging

Bolt clients and servers both send data over the connection as a sequence of messages. Each message has a type and may include additional data. The client drives the interaction, and each message sent by the client will cause one or more response messages to be sent by the server.
Client messages:
TypeSignature
INIT0x01
RUN0x10
DISCARD_ALL0x2F
PULL_ALL0x3F
ACK_FAILURE0x0E
RESET0x0F

Server messages:
TypeSignature
SUCCESS0x70
FAILURE0x7F
IGNORED0x7E
RECORD0x71

Message Transfer Encoding

Each message is encoded into a sequence of bytes. These bytes are transferred using a binary chunked encoding, where each chunk is preceded by an unsigned, big-endian 16-bit integer denoting the number of bytes that immediately follow. A length of 0 is used to denote the end of the message.

Failure Handling

A client may send multiple messages to a server, without first waiting for a response. The server processes each message sequentially. However, as there may be logical dependencies between messages sent by the client, the server will not evaluate requests it receives after sending FAILURE in response to a preceding message. Instead, it will send an IGNORED message in reply to every client message, until the client acknowledges the failure by sending an ACK_FAILURE message.
This is similar to the failure handling and recovery in the PostgreSQL wire protocol.

Data Encoding

Bolt supports encoding for a number of different data types.
TypeDescription
NullRepresents the absence of a value.
BooleanBoolean true or false.
Integer64-bit signed integer.
Float64-bit floating point number.
StringUTF-8 encoded string.
ListOrdered collection of values.
MapUnordered, keyed collection of values.
NodeA node in a Property Graph with optional properties and labels.
RelationshipA directed, typed connection between two nodes in a Property Graph. Each relationship may have properties and always has an identity.
PathThe record of a directed walk through a Property Graph, consisting of a sequence of zero or more segments.