Interface SyncRequest

interface SyncRequest {
    allowExpiredCursorsAndAcceptMissedDeletes?: boolean;
    cursors?: Record<string, string>;
    includeTyping?: boolean;
    parameters?: Record<string, RawPropertyValueV3>;
    select: Record<string, SyncSelectV3>;
    with: Record<string, SyncTableExpressionV3>;
}

Properties

allowExpiredCursorsAndAcceptMissedDeletes? cursors? includeTyping? parameters? select with

Properties

OptionalallowExpiredCursorsAndAcceptMissedDeletes

allowExpiredCursorsAndAcceptMissedDeletes?: boolean

Sync cursors will expire after 3 days. This is because soft-deleted instances are cleaned up after this grace period, so a client using a cursor older than that risks missing deletes. If this option is set to true, the API will allow the use of expired cursors.

Optionalcursors

cursors?: Record<string, string>

Cursors returned from the previous sync request. These cursors match the result set expressions you specified in the with clause for the sync.

OptionalincludeTyping

includeTyping?: boolean

Should we return property type information as part of the result?

Optionalparameters

parameters?: Record<string, RawPropertyValueV3>

Parameters to return

select

select: Record<string, SyncSelectV3>

with

with: Record<string, SyncTableExpressionV3>

Settings

Member Visibility

On This Page

Properties