Go to the directory whe you have your grakn-core-all
or grakn-core-console
distribution unarchived, and run ./grakn console
cd <your_grakn_console_dir>/
./grakn console
You can provide several command arguments when running console in the terminal.
--server=<address>
: Server address to which the console will connect to.-V, --version
: Print version information and exit.-h, --help
: Show help message.
Grakn 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.
database create <db>
: Create a database with name<db>
on the server. For example:> database create my-grakn-database Database 'my-grakn-database' created
database list
: List the databases on the server. For example:> database list my-grakn-database
database delete <db>
: Delete a database with name<db>
on the server. For example:> database delete my-grakn-database Database 'my-grakn-database' deleted
transaction <db> schema|data read|write
: Start a transaction to database<db>
with session typeschema
ordata
, and transaction typewrite
orread
. For example:This will then take you to the transaction-level interface, i.e. the second-level REPL.> transaction my-grakn-database schema write my-grakn-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 Graql query, and will execute it when you hit enter twice. For example:my-grakn-database::schema::write> define name sub attribute, value string; person sub entity, owns name; Concepts have been defined
source <file>
: Run Graql queries in a file, which you can refer to using relative or absolute path. For example:my-grakn-database::schema::write> source ./schema.gql Concepts have been defined
commit
: Commit the transaction changes and close transaction. For example:my-grakn-database::schema::write> commit Transaction changes committed
rollback
: Will remove any uncommitted changes you've made in the transaction, while leaving transaction open. For example:my-grakn-database::schema::write> rollback Rolled back to the beginning of the transaction
close
: Close the transaction without committing changes, and takes you back to the database-level interface, i.e. first-level REPL. For example:my-grakn-database::schema::write> close Transaction closed without committing changes
help
: Print this help menuclear
: Clear console screenexit
: Exit console