Console in clustered TypeDB

TypeDB Console has been updated to connect to TypeDB clusters and automatically operate across multiple server replicas. The interface is experimental and may change between releases. You’ll need an alpha version of TypeDB Console. These are published alongside the mainstream versions, starting with 3.7.0. To access the releases, visit the TypeDB Console GitHub page and look for the most recent Pre-release item containing the alpha suffix (e.g., TypeDB Console 3.7.0-alpha-2).

What’s different in a clustered deployment?

In a single-server deployment, the data is stored on one single machine, and a client can access it only through this one server address.

In a clustered deployment, this information is replicated between a cluster of servers using the Raft consensus algorithm. The users can perform operations across multiple replicas:

  • a primary replica (serves strongly consistent operations),

  • one or more secondary replicas (can serve eventually consistent idempotent operations and be used for failover).

Cluster-enabled Console adds:

  • Flexible connection addresses (single, multiple, or translated).

  • Replica discovery (learning replica addresses from the server).

  • Server inspection commands (list servers, show primary, check version).

Connecting to a cluster

Console supports three connection modes.

Single address

Use this when you have one stable endpoint (for example, a load balancer, or a known replica address):

typedb console --address=host1:port1

Even if the cluster has multiple replicas, Console can discover peers from the server and update its connection targets automatically.

Multiple addresses

If you do not know which replica is available, or you want to increase the chance of connecting when some replicas are down, provide multiple addresses:

typedb console --address=host1:port1,host2:port2,host3:port3

Address translation

When replicas advertise private addresses internally (e.g. Docker/Kubernetes/VPC), while clients connect through public addresses, use address translation.

Provide a comma-separated list of public=private pairs:

typedb console --address-translation=public-1.domain:1729=10.0.0.11:1729,public-2.domain:1729=10.0.0.12:1729

This allows Console to translate replica addresses returned by the server into addresses reachable from your environment.

Server inspection commands

Cluster-enabled Console adds commands to inspect server state. All server commands accept an optional address argument to route the request to a specific server (equivalent to ServerRouting.Direct in the driver API). When no address is given, the request is routed automatically.

server list

Lists servers known to the cluster with their statuses:

>> server list
 id | address                     | role      | term  | status
--------------------------------------------------------------------
 1  | ...-0.cluster.typedb.com:80 | secondary | 37    | available
 2  | ...-1.cluster.typedb.com:80 | secondary | 37    | available
 3  | ...-2.cluster.typedb.com:80 | primary   | 37    | available

To query a specific server directly:

>> server list host1:port1

server primary

Shows the current primary server:

>> server primary

server version

Retrieves the TypeDB server version:

>> server version

To check the version of a specific server:

>> server version host2:port2

Server roles may change over time (for example, during failover or re-election). Use server list to see up-to-date roles and statuses across all replicas.

Next steps