Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface DatabaseGetOperation

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

    Properties

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

    Properties

    action: "get"

    The action of this database operation

    broadcast?: false

    Get requests are never broadcast

    documentName: string

    The Document name

    index?: boolean

    Return indices only instead of full Document records

    indexFields?: string[]

    An array of field identifiers which should be indexed

    pack?: string | null

    A compendium collection ID which contains the Documents

    parent?: Document<object, DocumentConstructionContext> | null

    A parent Document within which Documents are embedded

    parentUuid?: string

    A parent Document UUID provided when the parent instance is unavailable

    query: Record<string, any>

    A query object which identifies the set of Documents retrieved

    queryOptions?: object

    Additional options passed to the ServerDocument#find API

    Settings

    Member Visibility

    On This Page

    Properties