sequel-xtdb 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b33179262aa907817cbbf65cb0980a19bea740bc3bda9ab569a10fd49544e25
-  data.tar.gz: 25b43d46d3e1f2c9ceb846f6d09590d600a2fea2a9bad02cae930cc457494105
+  metadata.gz: d0f7d61f6d6a7c9ccb319122b964eb284815e959dfc2fa2b529f00195e2b8c91
+  data.tar.gz: 142f6c92856959dff66759cabef3c5cfbbe480eafda22d50ccc62d1e7178ebdb
 SHA512:
-  metadata.gz: 5603a63bd7d20916755c3e4375ed4a5162832925c3615f0ac72459e1f37d46f3bd32a96b686cc1e09075f48c4cc766582750eb6e7b4c8e0961bb8c621c10eaed
-  data.tar.gz: 418b300f8ab58dbeda2b786953911eed8ddece9885132833f0b328e5f551ac79ca81e18751b5ab6668b9ca5e40b483b51ab5237a4630f581f858d5c325c111f6
+  metadata.gz: '0089ee3ce060d52540bac403359f66e334630787f1314a238482a28a8c2c49dd9415655d49c3d653cb8acefd052640d2c337f62b41e30f89ca3edd822625ca36'
+  data.tar.gz: 0f9a8848f64aba9c29424c073add18d6e64f78430add511866ce02b428254b741926ab89787473acfe8c72b9137ae6f61b0a8b1e2640b1fd8c346003faf4b8ba

data/.envrc

@@ -0,0 +1,7 @@
+# env-var using [direnv](https://github.com/direnv/direnv)
+PATH_add bin
+
+export XTDB_URL=xtdb://localhost:5432/xtdb
+
+# put overrides in .envrc.local
+source_env_if_exists .envrc.local

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
 
@@ -24,7 +26,7 @@ Shortcut to happiness:
 $ sequel 'xtdb://localhost:5432/xtdb'
 
 # ..or from repl/your project
-DB = Sequel.connect("xtdb://localhost:54321/xtdb")
+DB = Sequel.connect("xtdb://localhost:5432/xtdb")
 
 # then
 irb(main)> DB << "insert into products(_id, name, price) values(1, 'Spam', 1000), (2, 'Ham', 1200)"
@@ -32,17 +34,47 @@ irb(main)> DB["select * from products"].all
 => [{:_id=>2, :name=>"Ham", :price=>1200}, {:_id=>1, :name=>"Spam", :price=>1100}]
 ```
 
+### time-travel
+
+```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]
+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: shift_days(-1)).all
+
+# add to future
+ds2.insert(_id: 2, name: "Jeremy")
+
+# expect only James
+users.all
+# expect both James and Jeremy
+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,12 +1,125 @@
+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
+
+      def primary_key(_table)
+        # eg used for RETURNING on insert (prevents crash)
+        :_id
+      end
+
+      # Get a dataset with `current`, `valid` and `system` set.
+      def as_of(...)
+        @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[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|
+          clone(opts)
+        end
+      end
+
+      def server_version
+        # TODO 2_000_000 from xt.version() output
+        # requires all def_sql_methods
+        0
+      end
+
+      def insert_values_sql(sql)
+        if (from_ix = opts[:columns].index(:_valid_from))
+          opts[:values][from_ix] = Sequel.lit("TIMESTAMP ?", opts[:values][from_ix])
+        end
+
+        if (to_ix = opts[:columns].index(:_valid_to))
+          opts[:values][to_ix] = Sequel.lit("TIMESTAMP ?", opts[:values][to_ix])
+        end
+
+        super
+      end
+
+      def insert_columns_sql(sql)
+        if opts[:valid] && !opts[:columns].index(:_valid_from)
+          opts[:columns] << :_valid_from
+          opts[:values] << opts[:valid]
+        end
+        super
+      end
+
+      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 if setting.empty?
+
+        cast_value = ->(v) do
+          type = case v
+          when DateTime, Time then "TIMESTAMP"
+          when Date then "DATE"
+          end
+          literal_append "#{type} ", v.iso8601
+        end
+        sql = "SETTING "
+        sql.concat(setting.map do |k, v|
+          if k == :current
+            "CURRENT_TIME TO #{cast_value[v.to_time]}"
+          else
+            "DEFAULT #{k.upcase}_TIME AS OF #{cast_value[v]}"
+          end
+        end.join(", "))
+        sql.concat " "
+      end
+
+      private
+
+      def default_timestamp_format
+        "'%Y-%m-%d %H:%M:%S'"
+      end
     end
   end
 end

data/lib/sequel/adapters/xtdb.rb

@@ -13,6 +13,15 @@ module Sequel
       def adapter_initialize
         # XTDB can't handle this SET-command
         @opts[:force_standard_strings] = false
+
+        Sequel.database_timezone = :utc
+        Sequel.application_timezone = :local
+
+        if (app_tz = @opts[:application_timezone])
+          Sequel.extension(:named_timezones)
+          Sequel.application_timezone = app_tz
+        end
+
         super
       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.2.1"
+    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.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gert Goet
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md