shell

Starts an interactive query shell.

fauna shell [DBNAME]

Description

Starts an interactive query shell for sending queries to FaunaDB.

Arguments

Argument Description

DBNAME

Optional - If supplied, the queries that you run are executed in the specified child database.

Options

Option Description

--domain=<domain>

Optional - The FaunaDB server domain, that is, the hostname where FaunaDB is running. Defaults to db.fauna.com.

--endpoint=<endpoint>

Optional - The name of the endpoint to use for the command.

--port=<port>

Optional - The connection port. Defaults to 8443.

--scheme=<scheme>

Optional - The connection scheme. Must be one of https or http. Defaults to https.

--secret=<secret>

Optional - The secret to use. A secret authenticates your connection to FaunaDB, and connects you to a specific database.

--timeout=<timeout>

Optional - The connection timeout, an integer number of milliseconds. When the specified period has elapsed, fauna-shell stops waiting for a response and displays an error.

The default is zero, which means that fauna-shell waits until a response is received.

Example

fauna shell
Connected to https://db.fauna.com
Type Ctrl+D or .exit to exit the shell
Paginate(Collections())
{ data: [ Collection("FirstCollection") ] }

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!