PocketSyncDatabase is initialized with PocketSync instance. You can access it via PocketSync.instance.database.

final db = PocketSync.instance.database;

​
Database Options

PocketSyncDatabase requires configuration options to properly initialize and manage your SQLite database.

ParameterDescriptionRequiredDefault
versionThe database version numberNo1
dbPathPath to the SQLite database fileYes-
onCreateCallback function called when database is first createdYes-
onConfigureCallback function to configure the databaseNonull
onUpgradeCallback function to handle database version upgradesNonull
onDowngradeCallback function to handle database version downgradesNonull
onOpenCallback function called when database is openedNonull

​
Example

final db = PocketSync.initialize(
    options: PocketSyncOptions(
      projectId: 'your-project-id',
      authToken: 'your-auth-token',
      serverUrl: 'https://api.pocketsync.dev',
    ),
    databaseOptions: DatabaseOptions(
    version: 1,
    dbPath: 'path/to/database.db',
    onCreate: (db, version) {
      // Create tables
    },
    onUpgrade: (db, oldVersion, newVersion) {
      // Handle database upgrade
    },
    onDowngrade: (db, oldVersion, newVersion) {
      // Handle database downgrade
    },
    onOpen: (db) {
      // Handle database open
    },
  ),
);