method

LocalAPI.EmptyTrash

EmptyTrash permanently deletes every accessible trashed document in one bounded atomic batch.

Arguments

ArgumentTypeDescription
ctxcontext.ContextThe ctx value.
collectionstringThe collection value.
optionsBulkOptionsThe options value.

Returns

The declared result.

([]store.Document, error)

Full signature

func (local *LocalAPI) EmptyTrash( ctx context.Context, collection string, options BulkOptions, ) ([]store.Document, error)

Source core/local.go:655

Related types

  • LocalAPI

    In-process content operations that share the REST authorization and lifecycle pipeline.

  • BulkOptions

    BulkOptions controls the actor and localization of an atomic batch or empty-trash operation. Bulk actions do not consume per-document revisions, population, draft status, or caller IDs.

  • Document

    A stored document with status and version metadata.