https://github.com/nativescript-community/sqlite
SQLite for Nativescript
https://github.com/nativescript-community/sqlite
Last synced: about 1 month ago
JSON representation
SQLite for Nativescript
- Host: GitHub
- URL: https://github.com/nativescript-community/sqlite
- Owner: nativescript-community
- License: apache-2.0
- Created: 2019-12-05T09:28:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-04-23T09:59:36.000Z (about 1 month ago)
- Last Synced: 2026-04-23T10:33:03.653Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://nativescript-community.github.io/sqlite/
- Size: 3.62 MB
- Stars: 26
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-nativescript - SQLite - A SQLite plugin for NativeScript. (Plugins / Client-side Database Plugins)
README
@nativescript-community/sqlite
SQLite for Nativescript
[](#table-of-contents)
[](#table-of-contents)
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [Platforms sqlite versions](#platforms-sqlite-versions)
[](#installation)
[](#installation)
## Installation
Run the following command from the root of your project:
`ns plugin add @nativescript-community/sqlite`
[](#usage)
[](#usage)
## Usage
You should take care of wrapping sqlite calls to your preferred async option (promises, observables, async/await). And catch any exceptions thrown.
```typescript
import { openOrCreate, deleteDatabase } from "@nativescript-community/sqlite";
const sqlite = openOrCreate("path/to/db");
sqlite.execute("CREATE TABLE names (id INT, name TEXT)");
sqlite.transaction(cancelTransaction => {
// Calling cancelTransaction will rollback all changes made to db
names.forEach((name, id) =>
sqlite.execute(
"INSERT INTO names (id, name) VALUES (?, ?)",
[id, name]
)
);
});
```
[](#platforms-sqlite-versions)
[](#platforms-sqlite-versions)
## Platforms sqlite versions
* [Android](https://stackoverflow.com/a/4377116)
* [iOS](https://github.com/yapstudios/YapDatabase/wiki/SQLite-version-(bundled-with-OS))
[](#demos-and-development)
## Demos and Development
### Repo Setup
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
```
git submodule update --init
```
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
To develop and test:
if you use `yarn` then run `yarn`
if you use `pnpm` then run `pnpm i`
**Interactive Menu:**
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
### Build
```bash
npm run build.all
```
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
### Demos
```bash
npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
```
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
You can start from the `install.ts` of each flavor to see how to register new demos
[](#contributing)
## Contributing
### Update repo
You can update the repo files quite easily
First update the submodules
```bash
npm run update
```
Then commit the changes
Then update common files
```bash
npm run sync
```
Then you can run `yarn|pnpm`, commit changed files if any
### Update readme
```bash
npm run readme
```
### Update doc
```bash
npm run doc
```
### Publish
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
Simply run
```shell
npm run publish
```
### modifying submodules
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
One easy solution is t modify `~/.gitconfig` and add
```
[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
```
[](#questions)
## Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).