Connections

Overview

To interact with a TypeDB database, a client application must first establish a connection to the server. This is typically done using a TypeDB driver for your chosen programming language (e.g., Python, Java, Rust, Node.js) or through a tool like the TypeDB Console or TypeDB Studio.

A connection requires the server’s address (host and port) and valid user credentials. For production environments, a secure connection using TLS is strongly recommended.

Connecting to TypeDB

  • Studio

  • Console

For a cloud deployment:

  1. In the TypeDB Cloud website, navigate to your cluster and click Connect. Then, click Connect with TypeDB Studio. This will launch TypeDB Studio.

  2. Fill in your password and hit Connect. Your password can be found in your downloaded credentials file (if you have one).

For an Enterprise or Community Edition deployment:

  1. Launch TypeDB Studio.

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000.

  3. Enter your username and password.

  4. Click Connect.

Run Console in CLI:

Connect to TypeDB
typedb console --address=<server-address> --username=<username>

You will be prompted for a password.

Connecting your application

For programmatic access using gRPC, use one of the TypeDB driver to connect via the network API.

All TypeDB Drivers follow the same API as closely as possible, so moving between languages is simple.

Some languages also have a helper driver library that abstracts away usage of the HTTP API. See the references pages for gRPC drivers or the HTTP helper libraries. You can also always use the raw HTTP api.