TypeDB 3.0 is live! Get started for free.

TypeDB Community Edition

Preliminaries

Connecting to TypeDB CE requires:

  • The address and port of the server - defaults are 127.0.0.1 and 1729

  • A valid username and password - default credentials are admin and password

Connecting your client

  • Console

  • Studio

Run Console in CLI:

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

You will be prompted for a password.

Use --tls-disabled to connect to a server without encryption.

Run Studio and follow instructions below:

  1. Launch TypeDB Studio.

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000 and for local instances you can use http://localhost:8000.

  3. Enter your username and password.

  4. Click Connect.

Connecting your application

For programmatic access, use one of the TypeDB drivers via the network API:

  • Rust

  • Python

  • Java

  • Node.js

  • C#

  • C++

  • C

  • HTTP

let uri = format!("{}:{}", address, port);
let driver = TypeDBDriver::new(
    &uri,
    Credentials::new(username, password),
    DriverOptions::new(false, None).unwrap(),
).await;
uri = f"{address}:{port}"
driver = TypeDB.driver(uri, Credentials(username, password), DriverOptions(False, None))
uri = String.format("%s:%s", address, port)
Driver driver = TypeDB.driver(uri, new Credentials(username, password), new DriverOptions(false, null));
Coming soon.
Coming soon.
Coming soon.
Coming soon.

Send a sign in HTTP request:

curl
curl --request POST \
  --url {http/https}://{address}:{http_port}/v1/signin \
  --json '{"username": "USERNAME", "password": "PASSWORD"}'

Note that the {http_port} is different from the regular TypeDB port mentioned above and is defaulted to 8000.

A successful response will contain an authentication token:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImV4cCI6MTc0NDYzNTI5NSwiaWF0IjoxNzQ0NjIwODk1fQ.WEhmBTAXI_qZUlAB7zw52LDGJhnqfNTXS63QDSZlqds"
}

Put it in the authorization header of the future requests. See HTTP endpoint authentication for more information.