Git Product home page Git Product logo

sqlite-test's Introduction


SQLITE DATABASE

@capacitor-community/sqlite


CAPACITOR 4


Capacitor community plugin for Native and Electron SQLite Databases. In Native databases could be encrypted with SQLCipher



Maintainers

Maintainer GitHub Social
Quéau Jean Pierre jepiqueau

To install:

npm install --save @capacitor-community/sqlite
npx cap sync
yarn add @capacitor-community/sqlite
npx cap sync
pnpm install --save @capacitor-community/sqlite
pnpm install --save @jeep-sqlite
pnpm install --save sql.js
npx cap sync

More Reading:

Web Quirks

The plugin follows the guidelines from the Capacitor Team,

Meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with Babel. You'll need the usual capacitor/android/react npm script to build and copy the assets folder.

For Angular framework

  • Copy manually the file sql-wasm.wasm from node_modules/sql.js/dist/sql-wasm.wasm to the src/assets folder of YOUR_APP

For Vue & React frameworks

  • Copy manually the file sql-wasm.wasm from node_modules/sql.js/dist/sql-wasm.wasm to the public/assets folder of YOUR_APP

Android Quirks

In case you get the following error when building your app in Android Studio: x files found with path 'build-data.properties'. You can you add the following code to app/build.gradle:

    packagingOptions {
        exclude 'build-data.properties'
    }

See #301 and SO question for more information.

Electron Quirks

  • On Electron, go to the Electron folder of YOUR_APPLICATION
cd electron
npm install --save sqlite3
npm install --save jszip
npm install --save [email protected]
npm install --save-dev @types/sqlite3
  • Important: node-fetch version must be <=2.6.7; otherwise you'll get an error running the app.

IOS Quirks

  • on iOS, no further steps needed.

Supported Methods by Platform

Name Android iOS Electron Web
createConnection (ReadWrite)
createConnection (ReadOnly)
closeConnection (ReadWrite)
closeConnection (ReadOnly)
isConnection (ReadWrite)
isConnection (ReadOnly)
open (non-encrypted DB)
open (encrypted DB)
close
getUrl
getVersion
execute
executeSet
run
query
deleteDatabase
importFromJson
exportToJson
deleteExportedRows
createSyncTable
setSyncDate
getSyncDate
isJsonValid
isDBExists
addUpgradeStatement
copyFromAssets
isDBOpen
isDatabase
isTableExists
getTableList
getDatabaseList
getMigratableDbList
addSQLiteSuffix
deleteOldDatabases
moveDatabasesAndAddSuffix
checkConnectionsConsistency
isSecretStored
setEncryptionSecret
changeEncryptionSecret
clearEncryptionSecret
initWebStore
saveToStore
getNCDatabasePath
createNCConnection
closeNCConnection
isNCDatabase
transaction
getFromHTTPRequest

Documentation & APIs

Applications demonstrating the use of the plugin and related documentation

Ionic/Angular

Ionic/Angular TypeORM app

Ionic/React

React+Vite

Ionic/Vue

Vue

Vue+Vite

Vue TypeORM app

SolidJS+Vite

Dependencies

The iOS and Android codes are using SQLCipher allowing for database encryption. The iOS codes is using ZIPFoundation for unzipping assets files. The Electron code is using sqlite3 and node-fetch from 4.2.0. The Web code is using the Stencil component jeep-sqlite based on sql.js, localforage, and jszip.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

sqlite-test's People

Contributors

jepiqueau avatar dragermrb avatar tobiasmuecksch avatar harelm avatar dependabot[bot] avatar chriswep avatar mhartington avatar gion-andri avatar joewoodhouse avatar rdlabo avatar victorybiz avatar antoniovlx avatar dewald-els avatar fpsampayo avatar millerg6711 avatar eltociear avatar sirs0ri avatar oscarfonts avatar thenovemberrain avatar lovetodream avatar aeinn avatar digaus avatar fizdalf avatar iamcco avatar jonz94 avatar paulantoine2 avatar rubickecho avatar ptasheq avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.