Interface GoogleFirebaseCloudFirestoreNodeParameters

Source
interface GoogleFirebaseCloudFirestoreNodeParameters {
    authentication?:
        | "serviceAccount"
        | "googleFirebaseCloudFirestoreOAuth2Api";
    collection?: string;
    columns?: string;
    database?: string;
    documentId?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "delete"
    | "upsert"
    | "query";
    projectId?: string;
    query?: string;
    resource?: "collection"
    | "document";
    returnAll?: boolean;
    simple?: boolean;
    updateKey?: string;
}

Properties§

Source§

readonly authentication?: "serviceAccount" | "googleFirebaseCloudFirestoreOAuth2Api"

Default: "googleFirebaseCloudFirestoreOAuth2Api"

Source§

readonly collection?: string

Collection name

Source§

readonly columns?: string

List of attributes to save

Source§

readonly database?: string

Usually the provided default value will work Default: "(default)"

Source§

readonly documentId?: string

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

Source§

readonly operation?: "create" | "get" | "getAll" | "delete" | "upsert" | "query"

Default: "get"

Source§

readonly projectId?: string

As displayed in firebase console URL. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getProjects"}

Source§

readonly query?: string

JSON query to execute

Source§

readonly resource?: "collection" | "document"

Default: "document"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly updateKey?: string

Must correspond to a document ID