expo-sqlite-wrapper

This is an ORM, build around expo-sqlite. It will make operation like UPDATE, SELECT AND INSERT a lot easier to handle

Installations

1 npm install expo-sqlite expo-sqlite-wrapper

Installation for expo-sqlite read https://docs.expo.dev/versions/latest/sdk/sqlite/

Documentations

• Modules Setup
• DbContext
• Select and save operations
• Watch the db operations
• BulkSave
• Encryptions
• useQuery
• querySelector

IDatabase

1export interface IDatabase<D extends string> {
2    /**
3     * This is a hook you could use in a component
4     */
5    useQuery: IUseQuery;
6
7    /**
8     * Freeze all watchers, this is usefull when for example doing many changes to the db
9     * and you dont want the watchers to be triggerd many times
10     */
11    disableWatchers: () => IDatabase<D>;
12    /**
13     * enabling Watchers will call all the frozen watchers that has not been called when it was frozen
14     */
15    enableWatchers: () => Promise<void>;
16
17    /**
18    * Freeze all hooks, this is usefull when for example doing many changes to the db
19    * and you dont want the hooks to be triggerd(rerender components) many times
20    */
21    disableHooks: () => IDatabase<D>;
22
23    /**
24    * enabling Hooks will call all the frozen hooks that has not been called when it was frozen
25    */
26    enableHooks: () => Promise<void>;
27
28    /**
29     * BulkSave object
30     * This will only watchers.onBulkSave
31     */
32    bulkSave: <T extends IBaseModule<D>>(tabelName: D) => Promise<BulkSave<T, D>>;
33
34    isClosed?: boolean,
35    /**
36     * Its importend that,createDbContext return new database after this is triggered
37     */
38    tryToClose: () => Promise<boolean>;
39    /**
40     * Its importend that,createDbContext return new database after this is triggered
41     */
42    close: () => Promise<void>;
43    /**
44     * begin transaction
45     */
46    beginTransaction: () => Promise<void>;
47    /**
48     * comit the transaction
49     */
50    commitTransaction: () => Promise<void>;
51    /**
52     * rollback the transaction
53     */
54    rollbackTransaction: () => Promise<void>;
55    /**
56    Auto close the db after every ms.
57    The db will be able to refresh only if there is no db operation is ongoing.
58    This is useful, so that it will use less memory as SQlite tends to store transaction in memories which causes the increase in memory over time.
59    its best to use ms:3600000
60    the db has to be ideal for ms to be able to close it.
61    */
62    startRefresher: (ms: number) => void;
63    /**
64     * return column name for the specific table
65     */
66    allowedKeys: (tableName: D) => Promise<string[]>;
67    /**
68     * convert json to IQueryResultItem object, this will add method as savechanges, update and delete methods to an object
69     */
70    asQueryable: <T extends IId<D>>(item: IId<D> | IBaseModule<D>, tableName?: D) => Promise<IQueryResultItem<T, D>>
71    watch: <T extends IId<D>>(tableName: D) => IWatcher<T, D>;
72    /**
73     * Create IQuery object.
74     * @deprecated since version 1.4.3 use querySelector instead
75     */
76    query: <T extends IId<D>>(tableName: D) => IQuery<T, D>;
77
78    /**
79     * More advanced queryBuilder
80     * It include join and aggregators and better validations
81     */
82    querySelector: <T extends IId<D>>(tabelName: D) => IQuerySelector<T, D>;
83    /**
84     * execute sql eg
85     * query: select * from users where name = ?
86     * args: ["test"]
87     */
88    find: (query: string, args?: any[], tableName?: D) => Promise<IBaseModule<D>[]>
89    /**
90     * trigger save, update will depend on id and unique columns
91     */
92    save: <T extends IId<D>>(item: (T) | ((T)[]), insertOnly?: Boolean, tableName?: D, saveAndForget?: boolean) => Promise<T[]>;
93    where: <T extends IId<D>>(tableName: D, query?: any | T) => Promise<T[]>;
94    /**
95     * this method translate json-sql to sqlite select.
96     * for more info about this read json-sql documentations 
97     * https://github.com/2do2go/json-sql/tree/4be018c0662dacba06ddf033d18e71ebf93ee7c3/docs
98     * example 
99     * {
100        type: 'select',
101        table: 'DetaliItems',
102        condition:{"DetaliItems.id":{$gt: 1}, "DetaliItems.title": "Epic Of Caterpillar"},  
103        join: {
104        Chapters: {
105            on: {'DetaliItems.id': 'Chapters.detaliItem_Id'} 
106            }
107        }
108      }
109     */
110    jsonToSql: <T>(jsonQuery: any, tableName?: D) => Promise<T[]>;
111    /**
112     * delete object based on Id
113     */
114    delete: (item: IId<D> | (IId<D>[]), tableName?: D) => Promise<void>;
115    /**
116     * execute sql without returning anyting
117     */
118    execute: (query: string, args?: any[]) => Promise<boolean>;
119    /**
120     * Drop all tables
121     */
122    dropTables: () => Promise<void>;
123    /**
124     * Setup your table, this will only create a table if it dose not exist 
125     */
126    setUpDataBase: (forceCheck?: boolean) => Promise<void>;
127    /**
128     * find out if there some changes between object and db table
129     */
130    tableHasChanges: <T extends IBaseModule<D>>(item: ITableBuilder<T, D>) => Promise<boolean>;
131    /**
132     * execute an array of sql
133     */
134    executeRawSql: (queries: SqlQuery[], readOnly: boolean) => Promise<void>;
135
136}
137

Please report any issues that you find so we could make this lib even better.