Interface DatabaseGetOperation

interface DatabaseGetOperation {
    action: "get";
    broadcast?: false;
    index?: boolean;
    indexFields?: string[];
    pack?: null | string;
    parent?: null | Document<object, DocumentConstructionContext>;
    parentUuid?: string;
    query: Record<string, any>;
}

Properties

action broadcast? index? indexFields? pack? parent? parentUuid? query

Properties

action

action: "get"

The action of this database operation

Optionalbroadcast

broadcast?: false

Get requests are never broadcast

Optionalindex

index?: boolean

Return indices only instead of full Document records

OptionalindexFields

indexFields?: string[]

An array of field identifiers which should be indexed

Optionalpack

pack?: null | string

A compendium collection ID which contains the Documents

Optionalparent

parent?: null | Document<object, DocumentConstructionContext>

A parent Document within which Documents are embedded

OptionalparentUuid

parentUuid?: string

A parent Document UUID provided when the parent instance is unavailable

query

query: Record<string, any>

A query object which identifies the set of Documents retrieved

Settings

Member Visibility

On This Page

Properties