Remove

Remove(Ref,TS, Action)
Remove(Ref, TS, Action)
Remove(Ref, TS, Action)
Remove(Ref, TS, Action)
remove(Ref, TS, Action)
Remove(Ref, TS, Action)

Description

The Remove function deletes an event from a document’s history. The reference must refer to a document within a user-defined collection.

Outstanding references result in an "invalid argument" error.

Parameters

Argument Type Definition and Requirements

ref

Reference

A reference type containing the document that should be removed.

ts

Integer or Timestamp

The timestamp when the document’s history should be removed. Can be expressed as either a number of UNIX microseconds since epoch, or as a Timestamp.

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).

action

Document Action

The type of action (create, delete, update) to be removed.

Returns

An object containing the metadata of the remove operations.

Field Name Field Type Definition and Requirements

ref

Reference

The reference which identifies the document updated.

data

Object

A copy of the new document data.

ts

Integer

The timestamp, with microsecond resolution, of the event removal.

Examples

The following query changes the history for a document in the "spells" collection. The create event at timestamp 1 is removed.

client.Query(
  Remove(
    Ref(Collection("spells"), "181388642581742080"),
    ts: 1,
    action: "create"
  )
);
null
curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{
          "remove": { "@ref": "classes/spells/181388642581742080" },
          "ts": 1,
          "action": "create"
        }'
HTTP/1.1 200 OK
{ "resource": null }
result, _ := client.Query(
    f.Remove(
        f.RefCollection(f.Collection("spells"), "181388642581742080"),
        1,
        f.ActionCreate,
    ),
)

fmt.Println(result)
{}
System.out.println(
     client.query(
        Remove(
           Ref(Collection("spells"), Value(181388642581742080L)),
           Value(1),
           Action.CREATE
        )
     ).get());
null
client.query(
  q.Remove(
    q.Ref(q.Collection('spells'), '181388642581742080'),
    1,
    'create'
  )
)
.then((ret) => console.log(ret))
null
client.query(
  q.remove(
    q.ref(q.collection("spells"), "181388642581742080"),
    ts=1,
    action="create"
  )
)
null
client.query(
  Remove(
    Ref(Collection("spells"), "181388642581742080"),
    ts = 1,
    action = "create"
  )
)
null

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!