Go to the directory whe you have your typedb-all or typedb-console distribution unarchived, and run ./typedb console
cd <your_typedb_console_dir>/
./typedb console
You can provide several command arguments when running console in the terminal.
--core=<address>: TypeDB server address to which the console will connect to.--cloud=<address>: TypeDB Cloud server address to which the console will connect to.--username=<username>: TypeDB Cloud username to connect with.--password: Interactively enter password to connect to TypeDB Cloud with.--script=<script>: Run commands in the script file in non-interactive mode.--tls-enabled: Enable TLS for connecting to TypeDB Cloud.--tls-root-ca: Path to root CA certificate for TLS encryption.--command=<command1> --command=<command2> ...: Run commands in non-interactive mode.-V, --version: Print version information and exit.-h, --help: Show help message.
TypeDB Console provides two levels of interaction: database-level commands and transaction-level commands. The database-level command is the first level of interaction, i.e. first-level REPL. From one of the database-level commands, you can open a transaction to the database. This will open a transaction-level interface, i.e. second-level REPL.
Console also offers command completion, accessible with a tab keypress.
database create <db>: Create a database with name<db>on the server. For example:> database create my-typedb-database Database 'my-typedb-database' createddatabase list: List the databases on the server. For example:> database list my-typedb-databasedatabase delete <db>: Delete a database with name<db>on the server. For example:> database delete my-typedb-database Database 'my-typedb-database' deleteddatabase schema <db>: Print the schema of a database with name<db>on the server. For example:> database schema my-typedb-database define person sub entity;transaction <db> schema|data read|write: Start a transaction to database<db>with session typeschemaordata, and transaction typewriteorread. For example:This will then take you to the transaction-level interface, i.e. the second-level REPL.> transaction my-typedb-database schema write my-typedb-database::schema::write>help: Print help menuclear: Clear console screenexit: Exit console
<query>: Once you're in the transaction REPL, the terminal immediately accepts a multi-line TypeQL query, and will execute it when you hit enter twice. For example:my-typedb-database::schema::write> define name sub attribute, value string; person sub entity, owns name; Concepts have been definedsource <file>: Run TypeQL queries in a file, which you can refer to using relative or absolute path. For example:my-typedb-database::schema::write> source ./schema.gql Concepts have been definedcommit: Commit the transaction changes and close transaction. For example:my-typedb-database::schema::write> commit Transaction changes committedrollback: Will remove any uncommitted changes you've made in the transaction, while leaving transaction open. For example:my-typedb-database::schema::write> rollback Rolled back to the beginning of the transactionclose: Close the transaction without committing changes, and takes you back to the database-level interface, i.e. first-level REPL. For example:my-typedb-database::schema::write> close Transaction closed without committing changeshelp: Print this help menuclear: Clear console screenexit: Exit console
To invoke console in a non-interactive manner, we can define a script file that contains the list of commands to run, then invoke console with ./typedb console --script=<script>. We can also specify the commands to run directly from the command line using ./typedb console --command=<command1> --command=<command2> ....
For example given the following command script file:
database create test
transaction test schema write
define person sub entity;
commit
transaction test data write
insert $x isa person;
commit
transaction test data read
match $x isa person;
close
database delete test
You will see the following output:
> ./typedb console --script=script 73.830s
+ database create test
Database 'test' created
+ transaction test schema write
++ define person sub entity;
Concepts have been defined
++ commit
Transaction changes committed
+ transaction test data write
++ insert $x isa person;
{ $x iid 0x966e80017fffffffffffffff isa person; }
answers: 1, duration: 87 ms
++ commit
Transaction changes committed
+ transaction test data read
++ match $x isa person;
{ $x iid 0x966e80018000000000000000 isa person; }
answers: 1, duration: 25 ms
++ close
Transaction closed without committing changes
+ database delete test
Database 'test' deleted
The indentation in the script file are only for visual guide and will be ignored by the console. Each line in the script is interpreted as one command, so multiline query is not available in this mode.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent