createReactNativeSqlitePersister
The createReactNativeSqlitePersister
function creates an ReactNativeSqlitePersister
object that can persist the Store
to a local react-native-sqlite-storage
database.
createReactNativeSqlitePersister(
store: Store | MergeableStore,
db: SQLiteDatabase,
configOrStoreTableName?: string | DatabasePersisterConfig,
onSqlCommand?: (sql: string, params?: any[]) => void,
onIgnoredError?: (error: any) => void,
): ReactNativeSqlitePersister
Type | Description | |
---|---|---|
store | Store | MergeableStore | The |
db | SQLiteDatabase | The database instance that was returned from |
configOrStoreTableName? | string | DatabasePersisterConfig | A |
onSqlCommand? | (sql: string, params?: any[]) => void | An optional handler called every time the |
onIgnoredError? | (error: any) => void | An optional handler for the errors that the |
returns | ReactNativeSqlitePersister | A reference to the new |
An ReactNativeSqlitePersister
supports regular Store
objects, and can also be used to persist the metadata of a MergeableStore
when using the JSON serialization mode, as described below.
As well as providing a reference to the Store
to persist, you must provide a db
parameter which identifies the database instance.
Important note: the react-native-sqlite-storage
module must have had promises enabled before the database instance is passed in. Use SQLite.enablePromise(true)
before initializing the Persister
.
A database Persister
uses one of two modes: either a JSON serialization of the whole Store
stored in a single row of a table (the default), or a tabular mapping of Table
Ids
to database table names and vice-versa).
The third argument is a DatabasePersisterConfig
object that configures which of those modes to use, and settings for each. If the third argument is simply a string, it is used as the storeTableName
property of the JSON serialization.
See the documentation for the DpcJson
and DpcTabular
types for more information on how both of those modes can be configured.
Examples
This example creates a ReactNativeSqlitePersister
object and persists the Store
to a local SQLite database as a JSON serialization into the my_tinybase
table. It makes a change to the database directly and then reloads it back into the Store
.
import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
import {createStore} from 'tinybase';
import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
enablePromise(true);
const db = await openDatabase({name: 'my.db', location: 'default'});
const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
const persister = createReactNativeSqlitePersister(
store,
db,
'my_tinybase',
);
await persister.save();
// Store will be saved to the database.
console.log(
(await db.executeSql('SELECT * FROM my_tinybase;'))[0].rows.raw(),
);
// -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
await db.executeSql(
'UPDATE my_tinybase SET store = ' +
`'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
);
await persister.load();
console.log(store.getTables());
// -> {pets: {felix: {species: 'cat'}}}
await persister.destroy();
This example creates a ReactNativeSqlitePersister
object and persists the Store
to a local SQLite database with tabular mapping.
import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
import {createStore} from 'tinybase';
import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
enablePromise(true);
const db = await openDatabase({name: 'my.db', location: 'default'});
const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
const persister = createReactNativeSqlitePersister(store, db, {
mode: 'tabular',
tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
});
await persister.save();
console.log((await db.executeSql('SELECT * FROM pets;'))[0].rows.raw());
// -> [{_id: 'fido', species: 'dog'}]
await db.executeSql(
`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
);
await persister.load();
console.log(store.getTables());
// -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
await persister.destroy();
Since
v6.4.0