mirror of
https://github.com/asg017/sqlite-vec.git
synced 2026-04-25 16:56:27 +02:00
103 lines
2.8 KiB
Markdown
103 lines
2.8 KiB
Markdown
# Using `sqlite-vec` in Node.js, Deno, and Bun
|
|
|
|
[](https://www.npmjs.com/package/sqlite-vec)
|
|
|
|
To use `sqlite-vec` in Node.js, Deno or Bun, install the
|
|
[`sqlite-vec` NPM package](https://npmjs.com/package/sqlite-vec) using your
|
|
favorite package manager:
|
|
|
|
::: code-group
|
|
|
|
```bash [npm]
|
|
npm install sqlite-vec
|
|
```
|
|
|
|
```bash [Bun]
|
|
bun install sqlite-vec
|
|
```
|
|
|
|
```bash [Deno]
|
|
deno add npm:sqlite-vec
|
|
```
|
|
|
|
:::
|
|
|
|
Once installed, use the `sqliteVec.load()` function to load `sqlite-vec` SQL
|
|
functions into a SQLite connection.
|
|
|
|
```js
|
|
import * as sqliteVec from "sqlite-vec";
|
|
import Database from "better-sqlite3";
|
|
|
|
const db = new Database(":memory:");
|
|
sqliteVec.load(db);
|
|
|
|
const { vec_version } = db
|
|
.prepare("select vec_version() as vec_version;")
|
|
.get();
|
|
|
|
console.log(`vec_version=${vec_version}`);
|
|
```
|
|
|
|
The `load()` function is compatable with
|
|
[`better-sqlite3`](https://github.com/WiseLibs/better-sqlite3),
|
|
[`node-sqlite3`](https://github.com/TryGhost/node-sqlite3),
|
|
[`jsr:@db/sqlite`](https://jsr.io/@db/sqlite) (Deno), and
|
|
[`bun:sqlite`](https://bun.sh/docs/api/sqlite).
|
|
|
|
## Working with vectors in JavaScript
|
|
|
|
if your vectors are represented as an array of numbers, wrap it in a
|
|
[`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array),
|
|
and use
|
|
[`.buffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/buffer)
|
|
accessor to bind as a parameter to `sqlite-vec` SQL functions.
|
|
|
|
```js
|
|
// TODO
|
|
const embedding = new Float32Array([0.1, 0.2, 0.3, 0.4]);
|
|
const stmt = db.prepare("select vec_length(?)");
|
|
console.log(stmt.run(embedding.buffer));
|
|
```
|
|
|
|
## Node.js
|
|
|
|
Here's a quick recipe of using `sqlite-vec` with
|
|
[`better-sqlite3`](https://github.com/WiseLibs/better-sqlite3) in Node.js.
|
|
|
|
```js
|
|
```
|
|
|
|
See
|
|
[`simple-node/demo.mjs`](https://github.com/asg017/sqlite-vec/blob/main/examples/simple-node/demo.mjs)
|
|
for a more complete Node.js demo.
|
|
|
|
## Deno
|
|
|
|
Here's a quick recipe of using `sqlite-vec` with
|
|
[`jsr:@db/sqlite`](https://jsr.io/@db/sqlite) in Deno. It will only work on Deno
|
|
version `1.44` or greater, because of a bug in previous Deno version.
|
|
|
|
Keep in mind, the `better-sqlite3` example above also works in Deno, you just
|
|
need to prefix the `better-sqlite3` import with `npm:`, like
|
|
`import * from "npm:better-sqlite3"`.
|
|
|
|
```ts
|
|
```
|
|
|
|
See
|
|
[`simple-deno/demo.ts`](https://github.com/asg017/sqlite-vec/blob/main/examples/simple-deno/demo.ts)
|
|
for a more complete Deno demo.
|
|
|
|
## Bun
|
|
|
|
Here's a quick recipe of using `sqlite-vec` with
|
|
[`bun:sqlite`](https://bun.sh/docs/api/sqlite) in Bun. The `better-sqlite3`
|
|
example above also works with Bun.
|
|
|
|
```ts
|
|
```
|
|
|
|
See
|
|
[`simple-bun/demo.ts`](https://github.com/asg017/sqlite-vec/blob/main/examples/simple-bun/demo.ts)
|
|
for a more complete Bun demo.
|