Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #26

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

Documentation improvements #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ TypeORM is officially supported, however, there is currently a parsing issue wit
```typescript
import {open} from 'react-native-quick-sqlite'

const db = open('myDb.sqlite')
const db = open({ name: 'myDb.sqlite' })
// Or: const db = open({ name: 'myDb.sqlite', location: '/some/location' })


// The db object now contains the following methods:

Expand Down Expand Up @@ -57,7 +59,7 @@ The basic query is **synchronous**, it will block rendering on large operations,
import { open } from 'react-native-quick-sqlite';

try {
const db = open('myDb.sqlite');
const db = open({ name: 'myDb.sqlite' });

let { rows } = db.execute('SELECT somevalue FROM sometable');

Expand Down Expand Up @@ -317,6 +319,12 @@ You can specify flags via `<PROJECT_ROOT>/android/gradle.properties` like so:
quickSqliteFlags="<SQLITE_FLAGS>"
```

Unlike with iOS, you must specify the `-D` prefix when defining your flags:

```
quickSqliteFlags="-DSQLITE_ENABLE_FTS5=1"
```

## Additional configuration

### App groups (iOS only)
Expand Down