mirrors/bun.sh
1
0
Fork 0
mirror of https://github.com/oven-sh/bun synced 2026-02-02 15:08:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify SQLite embed example requires existing database (#25329)

Browse Source 
Co-authored-by: Alistair Smith <hi@alistair.sh>
This commit is contained in:
robobun
2025-12-03 22:02:39 -08:00
committed by GitHub
parent e9e93244cb
commit 4d60b6f69d
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/bundler/executables.mdx
View File

@@ -412,7 +412,9 @@ const bytes = await file(icon).arrayBuffer();
### Embed SQLite databases ### Embed SQLite databases
If your application wants to embed a SQLite database, set `type: "sqlite"` in the import attribute and the `embed` attribute to `"true"`. If your application wants to embed a SQLite database into the compiled executable, set `type: "sqlite"` in the import attribute and the `embed` attribute to `"true"`.
The database file must already exist on disk. Then, import it in your code:
```ts index.ts icon="/icons/typescript.svg" ```ts index.ts icon="/icons/typescript.svg"
import myEmbeddedDb from "./my.db" with { type: "sqlite", embed: "true" }; import myEmbeddedDb from "./my.db" with { type: "sqlite", embed: "true" };
@@ -420,7 +422,19 @@ import myEmbeddedDb from "./my.db" with { type: "sqlite", embed: "true" };
console.log(myEmbeddedDb.query("select * from users LIMIT 1").get()); console.log(myEmbeddedDb.query("select * from users LIMIT 1").get());
``` ```
This database is read-write, but all changes are lost when the executable exits (since it's stored in memory). Finally, compile it into a standalone executable:
```bash terminal icon="terminal"
bun build --compile ./index.ts --outfile mycli
```
<Note>
The database file must exist on disk when you run `bun build --compile`. The `embed: "true"` attribute tells the
bundler to include the database contents inside the compiled executable. When running normally with `bun run`, the
database file is loaded from disk just like a regular SQLite import.
</Note>
In the compiled executable, the embedded database is read-write, but all changes are lost when the executable exits (since it's stored in memory).
### Embed N-API Addons ### Embed N-API Addons