Type Alias BaseMutationOptions

BaseMutationOptions: RequestOptions & {
    autoGenerateArrayKeys?: boolean;
    dryRun?: boolean;
    returnDocuments?: boolean;
    returnFirst?: boolean;
    skipCrossDatasetReferenceValidation?: boolean;
    transactionId?: string;
    visibility?: "sync" | "async" | "deferred";
}

Base options for mutations like create, update, delete, etc. Controls how mutations are executed and what data is returned.

Type declaration

  • OptionalautoGenerateArrayKeys?: boolean

    Automatically add _key to array items. Helps prevent race conditions in real-time editing.

  • OptionaldryRun?: boolean

    Simulate the mutation without making changes

  • OptionalreturnDocuments?: boolean

    Whether to return the affected documents

  • OptionalreturnFirst?: boolean

    Whether to return only the first affected document

  • OptionalskipCrossDatasetReferenceValidation?: boolean

    Skip validation of cross dataset references

  • OptionaltransactionId?: string

    Custom transaction ID for the mutation

  • Optionalvisibility?: "sync" | "async" | "deferred"

    When to make changes visible:

    • 'sync': Wait until changes are visible to queries (default)
    • 'async': Return immediately after commit
    • 'deferred': Fastest, bypasses real-time indexing

Settings

Member Visibility