eval
Run an FQL query.
Description
The eval
command runs the QUERY against the optional DBNAME database.
The query is executed in the child database. If you include a DBNAME, it must be the first argument.
The QUERY can be read from STDIN, a file, or the command line, and query results can be output to STDOUT or a file. You can also define the output format.
If you omit command line options, Fauna uses the configuration file options.
If the query returns an error, fauna-shell
exits with a non-zero exit
code.
You can’t use this command to execute a query in a parent or peer database. To access a database outside of the current database, log in to the Fauna Dashboard.
Arguments
Argument | Description |
---|---|
DBNAME |
(Optional) Name of the child database the query should be run against. |
QUERY |
Query you want to run. |
Options
Option | Description |
---|---|
|
Optional file to read the query (or queries) from. |
|
Optional output format. Must be one of:
The default is |
|
Enable type checking. |
|
Enable type checking. |
|
(Optional) Fauna server domain, which is the Fauna hostname. |
|
(Optional) Endpoint name to use for the command. |
|
(Optional) Connection port. |
|
(Optional) Connection scheme. Must be one of: |
|
(Optional) Secret to use to connect to a database. |
|
(Optional) connection timeout, in milliseconds.
When the interval elapses, |
|
(Optional) Fauna Query Language version |
Examples
The following examples illustrate the many ways to use the eval
command.
QUERY argument
fauna eval "Collection.all()"
{
data: [
{
name: "People",
coll: Collection,
ts: Time("2023-08-23T00:26:16.680Z"),
indexes: {
byEmail: {
terms: [
{
field: "email"
}
],
queryable: true,
status: "complete"
}
},
constraints: [
{
unique: [
"email"
],
status: "active"
}
]
}
]
}
QUERY file
The query in the file is identical to the previous example:
fauna eval --file=./query.fql
Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!