Skip to content

doc: finalize statements in sqlite examples #65088

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

Open
araujogui wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −8
Open

doc: finalize statements in sqlite examples #65088

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
28 changes: 20 additions & 8 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,14 @@ const insert = database.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
// Execute the prepared statement with bound values.
insert.run(1, 'hello');
insert.run(2, 'world');
// Finalize the prepared statement once it is no longer needed.
insert.close();
// Create a prepared statement to read data from the database.
const query = database.prepare('SELECT * FROM data ORDER BY key');
// Execute the prepared statement and log the result set.
console.log(query.all());
// Prints: [ { key: 1, value: 'hello' }, { key: 2, value: 'world' } ]
query.close();
Comment thread
araujogui marked this conversation as resolved.
```

```cjs
Expand All @@ -76,11 +79,14 @@ const insert = database.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
// Execute the prepared statement with bound values.
insert.run(1, 'hello');
insert.run(2, 'world');
// Finalize the prepared statement once it is no longer needed.
insert.close();
// Create a prepared statement to read data from the database.
const query = database.prepare('SELECT * FROM data ORDER BY key');
// Execute the prepared statement and log the result set.
console.log(query.all());
// Prints: [ { key: 1, value: 'hello' }, { key: 2, value: 'world' } ]
query.close();
```

## Type conversion between JavaScript and SQLite
Expand Down Expand Up @@ -264,7 +270,8 @@ db.aggregate('sumint', {
step: (acc, value) => acc + value,
});

db.prepare('SELECT sumint(y) as total FROM t3').get(); // { total: 21 }
using query = db.prepare('SELECT sumint(y) as total FROM t3');
query.get(); // { total: 21 }
Comment thread
araujogui marked this conversation as resolved.
```

```mjs
Expand All @@ -285,7 +292,8 @@ db.aggregate('sumint', {
step: (acc, value) => acc + value,
});

db.prepare('SELECT sumint(y) as total FROM t3').get(); // { total: 21 }
using query = db.prepare('SELECT sumint(y) as total FROM t3');
query.get(); // { total: 21 }
```

### `database.close()`
Expand Down Expand Up @@ -463,7 +471,8 @@ db.setAuthorizer((actionCode) => {
});

// This will work
db.prepare('SELECT 1').get();
using query = db.prepare('SELECT 1');
query.get();
Comment thread
araujogui marked this conversation as resolved.

// This will throw an error due to authorization denial
try {
Expand All @@ -486,7 +495,8 @@ db.setAuthorizer((actionCode) => {
});

// This will work
db.prepare('SELECT 1').get();
using query = db.prepare('SELECT 1');
query.get();

// This will throw an error due to authorization denial
try {
Expand Down Expand Up @@ -627,7 +637,8 @@ original.close();

const clone = new DatabaseSync(':memory:');
clone.deserialize(buffer);
console.log(clone.prepare('SELECT value FROM t').get());
using query = clone.prepare('SELECT value FROM t');
console.log(query.get());
// Prints: { value: 'hello' }
```

Expand All @@ -642,7 +653,8 @@ original.close();

const clone = new DatabaseSync(':memory:');
clone.deserialize(buffer);
console.log(clone.prepare('SELECT value FROM t').get());
using query = clone.prepare('SELECT value FROM t');
console.log(query.get());
// Prints: { value: 'hello' }
```

Expand Down Expand Up @@ -863,7 +875,7 @@ targetDb.exec('CREATE TABLE data(key INTEGER PRIMARY KEY, value TEXT)');

const session = sourceDb.createSession();

const insert = sourceDb.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
using insert = sourceDb.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
insert.run(1, 'hello');
insert.run(2, 'world');

Expand All @@ -883,7 +895,7 @@ targetDb.exec('CREATE TABLE data(key INTEGER PRIMARY KEY, value TEXT)');

const session = sourceDb.createSession();

const insert = sourceDb.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
using insert = sourceDb.prepare('INSERT INTO data (key, value) VALUES (?, ?)');
insert.run(1, 'hello');
insert.run(2, 'world');

Expand Down
Loading