sequel-xtdb 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feef2fdeeefa8b1adfd9d214aab772c02250814aa8e6ef36a79bc7eddc4a8386
-  data.tar.gz: 417e16888185230ad9f7714b7d0d322594457f6f0d8645c033a9203463103293
+  metadata.gz: d0f7d61f6d6a7c9ccb319122b964eb284815e959dfc2fa2b529f00195e2b8c91
+  data.tar.gz: 142f6c92856959dff66759cabef3c5cfbbe480eafda22d50ccc62d1e7178ebdb
 SHA512:
-  metadata.gz: 28456e08dfc22572d63a5de8dbfba0b8f849a78478f1ec43336e2495212a4217bacf665d53faf7f205d54c75ef8df931064288dd079bf496dd85389bcb3d1911
-  data.tar.gz: cb4e306b7641e07812e146843d982104e143935c83d58ffc7cd480246f1dec99fc0f5946fa2ebd964eed4c50e338051785fa772119fe497d156cf88e82e2925c
+  metadata.gz: '0089ee3ce060d52540bac403359f66e334630787f1314a238482a28a8c2c49dd9415655d49c3d653cb8acefd052640d2c337f62b41e30f89ca3edd822625ca36'
+  data.tar.gz: 0f9a8848f64aba9c29424c073add18d6e64f78430add511866ce02b428254b741926ab89787473acfe8c72b9137ae6f61b0a8b1e2640b1fd8c346003faf4b8ba

data/README.md

@@ -1,6 +1,8 @@
-# Sequel::XTDB
+# sequel-xtdb
 
-Adapter to connect to XTDB v2 using Sequel.
+[![Gem Version](https://badge.fury.io/rb/sequel-xtdb.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/sequel-xtdb)
+
+Adapter to connect to [XTDB](https://docs.xtdb.com/) v2 using [Sequel](https://sequel.jeremyevans.net/).
 
 ## Installation
 
@@ -34,22 +36,20 @@ irb(main)> DB["select * from products"].all
 
 ### time-travel
 
-_these examples use the [activesupport time helpers](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html)_
-
 ```ruby
+def shift_days(n, from: Time.now)= from + (60 * 60 * 24 * n)
 DB = Sequel.connect("xtdb://localhost:5432/xtdb")
 
 # get a dataset (ie query)
 users = DB[:users]
-past, future = 2.days.ago, 2.days.from_now
-ds1, ds2 = users.as_of(valid: past), users.as_of(valid: future)
+ds1, ds2 = users.as_of(valid: shift_days(-2)), users.as_of(valid: shift_days(2))
 
 # expect empty
 ds1.all
 ds1.insert(_id: 1, name: "James")
 
 # expect a user
-ds1.as_of(valid: 2.days.ago).all
+ds1.as_of(valid: shift_days(-1)).all
 
 # add to future
 ds2.insert(_id: 2, name: "Jeremy")
@@ -57,21 +57,24 @@ ds2.insert(_id: 2, name: "Jeremy")
 # expect only James
 users.all
 # expect both James and Jeremy
-ds2.as_of(valid: 2.days.from_now).all
+ds2.as_of(valid: shift_days(3)).all
 ```
 
-
 ## Status
 
-Very early days :)  
-Currently it's essentially the postgres-adapter with support for a xtdb-scheme url.
+Very early days :)
 
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
-You can also run `bin/console [xtdb-url]` for an interactive prompt that will allow you to experiment. The script will pick up on env-var `XTDB_URL`, though the argument takes precedence.
+You can also run `bin/console [xtdb-url]` for an interactive prompt that will allow you to experiment. The script will pick up on env-var `XTDB_URL`, though the argument takes precedence. The console-script sets up (query-)logging.  
+
+Speaking of logging: best to start the XTDB docker container with debug-logging:
+```
+docker run -it --pull=always -e XTDB_LOGGING_LEVEL=debug -v $PWD/tmp/db:/var/lib/xtdb -p 6543:3000 -p 5432:5432 ghcr.io/xtdb/xtdb:nightly
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/sequel/adapters/shared/xtdb.rb

@@ -1,6 +1,25 @@
+require "sequel/adapters/utils/unmodified_identifiers"
+
 module Sequel
   module XTDB
+    Sequel::Database.set_shared_adapter_scheme :xtdb, self
+
+    def self.mock_adapter_setup(db)
+      db.instance_exec do
+        @server_version = 0
+
+        # def schema_parse_table(*)
+        #  []
+        # end
+        # singleton_class.send(:private, :schema_parse_table)
+        # adapter_initialize
+        # extend(MockAdapterDatabaseMethods)
+      end
+    end
+
     module DatabaseMethods
+      include UnmodifiedIdentifiers::DatabaseMethods # ensure lowercase identifiers
+
       def database_type
         :xtdb
       end
@@ -11,41 +30,19 @@ module Sequel
       end
 
       # Get a dataset with `current`, `valid` and `system` set.
-      #
-      # For selects this creates the SETTING pre-amble, e.g. 'SETTING DEFAULT VALID_TIME ...':
-      # ```
-      # DB.as_of(current: 2.weeks.ago).select(Sequel.lit('current_timestamp')).single_value
-      # ```
-      #
-      # A block can be provided as a convenience to stay in SQL-land (selects only):
-      # ```
-      # DB.as_of(current: 2.hours.ago) do
-      #   DB["select current_timestamp"]
-      # end.sql
-      # =>
-      # SETTING
-      #  CURRENT_TIME TO TIMESTAMP '2024-12-17T12:59:48+01:00'
-      # select current_timestamp
-      # ```
-      #
-      # When doing inserts, the `_valid_from` will be added (if not provided):
-      # ```
-      # DB[:products].as_of(valid: 2.weeks.ago).insert(_id: 1, name: 'Spam')
-      # ```
       def as_of(...)
-        ds = @default_dataset.as_of(...)
-        return ds unless block_given?
-
-        yield.clone(append_sql: ds.select_setting_sql(""))
+        @default_dataset.as_of(...)
       end
     end
 
     module DatasetMethods
+      include UnmodifiedIdentifiers::DatasetMethods # ensure lowercase identifiers
+
       Dataset.def_sql_method(self, :select,
         [["if opts[:values]",
           %w[values compounds order limit]],
           ["else",
-            %w[setting select distinct columns from join where group having compounds order limit lock]]])
+            %w[select distinct columns from join where group having compounds order limit lock]]])
 
       def as_of(valid: nil, system: nil, current: nil)
         {valid: valid, system: system, current: current}.reject { |_k, v| v.nil? }.then do |opts|
