activerecord-timescaledb-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3aa5071de7bc34242ec33c7cedc277ca71a45752978b8facf0da5d930b92a858
+  data.tar.gz: c1b2ac532da6fe80ea97358849dfe5fae6329290e9f75d777334e638114b3009
+SHA512:
+  metadata.gz: 28fd541927483c1c36ba4dbbda4e56da8798806bd41458bf3af306d74552bb419a0f2049a4e4b38023262db8cec62a2edd359d1368b70c19fb69eccc5a97eb9a
+  data.tar.gz: aab45a7bf415ee81230a2aa4bd5c84569be4dd6219ff48fab5ea4b94f39dbb9f83d1c799936617ce7cdad924a83b41c06784ca2d09ddec73940fd7ce2555291f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-timescaledb-adapter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    activerecord-timescaledb-adapter (0.1.0)
+      activerecord (~> 6.0.0)
+      activesupport (~> 6.0.0)
+      pg (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.6)
+      activesupport (= 6.0.6)
+    activerecord (6.0.6)
+      activemodel (= 6.0.6)
+      activesupport (= 6.0.6)
+    activerecord-nulldb-adapter (0.8.0)
+      activerecord (>= 5.2.0, < 7.1)
+    activesupport (6.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pg (1.4.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.18.1)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  activerecord-nulldb-adapter
+  activerecord-timescaledb-adapter!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Evan Duncan
+
+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,37 @@
+# ActiveRecord TimescaleDB Adapter
+
+The activerecord-timescaledb-adapter provides access to features of the [Timescale](https://www.timescale.com/) Postgres extension from ActiveRecord. 
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activerecord-timescaledb-adapter
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activerecord-timescaledb-adapter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Roadmap
+
+- [] [Hypertable](https://docs.timescale.com/api/latest/hypertable/) ActiveRecord::Migration methods
+- [] [Distributed Hypertable](https://docs.timescale.com/api/latest/distributed-hypertables/) ActiveRecord::Migration methods
+- [] [Hyperfunction](https://docs.timescale.com/api/latest/hyperfunctions/)s on ActiveRecord models
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/grnhse/activerecord-timescaledb-adapter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/active_record/connection_adapters/timescaledb/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module TimescaleDB
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/active_record/connection_adapters/timescaledb_adapter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
+require "active_record/connection_adapters/timescaledb/version"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class TimescaleDBAdapter < PostgreSQLAdapter
+      ADAPTER_NAME = "TimescaleDB"
+    end
+  end
+end

data/lib/active_record/timescale/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Timescale
+    class Base < ActiveRecord::Base
+      # The first aggregate allows you to get the value of one column as ordered by another.
+      # For example, first(temperature, time) returns the earliest temperature
+      # value based on time within an aggregate group.
+      #
+      # The last aggregate allows you to get the value of one column as ordered by another.
+      # For example, last(temperature, time) returns the latest temperature
+      # value based on time within an aggregate group.
+      %i[first last].each do |method|
+        scope method, lambda do |value, time|
+          select(sanitize_sql(["#{method}(?, ?)", value, time]))
+        end
+      end
+
+      # @param value [*] A set of values to partition into a histogram
+      # @param min [Integer] The histogram's lower bound used in bucketing (inclusive)
+      # @param max [Integer] The histogram's upper bound used in bucketing (exclusive)
+      # @param nbuckets [Integer] The integer value for the number of histogram buckets (partitions)
+      scope :histogram, lambda do |value, min, max, nbuckets|
+        select(sanitize_sql(["histogram(?, ?, ?, ?)", value, min, max, nbuckets]))
+      end
+
+      class << self
+        # Get approximate row count for hypertable, distributed hypertable, or regular
+        # PostgreSQL table based on catalog estimates. This function supports tables
+        # with nested inheritance and declarative partitioning.
+        #
+        # The accuracy of approximate_row_count depends on the database having up-to-date statistics about
+        # the table or hypertable, which are updated by VACUUM, ANALYZE, and a few DDL commands.
+        # If you have auto-vacuum configured on your table or hypertable, or changes to the
+        # table are relatively infrequent, you might not need to explicitly ANALYZE your table as shown below.
+        # Otherwise, if your table statistics are too out-of-date, running this command updates
+        # your statistics and yields more accurate approximation results.
+        def approximate_row_count
+          execute sanitize_sql(["SELECT * FROM approximate_row_count(?)", quote_table_name(table_name)])
+        end
+      end
+    end
+  end
+end

data/lib/active_record/timescale/schema_migration.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/concern"
+
+module ActiveRecord
+  module Timescale
+    module SchemaMigration
+      extend ActiveSupport::Concern
+
+      # Create a Hypertable from a postgres table
+      # An existing table can be used or, if given a block, a new table will be created.
+      #
+      # Examples:
+      #
+      # create_hyper_table :check_ins, time_column_name: 'checked_in_at', id: false do |t|
+      #   t.references :user
+      #   t.datetime :checked_in_at, null: false, index: true
+      #   t.timestamps
+      # end
+      #
+      # # check_ins table already exists
+      # create_hyper_table :check_ins, time_column_name: 'checked_in_at', migrate_data: true
+      #
+      # # Simplest example
+      # create_hyper_table :check_ins
+      #
+      # @param relation [String] Identifier of table to convert to hypertable.
+      # @param options.time_column_name [String] Name of the column containing time values as well as the primary column to partition by.
+      # @param options.partitioning_column [String, nil] Name of an additional column to partition by.
+      # @param options.number_partitions [Integer, nil] Number of hash partitions to use for partitioning_column. Must be > 0. Default is the number of data_nodes.
+      # @param options.chunk_time_interval [String, Integer, nil] Interval in event time that each chunk covers. Must be > 0. Default is 7 days.
+      # @param options.create_default_indexes [Boolean, nil] Boolean whether to create default indexes on time/partitioning columns. Default is TRUE.
+      # @param options.if_not_exists [Boolean, nil] Boolean whether to print warning if table already converted to hypertable or raise exception. Default is FALSE.
+      # @param options.partitioning_func [String, nil] The function to use for calculating a value's partition.
+      # @param options.associated_schema_name [String, nil] Name of the schema for internal hypertable tables. Default is _timescaledb_internal.
+      # @param options.associated_table_prefix [String, nil] Prefix for internal hypertable chunk names. Default is _hyper.
+      # @param options.migrate_data [Boolean, nil] Set to TRUE to migrate any existing data from the relation table to chunks in the new hypertable. A non-empty table generates an error without this option. Large tables may take significant time to migrate. Default is FALSE.
+      # @param options.time_partitioning_func [String, nil] Function to convert incompatible primary time column values to compatible ones. The function must be IMMUTABLE.
+      # @param options.replicator_factor [Integer, nil] The number of data nodes to which the same data is written to. This is done by creating chunk copies on this amount of data nodes. Must be >= 1; If not set, the default value is determined by the timescaledb.hypertable_replication_factor_default GUC.
+      # @param options.data_nodes [Array<String>, nil] The set of data nodes used for the distributed hypertable. If not present, defaults to all data nodes known by the access node (the node on which the distributed hypertable is created).
+      # @param options.distributed [Boolean, nil] Set to TRUE to create distributed hypertable. If not provided, value is determined by the timescaledb.hypertable_distributed_default GUC. When creating a distributed hypertable, consider using create_distributed_hypertable in place of create_hypertable. Default is NULL.
+      def create_hyper_table(relation, time_column_name: "created_at", **options, &block)
+        hyper_table_options = HyperTableOptions.new(**options)
+        create_table(relation, **hyper_table_options.args, &block) unless block.nil?
+        execute "SELECT create_hyper_table(#{quote_table_name(relation)}, #{quote_column_name(time_column_name)}, #{hyper_table_options.to_sql})"
+      end
+
+      # See create_hyper_table for examples. Works exactly the same but the distributed option is forced to TRUE
+      def create_distributed_hyper_table(relation, **options, &block)
+        create_hyper_table(relation, **options.merge({distributed: true}), &block)
+      end
+
+      # @param relation [String] Name of the hypertable or continuous aggregate to create the policy for.
+      # @param drop_after [String, Integer] Chunks fully older than this interval when the policy is run are dropped
+      # @param if_not_exists [Boolean, nil] Set to true to avoid throwing an error if the drop_chunks_policy already exists. A notice is issued instead. Defaults to false.
+      def add_retention_policy(relation, drop_after:, if_not_exists: false)
+        drop_after_string =
+          if drop_after.is_a? String
+            "INTERVAL '#{drop_after}'"
+          else
+            "BIGINT '#{drop_after}'"
+          end
+
+        args = []
+        args << quote_table_name(relation)
+        args << drop_after_string
+        args << "if_not_exists => TRUE" if if_not_exists
+
+        execute "SELECT add_retention_policy(#{args.join(", ")})"
+      end
+
+      class HyperTableOptions
+        def initialize(
+          partitioning_column: nil,
+          number_partitions: nil,
+          chunk_time_interval: "7 days",
+          create_default_indexes: true,
+          if_not_exists: false,
+          partitioning_func: nil,
+          associated_schema_name: "_timescaledb_internal",
+          associated_table_prefix: "_hyper",
+          migrate_data: false,
+          time_partitioning_func: nil,
+          replicator_factor: nil,
+          data_nodes: [],
+          distributed: nil,
+          **other_args
+        )
+
+          @partitioning_column = partitioning_column
+          @number_partitions = number_partitions
+          @chunk_time_interval = chunk_time_interval
+          @create_default_indexes = create_default_indexes
+          @if_not_exists = if_not_exists
+          @partitioning_func = partitioning_func
+          @associated_schema_name = associated_schema_name
+          @associated_table_prefix = associated_table_prefix
+          @migrate_data = migrate_data
+          @time_partitioning_func = time_partitioning_func
+          @replicator_factor = replicator_factor
+          @data_nodes = data_nodes
+          @distributed = distributed
+          @other_args = other_args
+        end
+
+        def args
+          @other_args.merge(
+            {
+              partitioning_column: @partitioning_column,
+              number_partitions: @number_partitions,
+              chunk_time_interval: @chunk_time_interval,
+              create_default_indexes: @create_default_indexes,
+              if_not_exists: @if_not_exists,
+              partitioning_func: @partitioning_func,
+              associated_schema_name: @associated_schema_name,
+              associated_table_prefix: @associated_table_prefix,
+              migrate_data: @migrate_data,
+              time_partitioning_func: @time_partitioning_func,
+              replicator_factor: @replicator_factor,
+              data_nodes: @data_nodes,
+              distributed: @distributed
+            }
+          )
+        end
+
+        def to_sql
+          sql = []
+          sql << "partitioning_column => '#{@partioning_column}'" unless @partitioning_column.nil?
+          sql << "number_partitions => #{@number_partitions}" unless @number_partitions.nil?
+          sql << "if_not_exists => #{@if_not_exists}"
+          sql << "partitioning_func => '#{@partitioning_func}'" unless @partitioning_func.nil?
+          sql << "associated_schema_name => '#{@associated_schema_name}'"
+          sql << "associated_table_prefix => '#{@associated_table_prefix}'"
+          sql << "migrate_data => #{@migrate_data}"
+          sql << "time_partitioning_func => '#{@time_partitioning_func}'" unless @time_partitioning_func.nil?
+          sql << "replicator_factor => #{@replicator_factor}" unless @replicator_factor.nil?
+          sql << "data_nodes => '{ #{@data_nodes.join(", ")} }'" if @data_nodes.any?
+          sql << "disstributed => #{@distributed}" unless @distributed.nil?
+          sql <<
+            if @chunk_time_interval.is_a? String
+              "chunk_time_interval => INTERVAL '#{@chunk_time_interval}'"
+            else
+              "chunk_time_interval => #{@chunk_time_interval}"
+            end
+
+          sql.join(", ")
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Migration.send(:include, ActiveRecord::Timescale::SchemaMigration)

data/lib/activerecord-timescaledb-adapter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/timescaledb_adapter"

data/sig/activerecord/timescaledb/adapter.rbs

@@ -0,0 +1,8 @@
+module Activerecord
+  module Timescaledb
+    module Adapter
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-timescaledb-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evan Duncan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The activerecord-timescaledb-adapter provides access to features of the
+  Timescale Postgres extension from ActiveRecord.
+email:
+- evan.duncan@greenhouse.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record/connection_adapters/timescaledb/version.rb
+- lib/active_record/connection_adapters/timescaledb_adapter.rb
+- lib/active_record/timescale/base.rb
+- lib/active_record/timescale/schema_migration.rb
+- lib/activerecord-timescaledb-adapter.rb
+- sig/activerecord/timescaledb/adapter.rbs
+homepage: https://github.com/grnhse/activerecord-timescaledb-adapter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/grnhse/activerecord-timescaledb-adapter
+  source_code_uri: https://github.com/grnhse/activerecord-timescaledb-adapter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A TimescaleDB adapter
+test_files: []