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

Add API doc note about statement finalization #1310

Merged
merged 2 commits into from
Jan 18, 2025
Merged

Add API doc note about statement finalization #1310

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b4e777
Add note about statement finalization
kjackson1998 Jan 1, 2025
9336bc5
PR comment
kjackson1998 Jan 11, 2025
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
2 changes: 2 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,8 @@ An object representing a single SQL statement.
- [Statement#bind()](#bindbindparameters---this)
- [Properties](#properties-1)

> NOTE: Statements are [finalized](https://www.sqlite.org/c3ref/finalize.html) when garbage collected so there is no explicit API for it. Statements are also finalized when the associated database is closed.

### .run([*...bindParameters*]) -> *object*

Executes the prepared statement. When execution completes it returns an `info` object describing any changes made. The `info` object has two properties:
Expand Down