Type Alias: BasePowerSyncCollectionConfig<TTable, TSchema>

type BasePowerSyncCollectionConfig<TTable, TSchema> = Omit<BaseCollectionConfig<ExtractedTable<TTable>, string, TSchema>, "onInsert" | "onUpdate" | "onDelete" | "getKey" | "syncMode"> & object & 
  | EagerSyncHooks
  | OnDemandSyncHooks;

type BasePowerSyncCollectionConfig<TTable, TSchema> = Omit<BaseCollectionConfig<ExtractedTable<TTable>, string, TSchema>, "onInsert" | "onUpdate" | "onDelete" | "getKey" | "syncMode"> & object & 
  | EagerSyncHooks
  | OnDemandSyncHooks;

Defined in: definitions.ts:203

Type Declaration

database

database: AbstractPowerSyncDatabase;

database: AbstractPowerSyncDatabase;

The PowerSync database instance

syncBatchSize?

optional syncBatchSize: number;

optional syncBatchSize: number;

The maximum number of documents to read from the SQLite table in a single batch during the initial sync between PowerSync and the in-memory TanStack DB collection.

Remarks

Defaults to DEFAULT_BATCH_SIZE if not specified.
Larger values reduce the number of round trips to the storage engine but increase memory usage per batch.
Smaller values may lower memory usage and allow earlier streaming of initial results, at the cost of more query calls.

table

table: TTable;

table: TTable;

The PowerSync schema Table definition

Type Parameters

TTable

TTable extends Table = Table

TSchema

TSchema extends StandardSchemaV1 = never