First commit

Author: ankane

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Raku/setup-raku@v1
+      - uses: ankane/setup-postgres@v1
+        with:
+          database: pgvector_raku_test
+          dev-files: true
+      - run: |
+          cd /tmp
+          git clone --branch v0.8.0 https://github.com/pgvector/pgvector.git
+          cd pgvector
+          make
+          sudo make install
+      - run: zef install DB::Pg
+      - run: raku dbiish.raku
+      - run: raku dbpg.raku

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andrew Kane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,118 @@
+# pgvector-raku
+
+[pgvector](https://github.com/pgvector/pgvector) examples for Raku
+
+Supports [DBIish](https://github.com/raku-community-modules/DBIish) and [DB::Pg](https://github.com/CurtTilmes/raku-dbpg)
+
+[![Build Status](https://github.com/pgvector/pgvector-raku/actions/workflows/build.yml/badge.svg)](https://github.com/pgvector/pgvector-raku/actions)
+
+## Getting Started
+
+Follow the instructions for your database library:
+
+- [DBIish](#dbiish)
+- [DB::Pg](#dbpg)
+
+## DBIish
+
+Enable the extension
+
+```raku
+$dbh.execute('CREATE EXTENSION IF NOT EXISTS vector');
+```
+
+Create a table
+
+```raku
+$dbh.execute('CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))');
+```
+
+Insert vectors
+
+```raku
+my $embedding1 = '[1,1,1]';
+my $embedding2 = '[2,2,2]';
+my $embedding3 = '[1,1,2]';
+$dbh.execute('INSERT INTO items (embedding) VALUES (?), (?), (?)', $embedding1, $embedding2, $embedding3);
+```
+
+Get the nearest neighbors
+
+```raku
+my $embedding = '[1,1,1]';
+.say for $dbh.execute('SELECT * FROM items ORDER BY embedding <-> ? LIMIT 5', $embedding).allrows();
+```
+
+Add an approximate index
+
+```raku
+$dbh.execute('CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)');
+# or
+$dbh.execute('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](dbiish.raku)
+
+## DB::Pg
+
+Enable the extension
+
+```raku
+$pg.query('CREATE EXTENSION IF NOT EXISTS vector');
+```
+
+Create a table
+
+```raku
+$pg.query('CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))');
+```
+
+Insert vectors
+
+```raku
+my $embedding1 = '[1,1,1]';
+my $embedding2 = '[2,2,2]';
+my $embedding3 = '[1,1,2]';
+$pg.query('INSERT INTO items (embedding) VALUES ($1), ($2), ($3)', $embedding1, $embedding2, $embedding3);
+```
+
+Get the nearest neighbors
+
+```raku
+my $embedding = '[1,1,1]';
+.say for $pg.query('SELECT * FROM items ORDER BY embedding <-> $1 LIMIT 5', $embedding).arrays;
+```
+
+Add an approximate index
+
+```raku
+$pg.query('CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)');
+# or
+$pg.query('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](dbpg.raku)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/pgvector/pgvector-raku/issues)
+- Fix bugs and [submit pull requests](https://github.com/pgvector/pgvector-raku/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/pgvector/pgvector-raku.git
+cd pgvector-raku
+createdb pgvector_raku_test
+zef install DB::Pg
+raku dbiish.raku
+raku dbpg.raku
+```

dbiish.raku

@@ -0,0 +1,18 @@
+use v6;
+use DBIish;
+
+my $dbh = DBIish.connect("Pg", :database<pgvector_raku_test>);
+
+$dbh.execute('CREATE EXTENSION IF NOT EXISTS vector');
+$dbh.execute('DROP TABLE IF EXISTS items');
+$dbh.execute('CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))');
+
+my $embedding1 = '[1,1,1]';
+my $embedding2 = '[2,2,2]';
+my $embedding3 = '[1,1,2]';
+$dbh.execute('INSERT INTO items (embedding) VALUES (?), (?), (?)', $embedding1, $embedding2, $embedding3);
+
+my $embedding = '[1,1,1]';
+.say for $dbh.execute('SELECT * FROM items ORDER BY embedding <-> ? LIMIT 5', $embedding).allrows();
+
+$dbh.execute('CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)');

dbpg.raku

@@ -0,0 +1,17 @@
+use DB::Pg;
+
+my $pg = DB::Pg.new(conninfo => 'dbname=pgvector_raku_test');
+
+$pg.query('CREATE EXTENSION IF NOT EXISTS vector');
+$pg.query('DROP TABLE IF EXISTS items');
+$pg.query('CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))');
+
+my $embedding1 = '[1,1,1]';
+my $embedding2 = '[2,2,2]';
+my $embedding3 = '[1,1,2]';
+$pg.query('INSERT INTO items (embedding) VALUES ($1), ($2), ($3)', $embedding1, $embedding2, $embedding3);
+
+my $embedding = '[1,1,1]';
+.say for $pg.query('SELECT * FROM items ORDER BY embedding <-> $1 LIMIT 5', $embedding).arrays;
+
+$pg.query('CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)');