Skip to content
Amaquet Docs
Amaquet logo

Amaquet documentation

Use this documentation to install, operate, integrate with, and contribute to Amaquet.

CI Soak

Amaquet is a standalone, Redis-like in-memory database written in Go. It does not run on Redis and it does not use Redis as a storage backend. The core database stores Amaquet values directly in process memory and exposes them through the Amaquet binary protocol.

The repository includes the database server, a Go client, amaquet-cli, an HTTP administration API, optional append-only persistence, API-key authentication, RBAC, Ed25519 protocol identity, Docker deployment assets, deterministic tests, and fuzzing tools.

Main capabilities

Section titled “Main capabilities”

Amaquet combines a typed in-memory data plane with a separate HTTP control plane. The following list summarizes the implemented protocol, storage, persistence, administration, and test surfaces.

  • Custom amaquet:// protocol on TCP and amaquets:// on TLS.
  • 91 stable wire-level data types.
  • Strongly typed nested values for collections and messaging structures.
  • 256-shard concurrent keyspace with TTL and key versions.
  • Optional CRC-protected append-only operation journal.
  • Organization, member, API-key, RBAC, system, data-access, and audit administration APIs.
  • HTTP administration API for control-plane operations and metrics.
  • Per-type Bash test and fuzz entrypoints plus raw-frame fuzzing.

Where to start

Section titled “Where to start”

Read these pages in order for a first installation; operators and client authors can then branch into the architecture, persistence, and protocol references that match their work.

  1. Install Amaquet.
  2. Follow the quick start.
  3. Read the configuration reference.
  4. Review the data-type catalog.
  5. Read the Amaquet protocol if you are building a client.
  6. Review architecture and persistence before production deployment.

Process model

Section titled “Process model”

Amaquet exposes a TCP/TLS data-plane listener and a separate HTTP control-plane listener:

flowchart TB
  Client["Native client"] -->|Amaquet protocol on :13378| Protocol["TCP/TLS protocol server"]
  Protocol --> Authorization["Dispatcher and RBAC"]
  Authorization --> Engine["In-memory core engine"]

  Automation["Automation or curl"] -->|HTTP on :13379| Admin["Admin HTTP API"]
  Admin -. control-plane operations .-> Authorization
  Admin -. shared in-memory state .-> Engine

The administration API is a control-plane surface. It is not used as a backing data store.