Documentation improvements collection

[tobiasmuecksch]

In this issue, I want to collect topics and improvements for the documentation.

• Simplified getting started with platform specific hints
• Simplified "Singleton service" with better readability
• Platform specific quirks and hints
  • e.g. on web we have to call saveToStore programmatically. closeConnection also does saveToStore
• What is the difference between run, query, execute and executeSet?
• Detailed information on connection management
• Detailed information on how db versioning works

FAQ:

• How to drop a database? (advice: close connection afterwards)

Maybe we could implement some documentation website with a framework like https://github.com/facebook/docusaurus

[tobiasmuecksch]

Issues to consider for information gathering:

• bug: npx cap sync @capacitor-community/electron breaks configuration #255
• bug: cannot create tables with standard sql statements #254
• bug: deleteDatabase() does not work #247
• web: .createConnection() "Not implemented on web" #244
• Electron error TypeError: Cannot read properties of undefined (reading 'CapacitorSQLite') #242
• Error: echo "Not implemented on web." #241

[tobiasmuecksch]

@jepiqueau Could you give me some explanation for this question?

"What is the difference between run, query, execute and executeSet?"

[jepiqueau]

@tobiasmuecksch
Query is for select statement
Execute is for executing a set of raw statement given in a string.
Run is for executing one raw statement Insert, Update, Delete with given values meaning that you prépare the statement and bind the values if any
ExecuteSet is to run on or more raw statements and bind them with values or an array of values .
Hope this clarify

[jepiqueau]

@tobiasmuecksch on Electron you do not need to use saveToStore. This is only for the Web platform

[tobiasmuecksch]

@tobiasmuecksch on Electron you do not need to use saveToStore. This is only for the Web platform

My bad. I fixed the issue description.

[jepiqueau]

@tobiasmuecksch i just issue a new Ionic/Angular app demonstrating how to use the @capacitor-community/sqlite plugin to synchronize with a remote server database by using the import & export of Json Object. The deleted rows are now well managed. Look at angular-sqlite-synchronize-app, hope this will clarify

[rakibul111]

@jepiqueau can you please guide me how can I use this sqlite plugin with nextjs-ionic setup.
Note: I don't know typescript

[jepiqueau]

@rakibul111 exactely the same way that for react, vue, solidjs or angular.

[jepiqueau]

@rakibul111
Npm i -- save @capacitor/core
Npm i --save-dev @capacitor/cli
Npm i --save @capacitor/ios and Android
Npx cap init yourappname yourappid
Npm run build
Npx cap add ios
Npx cap add android
Npx cap sync
Npm run build
Npx cap copy
Npx cap open ios
Npx cap open android
Thatis it

[rakibul111]

@jepiqueau where to setup for jeep-sqlite?

[rakibul111]

@jepiqueau Uncaught (in promise) RuntimeError: Aborted(LinkError: WebAssembly.instantiate(): Import #33 module="a" function="I" error: function import requires a callable). Build with -s ASSERTIONS=1 for more info.
at L (jeep-sqlite.entry.js:2591:71)
at jeep-sqlite.entry.js:2641:387

[tobiasmuecksch]

This is not the right issue for this discussion.
Please open a new issue for that.

[jepiqueau]

@rakibul111 as mentioned by @tobiasmuecksch this is not the right place. Any how delete the sql-wasm.wasm file from your assets folder and copy the one from the node_modules/sql.js/dist/sql_wasm.wasm to your asset folder this should solve the issue

[jhuenges]

I also have a suggestion for the documentation:

What happens if the user deletes the app?

• Is the encryption secret kept?
• Are the databases and tables kept?
• If the users re-installs the app, can they continue were they left off?
• Are there differences between iOS and Android how this is done?

Were is the database stored on the phone?

• Is it included in the backup?
• If so: Can it be excluded from the backup?

@jepiqueau If you can answer these questions, I can create a pull request to add this information.