EVICT

EVICT FROM your_collection_name
USE IDS [ids]
WHERE [condition]
LIMIT [limit]
OFFSET [offset]
ORDER BY [order by]
RETURNING [projection]

• your_collection_name is the name of the collection from which you want to retrieve the data.
• [ids] represents the document IDs to evict, given as a parameter or a literal list, rather than selecting documents with a WHERE predicate (optional).
• [condition] represents the condition or criteria that determine which documents should be evicted from the local peer.
• [limit] represents the maximum number of documents that should be evicted
• [offset] represents the offset from 0 that should be used for the eviction query, in practice this should be rarely used
• [order by] represents the path within a document to use to order the dataset and order (ASC or DESC)
• [projection] returns fields or expressions taken from the evicted documents (optional). See RETURNING.

​

Examples of Evicting Documents

EVICT FROM cars
WHERE _id = '123'

EVICT FROM cars
WHERE some_time_stamp > 1699888298000

​

Evicting Documents by ID

-- Literal list of IDs
EVICT FROM cars USE IDS '123', '456'

-- IDs supplied as a parameter
EVICT FROM cars USE IDS :ids

​

EVICT with RETURNING

-- Return the complete evicted documents
EVICT FROM cars
USE IDS '123'
RETURNING *

-- Return a count of the documents evicted
EVICT FROM cars
WHERE some_time_stamp > 1699888298000
RETURNING COUNT(*) AS evicted

​

Removing Data from Ditto Server