activerecord-turbopuffer-adapter 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe88ca95c2999749426d72f89dd7d0327a53d5a08bf6a0b2446340d6b17e173
-  data.tar.gz: c6c1611fe66ea9ca7dff51fde19ce3843249d8b91e955aa21ba500d9fe8efe1a
+  metadata.gz: fde17eff7db3a885b55a20550170a189c505ef52afc6bbdfded1f9b5dfcc9a76
+  data.tar.gz: 4ee793a06d003d5d69c6d3748c7a74331d6bd4c5db1df6c4ec79fba22f408fea
 SHA512:
-  metadata.gz: 4cd6c79fd3b22a79ca2d18a8ed68765360b7e63c9a3f2d4e3bb82d644553bbf7fcd93a05489f58c3285c5967ec3f2e2f522bafa7e4c1c9debf5190b4f626c85c
-  data.tar.gz: c8f7cdae01828498d93c66d345d34bdbf5cda39ff46ff13ec7126bfe97b42bba3d9c4b2337fbce08640755f87d49d42b9283cec227f9605d6b1af02bb9b1f998
+  metadata.gz: b716b0601df52af79a1d6edbba112630504f356fb2e6c7b91ad00ac6e41485809b43849eb58d8399f0238190db6ea3f5bd3b0b490f0658b17e2d138132f24b7c
+  data.tar.gz: 7b79a130b932801f07c98ec849cb9838c8c86246c432464b64aa2c9c079d8432146bb189986886169f614f395fb5e1c00a7b5ccc56a76424d4fbe1ca3ef6b290

data/README.md

@@ -109,6 +109,7 @@ Document.where(tags: nil)
 Document.where(scores: 90..)
 
 Document.order(:title).limit(20)
+Document.order(:title).limit(20).offset(20)
 Document.group(:title).count
 Document.count
 Document.find("018f...")
