Bolt (network protocol)

Bolt

Original author(s)	Neo Technology
Stable release	Version 1
Written in	Various languages
Operating system	Any
Platform	Cross-platform
Type	Network protocol
License	Creative Commons 3.0 Attribution-ShareAlike
Website	boltprotocol.org

The Bolt Protocol (Bolt) 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.

History

The Bolt protocol was first introduced to the public in November 2015, during an interview conducted by Duncan Brown and published on DZone. 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

A typical interaction in the Bolt network protocol

Bolt clients and servers both send data over the connection as a sequence of messages. Each message has a type (denoted by a "signature" byte) 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:

Type	Signature
INIT	0x01
RUN	0x10
DISCARD_ALL	0x2F
PULL_ALL	0x3F
ACK_FAILURE	0x0E
RESET	0x0F

Server messages:

Type	Signature
SUCCESS	0x70
FAILURE	0x7F
IGNORED	0x7E
RECORD	0x71

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.

Type	Description
Null	Represents the absence of a value.
Boolean	Boolean true or false.
Integer	64-bit signed integer.
Float	64-bit floating point number.
String	UTF-8 encoded string.
List	Ordered collection of values.
Map	Unordered, keyed collection of values.
Node	A node in a Property Graph with optional properties and labels.
Relationship	A directed, typed connection between two nodes in a Property Graph. Each relationship may have properties and always has an identity.
Path	The record of a directed walk through a Property Graph, consisting of a sequence of zero or more segments.

External links

• Bolt protocol specification