TypeDB 3.0 is live! Get started for free.

TypeDB Enterprise

Preliminaries

Connecting to TypeDB Enterprise requires:

  • A running TypeDB Enterprise cluster.

  • The address and port of each server node.

  • A valid username and password.

  • A valid TLS certificate for in-flight encryption.

Connecting your client

  • Console

  • Studio

Run Console using the --cloud argument to set the address and port to connect to:

Connect to TypeDB Cloud or TypeDB Enterprise
typedb console --cloud=<server-address> --username=<username> --password --tls-enabled=true

You will be prompted for a password.

The --cloud argument is used to set the TypeDB Cloud server address and port to connect to, for example, https://abcdef-0.cluster.typedb.com:80.

Run Studio and follow instructions below:

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

  2. The Connect to your cluster dialog will display the connection URI for your cluster, with a placeholder: <db_password>.

  3. In TypeDB Studio, click Connect to TypeDB in the top right corner.

  4. Select TypeDB Cloud. Copy in the Connection URI, and replace <db_password> with your actual password. Consider saving this connection URI in a secure location. .

  5. Select TypeDB Cloud.

  6. Click Manage Cloud Addresses button.

  7. Add address and port for at least one server from your TypeDB Cloud deployment, then close the Address Management window.

  8. Fill in the Username and Password fields with valid user credentials.

  9. Turn on the Enable TLS option and leave the CA Certificate field empty. For self-hosted deployments, encryption parameters may vary.

  10. 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

let uri = format!("{}:{}", address, port);
let driver = TypeDBDriver::new_cloud(
    &vec![&uri],
    Credentials::new(username, password),
    DriverOptions::new(true, None).unwrap(),
).await;
uri = f"{address}:{port}"
driver = TypeDB.cloud_driver([uri], Credentials(username, password), DriverOptions(False, None))
uri = String.format("%s:%s", address, port)
Driver driver = TypeDB.cloudDriver(
        Set.of(uri),
        new Credentials(username, password),
        new DriverOptions(true, null)
);
Coming soon.
Coming soon.
Coming soon.
Coming soon.