Added Bun SQL example

Author: ankane

.github/workflows/build.yml

@@ -27,6 +27,10 @@ jobs:
       - run: bun install
       - run: bunx prisma migrate reset --force
       - run: bun run test
+      - run: |
+          cd examples/bun
+          bun install
+          bun run example.js
 
       # Deno
       - uses: denoland/setup-deno@v1

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 package-lock.json
+bun.lock
 bun.lockb

README.md

@@ -2,7 +2,7 @@
 
 [pgvector](https://github.com/pgvector/pgvector) support for Node.js, Deno, and Bun (and TypeScript)
 
-Supports [node-postgres](https://github.com/brianc/node-postgres), [Knex.js](https://github.com/knex/knex), [Objection.js](https://github.com/vincit/objection.js), [Kysely](https://github.com/kysely-org/kysely), [Sequelize](https://github.com/sequelize/sequelize), [pg-promise](https://github.com/vitaly-t/pg-promise), [Prisma](https://github.com/prisma/prisma), [Postgres.js](https://github.com/porsager/postgres), [Slonik](https://github.com/gajus/slonik), [TypeORM](https://github.com/typeorm/typeorm), [MikroORM](https://github.com/mikro-orm/mikro-orm), and [Drizzle ORM](https://github.com/drizzle-team/drizzle-orm)
+Supports [node-postgres](https://github.com/brianc/node-postgres), [Knex.js](https://github.com/knex/knex), [Objection.js](https://github.com/vincit/objection.js), [Kysely](https://github.com/kysely-org/kysely), [Sequelize](https://github.com/sequelize/sequelize), [pg-promise](https://github.com/vitaly-t/pg-promise), [Prisma](https://github.com/prisma/prisma), [Postgres.js](https://github.com/porsager/postgres), [Slonik](https://github.com/gajus/slonik), [TypeORM](https://github.com/typeorm/typeorm), [MikroORM](https://github.com/mikro-orm/mikro-orm), [Drizzle ORM](https://github.com/drizzle-team/drizzle-orm), and [Bun SQL](https://bun.sh/docs/api/sql)
 
 [![Build Status](https://github.com/pgvector/pgvector-node/actions/workflows/build.yml/badge.svg)](https://github.com/pgvector/pgvector-node/actions)
 
@@ -28,6 +28,7 @@ And follow the instructions for your database library:
 - [TypeORM](#typeorm)
 - [MikroORM](#mikroorm)
 - [Drizzle ORM](#drizzle-orm)
+- [Bun SQL](#bun-sql)
 
 Or check out some examples:
 
@@ -678,6 +679,55 @@ Also supports `innerProduct`, `cosineDistance`, `l1Distance`, `hammingDistance`,
 
 See a [full example](tests/drizzle-orm.test.mjs)
 
+## Bun SQL
+
+Import the library
+
+```javascript
+import pgvector from 'pgvector';
+```
+
+Enable the extension
+
+```javascript
+await sql`CREATE EXTENSION IF NOT EXISTS vector`;
+```
+
+Create a table
+
+```javascript
+await sql`CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))`;
+```
+
+Insert vectors
+
+```javascript
+const newItems = [
+  {embedding: pgvector.toSql([1, 2, 3])},
+  {embedding: pgvector.toSql([4, 5, 6])}
+];
+await sql`INSERT INTO items (embedding) ${sql(newItems)}`;
+```
+
+Get the nearest neighbors to a vector
+
+```javascript
+const embedding = pgvector.toSql([1, 2, 3]);
+const items = await sql`SELECT * FROM items ORDER BY embedding <-> ${embedding} LIMIT 5`.values();
+```
+
+Add an approximate index
+
+```javascript
+await sql`CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)`;
+// or
+await sql`CREATE INDEX ON items USING ivfflat (embedding vector_l2_ops) WITH (lists = 100)`;
+```
+
+Use `vector_ip_ops` for inner product and `vector_cosine_ops` for cosine distance
+
+See a [full example](examples/bun/example.js)
+
 ## History
 
 View the [changelog](https://github.com/pgvector/pgvector-node/blob/master/CHANGELOG.md)

examples/bun/example.js

@@ -0,0 +1,24 @@
+import { SQL } from 'bun';
+import pgvector from 'pgvector';
+
+const sql = new SQL({database: 'pgvector_example'});
+
+await sql`CREATE EXTENSION IF NOT EXISTS vector`;
+await sql`DROP TABLE IF EXISTS items`;
+await sql`CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))`;
+
+const item = {
+  embedding: pgvector.toSql([1, 2, 3])
+};
+await sql`INSERT INTO items (embedding) ${sql(item)}`;
+
+const items = [
+  {embedding: pgvector.toSql([4, 5, 6])},
+  {embedding: pgvector.toSql([7, 8, 9])}
+];
+await sql`INSERT INTO items (embedding) ${sql(items)}`;
+
+await sql`CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)`;
+
+const rows = await sql`SELECT * FROM items ORDER BY embedding <-> ${item.embedding} LIMIT 5`.values();
+console.log(rows);

examples/bun/package.json

@@ -0,0 +1,7 @@
+{
+    "private": true,
+    "type": "module",
+    "dependencies": {
+        "pgvector": "file:../.."
+    }
+}