First commit

Author: ankane

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: 26
+      - uses: ankane/setup-postgres@v1
+        with:
+          database: pgvector_erlang_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: rebar3 escriptize
+      - run: _build/default/bin/example

.gitignore

@@ -0,0 +1,4 @@
+_build
+*.beam
+*.lock
+erl_crash.dump

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,70 @@
+# pgvector-erlang
+
+[pgvector](https://github.com/pgvector/pgvector) support for Erlang
+
+Supports [epgsql](https://github.com/epgsql/epgsql)
+
+[![Build Status](https://github.com/pgvector/pgvector-erlang/actions/workflows/build.yml/badge.svg)](https://github.com/pgvector/pgvector-erlang/actions)
+
+## Getting Started
+
+Follow the instructions for your database library:
+
+- [epgsql](#epgsql)
+
+## epgsql
+
+Enable the extension
+
+```erlang
+epgsql:equery(C, "CREATE EXTENSION IF NOT EXISTS vector"),
+```
+
+Create a table
+
+```erlang
+epgsql:equery(C, "CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))"),
+```
+
+Insert vectors
+
+```erlang
+epgsql:equery(C, "INSERT INTO items (embedding) VALUES ($1), ($2)", ["[1,2,3]", "[4,5,6]"]),
+```
+
+Get the nearest neighbors
+
+```erlang
+epgsql:equery(C, "SELECT id FROM items ORDER BY embedding <-> $1 LIMIT 5", ["[3,1,2]"]),
+```
+
+Add an approximate index
+
+```erlang
+epgsql:equery(C, "CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)"),
+% or
+epgsql:equery(C, "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](src/example.erl)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/pgvector/pgvector-erlang/issues)
+- Fix bugs and [submit pull requests](https://github.com/pgvector/pgvector-erlang/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/pgvector/pgvector-erlang.git
+cd pgvector-erlang
+createdb pgvector_erlang_test
+rebar3 escriptize
+_build/default/bin/example
+```

rebar.config

@@ -0,0 +1,13 @@
+{erl_opts, [no_debug_info]}.
+{deps, [{epgsql, "4.7.1"}]}.
+
+{escript_incl_apps, [example]}.
+{escript_main_app, example}.
+{escript_name, example}.
+{escript_emu_args, "%%! +sbtu +A1\n"}.
+
+{profiles, [
+    {test, [
+        {erl_opts, [debug_info]}
+    ]}
+]}.

src/example.app.src

@@ -0,0 +1,13 @@
+{application, example, [
+    {description, "pgvector examples for Erlang"},
+    {vsn, "0.1.0"},
+    {registered, []},
+    {applications, [
+        epgsql,
+        kernel,
+        stdlib
+    ]},
+    {env, []},
+    {modules, []},
+    {links, []}
+ ]}.

src/example.erl

@@ -0,0 +1,18 @@
+-module(example).
+-export([main/1]).
+
+main(_Args) ->
+    {ok, C} = epgsql:connect(#{
+        host => "localhost",
+        username => os:getenv("USER"),
+        database => "pgvector_erlang_test"
+    }),
+    {ok, _, _} = epgsql:equery(C, "CREATE EXTENSION IF NOT EXISTS vector"),
+    {ok, _, _} = epgsql:equery(C, "DROP TABLE IF EXISTS items"),
+    {ok, _, _} = epgsql:equery(C, "CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3))"),
+    {ok, _} = epgsql:equery(C, "INSERT INTO items (embedding) VALUES ($1), ($2), ($3)", ["[1,1,1]", "[2,2,2]", "[1,1,2]"]),
+    {ok, _Count, Rows} = epgsql:equery(C, "SELECT id FROM items ORDER BY embedding <-> $1 LIMIT 5", ["[1,1,1]"]),
+    io:format("~p~n", [Rows]),
+    {ok, _, _} = epgsql:equery(C, "CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)"),
+    ok = epgsql:close(C),
+    erlang:halt(0).