Get

Copied!
( ref, [ts] )

Description

The Get function retrieves a single document identified by ref. An optional timestamp (ts) can be provided to retrieve the document which existed at the specific date and time. If the timestamp is omitted the default is the current time.

Get is also useful for retrieving the first document from a Match result.

Errors

  • If the document does not exist, a "document not found" error is returned. Use the exists predicate to avoid "document not found" errors.

  • If the client does not have read permission for the document, a "permission denied" error is returned.

Parameter

Argument Type Definition and Requirements

ref

Reference

A document reference that uniquely identifies a document.

ts

Integer or Timestamp

Optional - Return the document at the specified point in time (number of UNIX microseconds or Timestamp). The default is the current time.

For large values of ts (positive or negative), you may need to express the value in a string to maintain numeric precision (Fauna uses 64-bit signed integers, whereas JavaScript uses 53-bit signed integers).

Returns

A document containing both the document data and metadata described below.

Field Name Field Type Definition and Requirements

ref

Reference

The reference identifies the document retrieved.

data

Object

The document data retrieved at the location pointed to by ref.

ts

Integer

The timestamp associated with the creation of the requested document version, according to the ts parameter. Effectively, this timestamp represents the most recent modification of the document as of the ts parameter.

Examples

The following query retrieves an document by providing a reference to the collection named "spells" at a specific id:

Copied!
client.query(
  q.(q.(q.('spells'), '181388642046968320'))
)
.then((ret) => console.log(ret))
{ ref: (id=181388642046968320, collection=(id=spells, collection=(id=collections))),
  ts: 1526677786695156,
  data:
   { name: "Fire Beak",
     element: [ "air", "fire" ],
     spellbook: (id=181388642139243008, collection=(id=spellbooks, collection=(id=collections))) } }

To retrieve multiple references in a single operation, utilize the array operator to group and return multiple documents. The following example returns three different identifiers from the spells collection in a single database operation. This saves network bandwidth and processing by grouping several requests for data into the same operation.

Copied!
client.query([
  q.(q.(q.('spells'), '181388642046968320')),
  q.(q.(q.('spells'), '181388642071085568')),
  q.(q.(q.('spells'), '181388642088911360')),
])
.then((ret) => console.log(ret))
[ { ref: (id=181388642046968320, collection=(id=spells, collection=(id=collections))),
    ts: 1509244539547758,
    data:
     { name: "Fire Beak",
       element: [ "air", "fire" ],
       spellbook: (id=181388642139243008, collection=(id=spellbooks, collection=(id=collections))) } },
  { ref: (id=181388642071085568, collection=(id=spells, collection=(id=collections))),
    ts: 1509244539547758,
    data:
     { name: "Water Dragon's Claw",
       element: [ "water", "fire" ],
       spellbook: (id=181388642139243008, collection=(id=spellbooks, collection=(id=collections))) } },
  { ref: (id=181388642088911360, collection=(id=spells, collection=(id=collections))),
    ts: 1509244539235128,
    data:
     { name: "Hippo's Wallow",
       element: [ "water", "earth" ] } } ]

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!