TypeDB Community Edition
Preliminaries
Connecting to TypeDB CE requires:
-
The
address
andport
of the server - defaults are127.0.0.1
and1729
-
A valid
username
andpassword
- default credentials areadmin
andpassword
Connecting your client
-
Console
-
Studio
Run Console in CLI:
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:
-
Click Connect to TypeDB on the right side of the top toolbar.
-
Make sure the
TypeDB Core
option is selected in theServer
field. -
Enter the address and port of the server to connect to (e.g.
localhost:1729
). -
Fill in the
Username
andPassword
fields with valid user credentials. -
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 --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.