DocumentSelector

Type

Names a set of documents for a bulk operation, by metadata or external-id prefix.

Names a set of documents for a bulk operation like removeWhere, by a metadata match or an external-id prefix. The external-id prefix is the identity a bulk job or connector recorded for each document, so a whole source or batch can be selected at once.

DocumentSelector.ts

interface DocumentSelector {
  metadata?: DocumentMetadata
  externalIdPrefix?: string
}

Fields

metadata?

DocumentMetadata

Documents whose metadata matches these scalars.

externalIdPrefix?

string

Documents whose recorded external id starts with this, e.g. a key prefix.

Select by prefix

await Docs.removeWhere({ externalIdPrefix: 'archive/2019/' });