pgvector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1699eea3d6ebb0ede69e22c38fe8596482577b2258904a76c877295bc9008e8f
+  data.tar.gz: d7ecf8fb6dc2d3bf781a5d65d07bc5abea5f768a268720fd93e6de6e4b778885
+SHA512:
+  metadata.gz: 010f1f0c74ac1ef69bba4953a50b24d106f359b9e77c8f7bc282d1272008b0376f1b9d8fe72a67c1325bf49b1bd0fa29f6fb5aa139966a46eda0478b3957d56a
+  data.tar.gz: e21326c03271c19bd8babcf43d29b3896ef30f0bd1011284c52e6f980e40400f9bc4b56345130968d401075d615ab3d5df7198730899bebaab8e36b6ccfb6f47

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2022-02-07)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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.

data/README.md

@@ -0,0 +1,69 @@
+# pgvector-ruby
+
+[pgvector](https://github.com/pgvector/pgvector) support for Ruby
+
+Supports the [pg](https://github.com/ged/ruby-pg) gem
+
+For Rails, check out [Neighbor](https://github.com/ankane/neighbor)
+
+[![Build Status](https://github.com/pgvector/pgvector-ruby/workflows/build/badge.svg?branch=master)](https://github.com/pgvector/pgvector-ruby/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "pgvector"
+```
+
+And follow the instructions for your database library:
+
+- [pg](#pg)
+
+## pg
+
+Register the vector type with your connection
+
+```ruby
+require "pgvector/pg"
+
+registry = PG::BasicTypeRegistry.new.define_default_types
+Pgvector::PG.register_vector(registry)
+conn.type_map_for_results = PG::BasicTypeMapForResults.new(conn, registry: registry)
+```
+
+Insert a vector
+
+```ruby
+factors = [1, 2, 3]
+conn.exec_params("INSERT INTO items (factors) VALUES ($1)", [factors])
+```
+
+Get the nearest neighbors to a vector
+
+```ruby
+conn.exec_params("SELECT * FROM items ORDER BY factors <-> $1 LIMIT 5", [factors]).to_a
+```
+
+## History
+
+View the [changelog](https://github.com/pgvector/pgvector-ruby/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/pgvector/pgvector-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/pgvector/pgvector-ruby/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/pgvector/pgvector-ruby.git
+cd pgvector-ruby
+createdb pgvector_ruby_test
+bundle install
+bundle exec rake test
+```

data/lib/pgvector/pg.rb

@@ -0,0 +1,17 @@
+require "pg"
+
+module Pgvector
+  module PG
+    def self.register_vector(registry)
+      registry.register_type(0, "vector", nil, TextDecoder::Vector)
+    end
+
+    module TextDecoder
+      class Vector < ::PG::SimpleDecoder
+        def decode(string, tuple = nil, field = nil)
+          string[1..-2].split(",").map(&:to_f)
+        end
+      end
+    end
+  end
+end

data/lib/pgvector/version.rb

@@ -0,0 +1,3 @@
+module Pgvector
+  VERSION = "0.1.0"
+end

data/lib/pgvector.rb

@@ -0,0 +1 @@
+require "pgvector/version"

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: pgvector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/pgvector.rb
+- lib/pgvector/pg.rb
+- lib/pgvector/version.rb
+homepage: https://github.com/pgvector/pgvector-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: pgvector support for Ruby
+test_files: []