@@ -128,10 +129,24 @@ Document
   .limit(10)
 ```
 
-> Note that turbopuffer has a limit on the maximum number of documents returned (https://turbopuffer.com/docs/query#param-limit), so Document.all.to_a etc. will only return at most 10,000 items
+> Note that turbopuffer has a limit on the maximum number of documents returned (https://turbopuffer.com/docs/query#param-limit), so Document.all.to_a etc. will only return at most 10,000 items, and `limit` plus `offset` must stay within that
 
 > Eventual reads are cheaper but may not include writes from the last few seconds. Set a default with `turbopuffer_consistency "eventual"` in a model or `consistency: eventual` in `database.yml`. Strong is the default.
 
+### Namespaces per tenant
+
+turbopuffer recommends one namespace per tenant: a query can only ever see that tenant's documents, and search covers just the documents that matter rather than everyone's. `namespace` scopes a model to any namespace, and records remember where they were loaded from, so `update!`, `reload` and `destroy` go back to the same place.
+
+```ruby
+Document.namespace("documents-#{tenant.id}").create!(title: "Hello")
+Document.namespace("documents-#{tenant.id}").where(published: true)
+
+doc = Document.namespace("documents-#{tenant.id}").find(id)
+doc.update!(published: true)
+```
+
+The name is used as given (under `namespace_prefix` if one is set). Without `namespace`, a model's table name is its namespace.
+
 ### Errors
 
 Turbopuffer errors are raised as the ActiveRecord exceptions a Rails app already handles.

data/lib/active_record/connection_adapters/turbopuffer_adapter.rb

@@ -279,9 +279,11 @@ module ActiveRecord
 
         tpuf_query_args = {
           include_attributes: fields,
-          top_k: query.top_k.present? ? query.top_k : 10_000
+          top_k: query.top_k.present? ? query.top_k : 10_000 - query.offset.to_i
         }
 
+        tpuf_query_args[:offset] = query.offset if query.offset
+
         tpuf_query_args[:rank_by] = query.rank_by.first if query.rank_by.present?
         tpuf_query_args[:filters] = query.filters if query.filters
         consistency = consistency_for(query)
@@ -299,8 +301,7 @@ module ActiveRecord
       def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch:)
         tpuf_query = sql.is_a?(Array) ? sql.first : sql
 
-        namespace_name = [ @config[:namespace_prefix], tpuf_query.namespace ].compact_blank.join("-")
-        namespace = raw_connection.namespace(namespace_name)
+        namespace = raw_connection.namespace(namespace_name_for(tpuf_query))
 
         result = case tpuf_query.op
         when :insert then turbopuffer_insert(namespace, tpuf_query)
@@ -318,6 +319,12 @@ module ActiveRecord
         result
       end
 
+      def namespace_name_for(query)
+        override = query.namespace_override || ::Turbopuffer::ActiveRecord.namespace_override
+
+        [ @config[:namespace_prefix], override || query.namespace ].compact_blank.join("-")
+      end
+
       def arel_visitor
         Arel::Visitors::Turbopuffer.new
       end

data/lib/arel/visitors/turbopuffer.rb

@@ -11,7 +11,9 @@ module Arel::Visitors
         include_attributes: @include_attributes,
         aggregate_by: @aggregate_by,
         upsert_rows: @upsert_rows,
-        consistency: @consistency
+        consistency: @consistency,
+        namespace_override: @namespace_override,
+        offset: @offset
       }
     end
     def to_s = JSON.generate(to_h)
@@ -21,10 +23,10 @@ module Arel::Visitors
     alias == eql?
 
     attr_reader :op, :namespace, :filters, :top_k, :rank_by, :include_attributes, :upsert_rows, :aggregate_by, :group_by,
-                :consistency
+                :consistency, :namespace_override, :offset
 
-    def initialize(op:, namespace:, filters: nil, top_k: nil, rank_by: nil, include_attributes: nil,
-                   upsert_rows: nil, aggregate_by: nil, group_by: nil, consistency: nil)
+    def initialize(op:, namespace:, filters: nil, top_k: nil, rank_by: nil, include_attributes: nil, upsert_rows: nil,
+                   aggregate_by: nil, group_by: nil, consistency: nil, namespace_override: nil, offset: nil)
       @op = op
       @namespace = namespace
       @filters = filters
@@ -35,6 +37,8 @@ module Arel::Visitors
       @group_by = group_by
       @upsert_rows = upsert_rows
       @consistency = consistency
+      @namespace_override = namespace_override
+      @offset = offset
     end
   end
 
@@ -98,7 +102,6 @@ module Arel::Visitors
     end
 
     def visit_Arel_Nodes_SelectStatement(o)
-      raise NotImplementedError, "offset is not supported, filter on a sortable attribute for cursor pagination" if o.offset
       # https://turbopuffer.com/docs/query#ordering-by-attributes: "Ordering by
       # multiple attributes isn't yet implemented."
       raise NotImplementedError, "one ranking per query, sort in Ruby after loading" if o.orders.size > 1
@@ -111,6 +114,8 @@ module Arel::Visitors
       aggregates, attributes = core.projections.partition { |p| aggregate?(p) }
       aggregate = aggregates.first
 
+      raise NotImplementedError, "offset is not supported on aggregate queries" if o.offset && aggregate
+
       filters = core.wheres.map { |w| visit(w) }
       counted = aggregate && counted_attribute(aggregate)
       filters << [ visit(counted), "NotEq", nil ] if counted
@@ -124,10 +129,20 @@ module Arel::Visitors
         include_attributes: attributes.flat_map { |p| visit(p) },
         group_by:           core.groups.map { |g| visit(g) },
         aggregate_by:       aggregate && visit(aggregate),
-        consistency:        consistency_hint(core.optimizer_hints)
+        consistency:        consistency_hint(core.optimizer_hints),
+        namespace_override: namespace_annotation(core.comment),
+        offset:             o.offset && visit(o.offset)
       )
     end
 
+    def namespace_annotation(comment)
+      return unless comment
+
+      prefix = ::Turbopuffer::ActiveRecord::NAMESPACE_ANNOTATION
+      annotation = comment.values.reverse.find { |value| value.start_with?(prefix) }
+      annotation&.delete_prefix(prefix)
+    end
+
     def consistency_hint(hints)
       return unless hints
 
@@ -152,18 +167,20 @@ module Arel::Visitors
       rows = o.values ? visit(o.values) : [ [] ]
 
       TurbopufferQuery.new(
-        op:          :update,
-        namespace:   visit(o.relation),
-        filters:     conjoin(o.wheres.map { |w| visit(w) }),
-        upsert_rows: rows
+        op:                 :update,
+        namespace:          visit(o.relation),
+        filters:            conjoin(o.wheres.map { |w| visit(w) }),
+        upsert_rows:        rows,
+        namespace_override: namespace_annotation(o.comment)
       )
     end
 
     def visit_Arel_Nodes_DeleteStatement(o)
       TurbopufferQuery.new(
-        op:        :delete,
-        namespace: visit(o.relation),
-        filters:   conjoin(o.wheres.map { |w| visit(w) })
+        op:                 :delete,
+        namespace:          visit(o.relation),
+        filters:            conjoin(o.wheres.map { |w| visit(w) }),
+        namespace_override: namespace_annotation(o.comment)
       )
     end
 
@@ -194,6 +211,10 @@ module Arel::Visitors
       visit(o.left)
     end
 
+    def visit_Arel_Nodes_TableAlias(o)
+      raise NotImplementedError, "subqueries are not supported, count a limited or offset relation in Ruby after loading"
+    end
+
     def visit_Arel_Table(o) = o.name
 
     # filters
@@ -280,6 +301,7 @@ module Arel::Visitors
     def visit_Arel_Nodes_Casted(o)         = o.value_for_database
     def visit_Arel_Nodes_Quoted(o)         = o.expr
     def visit_Arel_Nodes_Limit(o)          = visit(o.expr)
+    def visit_Arel_Nodes_Offset(o)         = visit(o.expr)
     def visit_Arel_Nodes_Ascending(o)      = [ visit(o.expr), "asc" ]
     def visit_Arel_Nodes_Descending(o)     = [ visit(o.expr), "desc" ]
 

data/lib/turbopuffer/active_record/namespace_scope.rb

@@ -0,0 +1,15 @@
+module Turbopuffer
+  module ActiveRecord
+    module NamespaceScope
+      def turbopuffer_namespace
+        annotation = annotate_values.reverse.find { |value| value.start_with?(NAMESPACE_ANNOTATION) }
+        annotation&.delete_prefix(NAMESPACE_ANNOTATION)
+      end
+
+      def exec_queries(...) = ::Turbopuffer::ActiveRecord.with_namespace(turbopuffer_namespace) { super }
+      def insert_all(...)   = ::Turbopuffer::ActiveRecord.with_namespace(turbopuffer_namespace) { super }
+      def insert_all!(...)  = ::Turbopuffer::ActiveRecord.with_namespace(turbopuffer_namespace) { super }
+      def upsert_all(...)   = ::Turbopuffer::ActiveRecord.with_namespace(turbopuffer_namespace) { super }
+    end
+  end
+end

data/lib/turbopuffer/active_record/schema/model.rb

@@ -13,6 +13,27 @@ module Turbopuffer
           class_attribute :_turbopuffer_consistency,      instance_accessor: false, default: nil
         end
 
+        def turbopuffer_namespace = @turbopuffer_namespace
+
+        def update_columns(...) = with_turbopuffer_namespace { super }
+
+        private
+
+        def init_internals
+          @turbopuffer_namespace = ::Turbopuffer::ActiveRecord.namespace_override ||
+            self.class.current_scope.try(:turbopuffer_namespace)
+          super
+        end
+
+        def _create_record(...) = with_turbopuffer_namespace { super }
+        def _update_row(...)    = with_turbopuffer_namespace { super }
+        def _delete_row(...)    = with_turbopuffer_namespace { super }
+        def _find_record(...)   = with_turbopuffer_namespace { super }
+
+        def with_turbopuffer_namespace(&block)
+          ::Turbopuffer::ActiveRecord.with_namespace(@turbopuffer_namespace, &block)
+        end
+
         class << self
           def namespaces
             ::ActiveRecord::Base.descendants.select do |model|
@@ -82,6 +103,10 @@ module Turbopuffer
             select(*turbopuffer_attributes.map(&:name))
           end
 
+          def namespace(name)
+            annotate("#{NAMESPACE_ANNOTATION}#{name}").extending(::Turbopuffer::ActiveRecord::NamespaceScope)
+          end
+
           def glob(pattern, case_sensitive: true)
             ::Turbopuffer::ActiveRecord::Glob.new(pattern, case_sensitive:)
           end

data/lib/turbopuffer/active_record/schema.rb

@@ -1,6 +1,7 @@
 require "arel/nodes/glob"
 require "arel/nodes/rank_by_node"
 require "turbopuffer/active_record/glob"
+require "turbopuffer/active_record/namespace_scope"
 require "turbopuffer/active_record/schema/attribute"
 require "turbopuffer/active_record/schema/model"
 

data/lib/turbopuffer/active_record/version.rb

@@ -1,5 +1,5 @@
 module Turbopuffer
   module ActiveRecord
-    VERSION = "0.1.7"
+    VERSION = "0.1.9"
   end
 end

data/lib/turbopuffer/active_record.rb

@@ -4,6 +4,20 @@ module Turbopuffer
   module ActiveRecord
     class Error < StandardError; end
 
+    NAMESPACE_ANNOTATION = "turbopuffer_namespace="
+
+    def self.namespace_override
+      ActiveSupport::IsolatedExecutionState[:turbopuffer_namespace]
+    end
+
+    def self.with_namespace(name)
+      previous = namespace_override
+      ActiveSupport::IsolatedExecutionState[:turbopuffer_namespace] = name
+      yield
+    ensure
+      ActiveSupport::IsolatedExecutionState[:turbopuffer_namespace] = previous
+    end
+
     # Teaches Active Record that `adapter: turbopuffer` in database.yml maps to
     # our adapter. The railtie calls this during boot; test harnesses and
     # non-Rails consumers call it themselves.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turbopuffer-adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Richard Monette
 bindir: bin
 cert_chain: []
-date: 2026-10-06 00:00:00.000000000 Z
+date: 2026-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -27,16 +27,16 @@ dependencies:
   name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -89,6 +89,7 @@ files:
 - lib/arel/visitors/turbopuffer.rb
 - lib/turbopuffer/active_record.rb
 - lib/turbopuffer/active_record/glob.rb
+- lib/turbopuffer/active_record/namespace_scope.rb
 - lib/turbopuffer/active_record/railtie.rb
 - lib/turbopuffer/active_record/schema.rb
 - lib/turbopuffer/active_record/schema/attribute.rb