BasePowerSyncCollectionConfig

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

Defined in: definitions.ts:205

Type Declaration#

database#

database: CommonPowerSyncDatabase;

The PowerSync database instance

syncBatchSize?#

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;

The PowerSync schema Table definition

Type Parameters#

TTable#

TTable extends Table = Table

TSchema#

TSchema extends StandardSchemaV1<any> = never