BasePowerSyncCollectionConfig

Type Alias: BasePowerSyncCollectionConfig<TTable, TSchema>

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

Defined in: definitions.ts:165

Type Declaration

database

ts
database: AbstractPowerSyncDatabase;
database: AbstractPowerSyncDatabase;

The PowerSync database instance

syncBatchSize?

ts
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

ts
table: TTable;
table: TTable;

The PowerSync schema Table definition

Type Parameters

TTable

TTable extends Table = Table

TSchema

TSchema extends StandardSchemaV1 = never

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.