@@ -54,6 +51,8 @@ module Sequel
       end
 
       def server_version
+        # TODO 2_000_000 from xt.version() output
+        # requires all def_sql_methods
         0
       end
 
@@ -77,27 +76,49 @@ module Sequel
         super
       end
 
-      def select_setting_sql(sql)
+      def select_sql
+        sql = super
+
+        if (setting = select_setting_sql)
+          if sql.frozen?
+            setting += sql
+            setting.freeze
+          elsif @opts[:append_sql] || @opts[:placeholder_literalizer]
+            setting << sql
+          else
+            setting + sql
+          end
+        else
+          sql
+        end
+      end
+
+      def select_setting_sql
         setting = opts.slice(:current, :valid, :system)
-        return sql if setting.empty?
+        return if setting.empty?
 
         cast_value = ->(v) do
-          case v
-          when DateTime, Time
-            literal_append "TIMESTAMP ", v.iso8601
-          when Date
-            literal_append "DATE ", v.iso8601
+          type = case v
+          when DateTime, Time then "TIMESTAMP"
+          when Date then "DATE"
           end
+          literal_append "#{type} ", v.iso8601
         end
-        sql << "SETTING "
-        sql << setting.map do |k, v|
+        sql = "SETTING "
+        sql.concat(setting.map do |k, v|
           if k == :current
-            literal_append "CURRENT_TIME TO TIMESTAMP ", v.iso8601
+            "CURRENT_TIME TO #{cast_value[v.to_time]}"
           else
             "DEFAULT #{k.upcase}_TIME AS OF #{cast_value[v]}"
           end
-        end.join(", ")
-        sql << " "
+        end.join(", "))
+        sql.concat " "
+      end
+
+      private
+
+      def default_timestamp_format
+        "'%Y-%m-%d %H:%M:%S'"
       end
     end
   end

data/lib/sequel/adapters/xtdb.rb

@@ -32,12 +32,6 @@ module Sequel
 
     class Dataset < Sequel::Postgres::Dataset
       include ::Sequel::XTDB::DatasetMethods
-
-      private
-
-      def default_timestamp_format
-        "'%Y-%m-%d %H:%M:%S'"
-      end
     end
   end
 end

data/lib/sequel/xtdb/version.rb

@@ -3,6 +3,6 @@
 module Sequel
   module XTDB
     # NOTE when releasing the git-tag will replace the version below
-    VERSION = "0.3.0"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-xtdb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Gert Goet
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel