vue-sqlite-hook

<img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /> <h2 align="center">API HOOK DOCUMENTATION</h2> <code>vue-sqlite-hook@next</code> A Vue Hook to help Capacitor developpers to use <code>@capacitor-community/sqlite@next</code> plugin in Vue or Ionic/Vue applications ## Methods Index <docgen-index> * [`initWebStore()`](#initwebstore) * [`saveToStore(...)`](#savetostore) * [`echo(...)`](#echo) * [`getPlatform()`](#getplatform) * [`getCapacitorSQLite()`](#getcapacitorsqlite) * [`addUpgradeStatement(...)`](#addupgradestatement) * [`createConnection(...)`](#createconnection) * [`isConnection(...)`](#isconnection) * [`retrieveConnection(...)`](#retrieveconnection) * [`retrieveAllConnections()`](#retrieveallconnections) * [`closeConnection(...)`](#closeconnection) * [`closeAllConnections()`](#closeallconnections) * [`importFromJson(...)`](#importfromjson) * [`isJsonValid(...)`](#isjsonvalid) * [`copyFromAssets(...)`](#copyfromassets) * [`isDatabase(...)`](#isdatabase) * [`getNCDatabasePath(...)`](#getncdatabasepath) * [`createNCConnection(...)`](#createncconnection) * [`retrieveNCConnection(...)`](#retrievencconnection) * [`closeNCConnection(...)`](#closencconnection) * [`isNCConnection(...)`](#isncconnection) * [`isNCDatabase(...)`](#isncdatabase) * [`getDatabaseList()`](#getdatabaselist) * [`getMigratableDbList(...)`](#getmigratabledblist) * [`addSQLiteSuffix(...)`](#addsqlitesuffix) * [`deleteOldDatabases(...)`](#deleteolddatabases) * [`checkConnectionsConsistency()`](#checkconnectionsconsistency) * [`isSecretStored()`](#issecretstored) * [`setEncryptionSecret(...)`](#setencryptionsecret) * [`changeEncryptionSecret(...)`](#changeencryptionsecret) * [`removeListeners()`](#removelisteners) * [Interfaces](#interfaces) </docgen-index> * [Listeners](#listeners) ## API Hook <docgen-api>  SQLite Hook Interface ### initWebStore() ```typescript initWebStore() => Promise<void> ``` Init the web store **Since:** 2.1.1 -------------------- ### saveToStore(...) ```typescript saveToStore(database: string) => Promise<void> ``` Save the datbase to the web store | Param | Type | | -------------- | ------------------- | | **`database`** | <code>string</code> | **Since:** 2.1.1 -------------------- ### echo(...) ```typescript echo(value: string) => Promise<capEchoResult> ``` Echo a value | Param | Type | | ----------- | ------------------- | | **`value`** | <code>string</code> | **Returns:** <code>Promise<<a href="#capechoresult">capEchoResult</a>></code> **Since:** 1.0.0 refactor -------------------- ### getPlatform() ```typescript getPlatform() => Promise<{ platform: string; }> ``` Get platform **Returns:** <code>Promise<{ platform: string; }></code> **Since:** 1.0.0 refactor -------------------- ### getCapacitorSQLite() ```typescript getCapacitorSQLite() => Promise<{ plugin: any; }> ``` Get CapacitorSQLite plugin **Returns:** <code>Promise<{ plugin: any; }></code> **Since:** 2.0.5 -------------------- ### addUpgradeStatement(...) ```typescript addUpgradeStatement(dbName: string, upgrade: VersionUpgrade) => Promise<void> ``` Add an Upgrade Statement to Update Database Version | Param | Type | Description | | ------------- | --------------------------------------------------------- | ----------------- | | **`dbName`** | <code>string</code> | database name | | **`upgrade`** | <code><a href="#versionupgrade">VersionUpgrade</a></code> | upgrade statement | **Since:** 2.0.0 -------------------- ### createConnection(...) ```typescript createConnection(database: string, encrypted?: boolean | undefined, mode?: string | undefined, version?: number | undefined) => Promise<SQLiteDBConnection> ``` Create a connection to a database | Param | Type | | --------------- | -------------------- | | **`database`** | <code>string</code> | | **`encrypted`** | <code>boolean</code> | | **`mode`** | <code>string</code> | | **`version`** | <code>number</code> | **Returns:** <code>Promise<SQLiteDBConnection></code> **Since:** 2.0.0 -------------------- ### isConnection(...) ```typescript isConnection(database: string) => Promise<Result> ``` Check if a connection exists | Param | Type | | -------------- | ------------------- | | **`database`** | <code>string</code> | **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.0.0 -------------------- ### retrieveConnection(...) ```typescript retrieveConnection(database: string) => Promise<SQLiteDBConnection> ``` Retrieve an existing database connection | Param | Type | | -------------- | ------------------- | | **`database`** | <code>string</code> | **Returns:** <code>Promise<SQLiteDBConnection></code> **Since:** 2.0.0 -------------------- ### retrieveAllConnections() ```typescript retrieveAllConnections() => Promise<Map<string, SQLiteDBConnection>> ``` Retrieve all database connections **Returns:** <code>Promise<<a href="#map">Map</a><string, SQLiteDBConnection>></code> **Since:** 2.0.0 -------------------- ### closeConnection(...) ```typescript closeConnection(database: string) => Promise<void> ``` Close a database connection | Param | Type | | -------------- | ------------------- | | **`database`** | <code>string</code> | **Since:** 2.0.0 -------------------- ### closeAllConnections() ```typescript closeAllConnections() => Promise<void> ``` Close all database connections **Since:** 2.0.0 -------------------- ### importFromJson(...) ```typescript importFromJson(jsonstring: string) => Promise<capSQLiteChanges> ``` Import a database From a JSON | Param | Type | Description | | ---------------- | ------------------- | ----------- | | **`jsonstring`** | <code>string</code> | string | **Returns:** <code>Promise<<a href="#capsqlitechanges">capSQLiteChanges</a>></code> **Since:** 1.0.0 refactor -------------------- ### isJsonValid(...) ```typescript isJsonValid(jsonstring: string) => Promise<Result> ``` Check the validity of a JSON Object | Param | Type | Description | | ---------------- | ------------------- | ----------- | | **`jsonstring`** | <code>string</code> | string | **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 1.0.0 refactor -------------------- ### copyFromAssets(...) ```typescript copyFromAssets(overwrite?: boolean | undefined) => Promise<void> ``` Copy databases from assets to application database folder | Param | Type | Description | | --------------- | -------------------- | -------------- | | **`overwrite`** | <code>boolean</code> | // since 2.1.3 | **Since:** 2.0.0 -------------------- ### isDatabase(...) ```typescript isDatabase(database: string) => Promise<Result> ``` Check if a database exists | Param | Type | | -------------- | ------------------- | | **`database`** | <code>string</code> | **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.0.0 -------------------- ### getNCDatabasePath(...) ```typescript getNCDatabasePath(folderPath: string, database: string) => Promise<capNCDatabasePathResult> ``` Get a Non-Conformed database path | Param | Type | | ---------------- | ------------------- | | **`folderPath`** | <code>string</code> | | **`database`** | <code>string</code> | **Returns:** <code>Promise<<a href="#capncdatabasepathresult">capNCDatabasePathResult</a>></code> **Since:** 2.1.5 -------------------- ### createNCConnection(...) ```typescript createNCConnection(databasePath: string, version?: number | undefined) => Promise<SQLiteDBConnection> ``` Create a Non-Conformed database connection | Param | Type | | ------------------ | ------------------- | | **`databasePath`** | <code>string</code> | | **`version`** | <code>number</code> | **Returns:** <code>Promise<SQLiteDBConnection></code> **Since:** 2.1.5 -------------------- ### retrieveNCConnection(...) ```typescript retrieveNCConnection(databasePath: string) => Promise<SQLiteDBConnection> ``` Retrieve a Non-Conformed database connection | Param | Type | | ------------------ | ------------------- | | **`databasePath`** | <code>string</code> | **Returns:** <code>Promise<SQLiteDBConnection></code> **Since:** 2.1.5 -------------------- ### closeNCConnection(...) ```typescript closeNCConnection(databasePath: string) => Promise<void> ``` Close a Non-Conformed database connection | Param | Type | | ------------------ | ------------------- | | **`databasePath`** | <code>string</code> | **Since:** 2.1.5 -------------------- ### isNCConnection(...) ```typescript isNCConnection(databasePath: string) => Promise<Result> ``` Check if Non-Conformed database connection exists | Param | Type | | ------------------ | ------------------- | | **`databasePath`** | <code>string</code> | **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.1.5 -------------------- ### isNCDatabase(...) ```typescript isNCDatabase(databasePath: string) => Promise<Result> ``` Check if Non-Conformed database exists | Param | Type | | ------------------ | ------------------- | | **`databasePath`** | <code>string</code> | **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.1.5 -------------------- ### getDatabaseList() ```typescript getDatabaseList() => Promise<capSQLiteValues> ``` Get the database list **Returns:** <code>Promise<<a href="#capsqlitevalues">capSQLiteValues</a>></code> **Since:** 2.0.0 -------------------- ### getMigratableDbList(...) ```typescript getMigratableDbList(folderPath?: string | undefined) => Promise<capSQLiteValues> ``` Get Migratable Cordova database List | Param | Type | | ---------------- | ------------------- | | **`folderPath`** | <code>string</code> | **Returns:** <code>Promise<<a href="#capsqlitevalues">capSQLiteValues</a>></code> **Since:** 2.1.2 -------------------- ### addSQLiteSuffix(...) ```typescript addSQLiteSuffix(folderPath?: string | undefined, dbNameList?: string[] | undefined) => Promise<void> ``` Add SQLIte Suffix to existing Cordova databases | Param | Type | Description | | ---------------- | --------------------- | ----------- | | **`folderPath`** | <code>string</code> | | | **`dbNameList`** | <code>string[]</code> | since 2.1.2 | **Since:** 2.0.0 -------------------- ### deleteOldDatabases(...) ```typescript deleteOldDatabases(folderPath?: string | undefined, dbNameList?: string[] | undefined) => Promise<void> ``` Delete Old Cordova databases | Param | Type | Description | | ---------------- | --------------------- | ----------- | | **`folderPath`** | <code>string</code> | | | **`dbNameList`** | <code>string[]</code> | since 2.1.2 | **Since:** 2.0.0 -------------------- ### checkConnectionsConsistency() ```typescript checkConnectionsConsistency() => Promise<Result> ``` Check the consistency between Js Connections and Native Connections if inconsistency all connections are removed **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.0.1 -------------------- ### isSecretStored() ```typescript isSecretStored() => Promise<Result> ``` Check if secure secret has been stored **Returns:** <code>Promise<<a href="#result">Result</a>></code> **Since:** 2.0.2 -------------------- ### setEncryptionSecret(...) ```typescript setEncryptionSecret(passphrase: string) => Promise<void> ``` Set an encrypted secret to secure storage To run only once Will migrate from GlobalSQLite secret when required | Param | Type | | ---------------- | ------------------- | | **`passphrase`** | <code>string</code> | **Since:** 2.0.2 -------------------- ### changeEncryptionSecret(...) ```typescript changeEncryptionSecret(passphrase: string, oldpassphrase: string) => Promise<void> ``` Change encrypted secret from secure storage Not to use to migrate from GlobalSQLite secret (run setEncryptionSecret) | Param | Type | | ------------------- | ------------------- | | **`passphrase`** | <code>string</code> | | **`oldpassphrase`** | <code>string</code> | **Since:** 2.0.2 -------------------- ### removeListeners() ```typescript removeListeners() => Promise<void> ``` Remove Json Listeners **Since:** 2.0.1 -------------------- ### Interfaces #### capEchoResult | Prop | Type | Description | | ----------- | ------------------- | --------------- | | **`value`** | <code>string</code> | String returned | #### VersionUpgrade | Prop | Type | | ----------------- | -------------------- | | **`fromVersion`** | <code>number</code> | | **`toVersion`** | <code>number</code> | | **`statement`** | <code>string</code> | | **`set`** | <code>MySet[]</code> | #### MySet | Prop | Type | | --------------- | ------------------- | | **`statement`** | <code>string</code> | | **`values`** | <code>any[]</code> | #### Result | Prop | Type | | ------------- | -------------------- | | **`result`** | <code>boolean</code> | | **`message`** | <code>string</code> | #### Map | Prop | Type | | ---------- | ------------------- | | **`size`** | <code>number</code> | | Method | Signature | | ----------- | -------------------------------------------------------------------------------------------------------------- | | **clear** | () => void | | **delete** | (key: K) => boolean | | **forEach** | (callbackfn: (value: V, key: K, map: <a href="#map">Map</a><K, V>) => void, thisArg?: any) => void | | **get** | (key: K) => V \| undefined | | **has** | (key: K) => boolean | | **set** | (key: K, value: V) => this | #### capSQLiteChanges | Prop | Type | Description | | ------------- | ------------------------------------------- | ----------------------------------------- | | **`changes`** | <code><a href="#changes">Changes</a></code> | a returned <a href="#changes">Changes</a> | #### Changes | Prop | Type | Description | | ------------- | ------------------- | ---------------------------------------------------- | | **`changes`** | <code>number</code> | the number of changes from an execute or run command | | **`lastId`** | <code>number</code> | the lastId created from a run command | #### capNCDatabasePathResult | Prop | Type | Description | | ---------- | ------------------- | --------------- | | **`path`** | <code>string</code> | String returned | #### capSQLiteValues | Prop | Type | Description | | ------------ | ------------------ | -------------------------------- | | **`values`** | <code>any[]</code> | the data values list as an Array | </docgen-api> ### Listeners `Available since 2.0.1` The listeners are attached to the plugin. | Listener | Type | Description | | -------------------- | ------------------ | ---------------------------------------------------------- | | **onProgressImport** | {progress: string} | Emitted at different steps of the `importFromJson` process | | **onProgressExport** | {progress: string} | Emitted at different steps of the `exportToJson` process |