sequel-xtdb 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588ca986b6f08698e828e9b82ca407efe7ed9cb53bcf88e4bb7d5a3079c543bb
-  data.tar.gz: 6f40888887ed889acf0bb4fe0b71aae53e566453668dcea3c983fc5fddfdb11c
+  metadata.gz: feef2fdeeefa8b1adfd9d214aab772c02250814aa8e6ef36a79bc7eddc4a8386
+  data.tar.gz: 417e16888185230ad9f7714b7d0d322594457f6f0d8645c033a9203463103293
 SHA512:
-  metadata.gz: de181ba238344b2eb73143653a63ecd67d53a1920f5016f88b505ec4bc0ad9c8f8461e7bc15dc66f19ac53fe01e840db470a8e7128e48fd33d491b93e73210d2
-  data.tar.gz: a4dab5cb1ca1ee2e760580df3d12efa101e176dcf0bf5c03f0fc7bab6bedef08f557a6175eaffc5080e0c8b7c6b75e01b78d406aef6c9b9bc65c7095f6cb1b65
+  metadata.gz: 28456e08dfc22572d63a5de8dbfba0b8f849a78478f1ec43336e2495212a4217bacf665d53faf7f205d54c75ef8df931064288dd079bf496dd85389bcb3d1911
+  data.tar.gz: cb4e306b7641e07812e146843d982104e143935c83d58ffc7cd480246f1dec99fc0f5946fa2ebd964eed4c50e338051785fa772119fe497d156cf88e82e2925c

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

@@ -24,7 +24,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,6 +32,35 @@ irb(main)> DB["select * from products"].all
 => [{:_id=>2, :name=>"Ham", :price=>1200}, {:_id=>1, :name=>"Spam", :price=>1100}]
 ```
 
+### time-travel
+
+_these examples use the [activesupport time helpers](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html)_
+
+```ruby
+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)
+
+# expect empty
+ds1.all
+ds1.insert(_id: 1, name: "James")
+
+# expect a user
+ds1.as_of(valid: 2.days.ago).all
+
+# add to future
+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
+```
+
+
 ## Status
 
 Very early days :)  
@@ -40,7 +69,9 @@ Currently it's essentially the postgres-adapter with support for a xtdb-scheme u
 
 ## 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` for an interactive prompt that will allow you to experiment.
+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.
 
 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,9 +1,104 @@
 module Sequel
   module XTDB
     module DatabaseMethods
+      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.
+      #
+      # 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(""))
+      end
     end
 
     module DatasetMethods
+      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]]])
+
+      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
+        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_setting_sql(sql)
+        setting = opts.slice(:current, :valid, :system)
+        return sql if setting.empty?
+
+        cast_value = ->(v) do
+          case v
+          when DateTime, Time
+            literal_append "TIMESTAMP ", v.iso8601
+          when Date
+            literal_append "DATE ", v.iso8601
+          end
+        end
+        sql << "SETTING "
+        sql << setting.map do |k, v|
+          if k == :current
+            literal_append "CURRENT_TIME TO TIMESTAMP ", v.iso8601
+          else
+            "DEFAULT #{k.upcase}_TIME AS OF #{cast_value[v]}"
+          end
+        end.join(", ")
+        sql << " "
+      end
     end
   end
 end

data/lib/sequel/adapters/xtdb.rb

@@ -1,4 +1,4 @@
-require_relative 'shared/xtdb'
+require_relative "shared/xtdb"
 require "sequel/adapters/postgres"
 
 module Sequel
@@ -13,12 +13,31 @@ 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
+
+      def dataset_class_default
+        Dataset
+      end
     end
 
     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

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

data/rakelib/gem.rake

@@ -0,0 +1,23 @@
+namespace :gem do
+  task "write_version", [:version] do |_task, args|
+    if args[:version]
+      version = args[:version].split("=").last
+      version_file = File.expand_path("../../lib/sequel/xtdb/version.rb", __FILE__)
+
+      system(<<~CMD, exception: true)
+        ruby -pi -e 'gsub(/VERSION = ".*"/, %{VERSION = "#{version}"})' #{version_file}
+      CMD
+      Bundler.ui.confirm "Version #{version} written to #{version_file}."
+    else
+      Bundler.ui.warn "No version provided, keeping version.rb as is."
+    end
+  end
+
+  desc "Build [version]"
+  task "build", [:version] => ["write_version", "build"] do
+  end
+
+  desc "Build and push [version] to rubygems"
+  task "release", [:version] => ["gem:build", "release:rubygem_push"] do
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-xtdb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-17 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
@@ -55,6 +56,7 @@ files:
 - lib/sequel/adapters/xtdb.rb
 - lib/sequel/xtdb.rb
 - lib/sequel/xtdb/version.rb
+- rakelib/gem.rake
 - sig/sequel/xtdb.rbs
 homepage: https://github.com/eval/sequel-xtdb
 licenses:
@@ -78,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Adapter to connect to XTDB v2 using Sequel.