Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

Document

Learn: Documents

You add data to Fauna as JSON-like documents, stored in collections.

Document fields

All documents contain the id, coll, ts, and optional ttl metadata fields. Documents in user-defined collections also typically contain user-defined fields. For example:

{
  id: "392886847463751746",
  coll: Product,
  ts: Time("2099-04-10T16:50:12.850Z"),
  ttl: Time("2099-04-15T16:50:12.850Z"),
  name: "key limes",
  description: "Conventional, 16 oz bag",
  price: 299,
  stock: 100,
  category: Category("401610017107607625")
}

Field Type Read-only Required Description

Field	Type	Read-only	Required	Description
`id`	ID	Yes		Unique identifier for the document within the collection. The identifier is a string-encoded, 64-bit unsigned integer in the 2^53-1 range. IDs are assigned on document creation. To create a document with a user-provided `id` using `collection.create()`, you must use a secret with the `create_with_id` privilege. If not provided, Fauna generates the `id`.
`coll`	Collection	Yes	true	Collection of which the document is a member. The `coll` field can’t be indexed.
`ts`	Time	Yes	true	Document last changed timestamp. Updated only on document write. The timestamp is propagated to all child documents.
`ttl`	Time or `null`			Document time-to-live (TTL), if set.
`<USER_DEFINED_FIELD>`	Any supported data type			User-defined document field. Schema method names and schema metadata field names are reserved and can’t be used as a field name but can be used in nested objects. You can enforce typing and constraints for user-defined fields in a collection using collection schema.
`data`	Object		true	A reserved field that contains all user-defined fields and their values. By default, the `data` field isn’t returned in query results. However, if typechecking is disabled, you can project the field to return it. The `data` field does not contain computed fields or metadata fields, such as `id`, `coll`, `ts`, or `ttl`. You can use the `data` field to safely nest user-defined fields that have reserved field names, such as `id` or `ttl`, in a document. See Data field and Avoid conflicts with reserved fields in the v10 migration docs.

id

Yes

Unique identifier for the document within the collection. The identifier is a string-encoded, 64-bit unsigned integer in the 2^53-1 range.

IDs are assigned on document creation. To create a document with a user-provided id using collection.create(), you must use a secret with the create_with_id privilege. If not provided, Fauna generates the id.

coll

Collection

Yes

true

Collection of which the document is a member. The coll field can’t be indexed.

ts

Time

Yes

true

Document last changed timestamp. Updated only on document write. The timestamp is propagated to all child documents.

ttl

Time or null

Document time-to-live (TTL), if set.

<USER_DEFINED_FIELD>

Any supported data type

User-defined document field.

Schema method names and schema metadata field names are reserved and can’t be used as a field name but can be used in nested objects.

You can enforce typing and constraints for user-defined fields in a collection using collection schema.

data

Object

true

A reserved field that contains all user-defined fields and their values.

By default, the data field isn’t returned in query results. However, if typechecking is disabled, you can project the field to return it.

The data field does not contain computed fields or metadata fields, such as id, coll, ts, or ttl.

You can use the data field to safely nest user-defined fields that have reserved field names, such as id or ttl, in a document. See Data field and Avoid conflicts with reserved fields in the v10 migration docs.

Instance methods

You can use the following instance methods to manage a document in FQL.

Method Description

Method	Description
`document.delete()`	Delete a document.
`document.exists()`	Test if a document exists.
`document.replace()`	Replace all document fields.
`document.replaceData()`	Replace document data field contents.
`document.update()`	Update document fields.
`document.updateData()`	Update document data field contents.

document.delete()

Delete a document.

document.exists()

Test if a document exists.

document.replace()

Replace all document fields.

document.replaceData()

Replace document data field contents.

document.update()

Update document fields.

document.updateData()

Update document data field contents.