Module handshake 

Handshake frames and per-operation limits for the native binary protocol.

Structs

HelloAckFrame

Server’s response to a HelloFrame.

HelloErrorFrame

Frame sent by the server when it rejects a HelloFrame.

HelloFrame

First frame sent by the client after TCP connection.

Limits

Per-operation capability limits negotiated during the connection handshake.

Enums

HelloErrorCode

Error code sent in a HelloErrorFrame when the server rejects a handshake.

Constants

CAP_COLUMNAR

Capability bit: server supports columnar scan.

CAP_CRDT

Capability bit: server supports CRDT sync.

CAP_FTS

Capability bit: server supports full-text search opcodes.

CAP_GRAPHRAG

Capability bit: server supports GraphRAG fusion (GraphRagFusion opcode).

CAP_MSGPACK

Capability bit: connection uses MessagePack framing (always set for native protocol).

CAP_SPATIAL

Capability bit: server supports spatial operations.

CAP_STREAMING

Capability bit: server supports streaming (partial-response chunking).

CAP_TIMESERIES

Capability bit: server supports timeseries operations.

DEFAULT_NATIVE_PORT

Default server port for the native protocol.

FRAME_HEADER_LEN

Length of the frame header (4-byte big-endian u32 payload length).

HELLO_ACK_MAGIC

Magic bytes for HelloAckFrame: b“NDBA“.

HELLO_ERROR_MAGIC

Magic bytes for HelloErrorFrame: b"NDBE".

HELLO_ERROR_MAGIC_U32

Magic for HelloErrorFrame as a u32 (big-endian: 0x4E44_4245).

HELLO_MAGIC

Magic bytes for HelloFrame: b“NDBH“.

MAX_FRAME_SIZE

Maximum frame payload size (16 MiB).

PROTO_VERSION

Current native protocol version advertised in HelloFrame.

PROTO_VERSION_MAX

Maximum protocol version this server can speak.

PROTO_VERSION_MIN

Minimum protocol version this server accepts from clients.