timescaledb 0.1.5 → 0.2.0

data/examples/ranking/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name-<%= Rails.env %>
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/examples/ranking/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/examples/ranking/db/migrate/20220209120747_create_games.rb

@@ -0,0 +1,10 @@
+class CreateGames < ActiveRecord::Migration[7.0]
+  def change
+    create_table :games do |t|
+      t.string :name
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/examples/ranking/db/migrate/20220209120910_create_plays.rb

@@ -0,0 +1,19 @@
+class CreatePlays < ActiveRecord::Migration[7.0]
+  def change
+    enable_extension("timescaledb") unless extensions.include? "timescaledb"
+    hypertable_options = {
+        time_column: 'created_at',
+        chunk_time_interval: '1 day',
+        compress_segmentby: 'game_id',
+        compress_orderby: 'created_at',
+        compression_interval: '7 days'
+    }
+    create_table :plays, hypertable: hypertable_options, id: false do |t|
+      t.references :game, null: false, foreign_key: false
+      t.integer :score
+      t.decimal :total_time
+
+      t.timestamps
+    end
+  end
+end

data/examples/ranking/db/migrate/20220209143347_create_score_per_hours.rb

@@ -0,0 +1,5 @@
+class CreateScorePerHours < ActiveRecord::Migration[7.0]
+  def change
+    create_scenic_continuous_aggregate :score_per_hours
+  end
+end

data/examples/ranking/db/schema.rb

@@ -0,0 +1,47 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2022_02_09_143347) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+  enable_extension "timescaledb"
+
+  create_table "games", force: :cascade do |t|
+    t.string "name"
+    t.string "description"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "plays", id: false, force: :cascade do |t|
+    t.bigint "game_id", null: false
+    t.integer "score"
+    t.decimal "total_time"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["created_at"], name: "plays_created_at_idx", order: :desc
+    t.index ["game_id"], name: "index_plays_on_game_id"
+  end
+
+  create_hypertable "plays", time_column: "created_at", chunk_time_interval: "1 minute", compress_segmentby: "game_id", compress_orderby: "created_at ASC", compression_interval: "P7D"
+
+  create_continuous_aggregate("score_per_hours", <<-SQL)
+    SELECT plays.game_id,
+      time_bucket('PT1H'::interval, plays.created_at) AS bucket,
+      avg(plays.score) AS avg,
+      max(plays.score) AS max,
+      min(plays.score) AS min
+     FROM plays
+    GROUP BY plays.game_id, (time_bucket('PT1H'::interval, plays.created_at))
+  SQL
+
+end

data/examples/ranking/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }])
+#   Character.create(name: "Luke", movie: movies.first)

data/examples/ranking/db/views/score_per_hours_v01.sql

@@ -0,0 +1,7 @@
+SELECT game_id,
+       time_bucket(INTERVAL '1 hour', created_at) AS bucket,
+       AVG(score),
+       MAX(score),
+       MIN(score)
+FROM plays
+GROUP BY game_id, bucket;

data/examples/ranking/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/lib/{timescale → timescaledb}/acts_as_hypertable/core.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Timescale
+module Timescaledb
   module ActsAsHypertable
     module Core
       def self.included(base)

data/lib/{timescale → timescaledb}/acts_as_hypertable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Timescale
+module Timescaledb
   # If you want your model to hook into its underlying hypertable
   # as well as have access to TimescaleDB specific data, methods, and more,
   # specify this macro in your model.
@@ -10,7 +10,7 @@ module Timescale
   #
   # @see https://docs.timescale.com/api/latest/hypertable/create_hypertable/ for
   #   how to use the SQL `create_hypertable` function.
-  # @see Timescale::MigrationHelpers#create_table for how to create a new hypertable
+  # @see Timescaledb::MigrationHelpers#create_table for how to create a new hypertable
   # via a Rails migration utilizing the standard `create_table` method.
   #
   # @example Enabling the macro on your model
@@ -18,7 +18,7 @@ module Timescale
   #     acts_as_hypertable
   #   end
   #
-  # @see Timescale::ActsAsHypertable#acts_as_hypertable
+  # @see Timescaledb::ActsAsHypertable#acts_as_hypertable
   #   for configuration options
   module ActsAsHypertable
     DEFAULT_OPTIONS = {
@@ -26,7 +26,7 @@ module Timescale
     }.freeze
 
     def acts_as_hypertable?
-      included_modules.include?(Timescale::ActsAsHypertable::Core)
+      included_modules.include?(Timescaledb::ActsAsHypertable::Core)
     end
 
     # == Configuration options
@@ -45,7 +45,7 @@ module Timescale
     def acts_as_hypertable(options = {})
       return if acts_as_hypertable?
 
-      include Timescale::ActsAsHypertable::Core
+      include Timescaledb::ActsAsHypertable::Core
 
       class_attribute :hypertable_options, instance_writer: false
 
@@ -59,4 +59,4 @@ module Timescale
   end
 end
 
-ActiveRecord::Base.extend Timescale::ActsAsHypertable
+ActiveRecord::Base.extend Timescaledb::ActsAsHypertable

data/lib/{timescale → timescaledb}/chunk.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class Chunk < ActiveRecord::Base
     self.table_name = "timescaledb_information.chunks"
     self.primary_key = "chunk_name"

data/lib/{timescale → timescaledb}/compression_settings.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class CompressionSetting < ActiveRecord::Base
     self.table_name = "timescaledb_information.compression_settings"
     belongs_to :hypertable, foreign_key: :hypertable_name

data/lib/{timescale → timescaledb}/continuous_aggregates.rb

@@ -1,13 +1,13 @@
-module Timescale
+module Timescaledb
   class ContinuousAggregate < ActiveRecord::Base
     self.table_name = "timescaledb_information.continuous_aggregates"
     self.primary_key = 'materialization_hypertable_name'
 
     has_many :jobs, foreign_key: "hypertable_name",
-      class_name: "Timescale::Job"
+      class_name: "Timescaledb::Job"
 
     has_many :chunks, foreign_key: "hypertable_name",
-      class_name: "Timescale::Chunk"
+      class_name: "Timescaledb::Chunk"
 
     scope :resume, -> do
       {

data/lib/{timescale → timescaledb}/dimensions.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class Dimension < ActiveRecord::Base
     self.table_name = "timescaledb_information.dimensions"
   end

data/lib/{timescale → timescaledb}/hypertable.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class Hypertable < ActiveRecord::Base
     self.table_name = "timescaledb_information.hypertables"
     self.primary_key = "hypertable_name"
@@ -8,15 +8,15 @@ module Timescale
 
     has_many :compression_settings,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::CompressionSetting"
+      class_name: "Timescaledb::CompressionSetting"
 
     has_one :dimensions,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::Dimension"
+      class_name: "Timescaledb::Dimension"
 
     has_many :continuous_aggregates,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::ContinuousAggregate"
+      class_name: "Timescaledb::ContinuousAggregate"
 
     def chunks_detailed_size
       struct_from "SELECT * from chunks_detailed_size('#{self.hypertable_name}')"

data/lib/{timescale → timescaledb}/job.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class Job < ActiveRecord::Base
     self.table_name = "timescaledb_information.jobs"
     self.primary_key = "job_id"

data/lib/{timescale → timescaledb}/job_stats.rb

@@ -1,4 +1,4 @@
-module Timescale
+module Timescaledb
   class JobStat < ActiveRecord::Base
     self.table_name = "timescaledb_information.job_stats"
 

data/lib/{timescale → timescaledb}/migration_helpers.rb

@@ -1,7 +1,7 @@
 require 'active_record/connection_adapters/postgresql_adapter'
 
 # Useful methods to run TimescaleDB in you Ruby app.
-module Timescale
+module Timescaledb
   # Migration helpers can help you to setup hypertables by default.
   module MigrationHelpers
     # create_table can receive `hypertable` argument
@@ -102,4 +102,4 @@ module Timescale
   end
 end
 
-ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(Timescale::MigrationHelpers)
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(Timescaledb::MigrationHelpers)

data/lib/{timescale → timescaledb}/scenic/adapter.rb

@@ -1,7 +1,7 @@
 require 'scenic/adapters/postgres'
 require 'scenic/adapters/postgres/views'
 
-module Timescale
+module Timescaledb
   module Scenic
     class Views < ::Scenic::Adapters::Postgres::Views
       # All of the views that this connection has defined, excluding any
@@ -45,7 +45,7 @@ module Timescale
       # definition, since it's not part of the DDL).
       #
       # Our schema dumper implementation will handle dumping the continuous
-      # aggregate definintions, but we need to override Scenic's schema dumping
+      # aggregate definitions, but we need to override Scenic's schema dumping
       # to exclude those continuous aggregates.
       def views
         Views.new(connection).all

data/lib/timescaledb/scenic/extension.rb

@@ -0,0 +1,72 @@
+# Scenic does not include `WITH` option that is used with continuous aggregates.
+module Timescaledb
+  module Scenic
+    module Extension
+      # @override Scenic::Adapters::Postgres#create_materialized_view
+      # Creates a materialized view in the database
+      #
+      # @param name The name of the materialized view to create
+      # @param sql_definition The SQL schema that defines the materialized view.
+      # @param with [String] Default: nil. Set with: "..." to add "WITH (...)".
+      # @param no_data [Boolean] Default: false. Set to true to not create data.
+      #   materialized view without running the associated query. You will need
+      #   to perform a non-concurrent refresh to populate with data.
+      #
+      # This is typically called in a migration via {Statements#create_view}.
+      # @return [void]
+      def create_materialized_view(name, sql_definition, with: nil, no_data: false)
+        execute <<-SQL
+  CREATE MATERIALIZED VIEW #{quote_table_name(name)}
+  #{"WITH (#{with})" if with} AS
+  #{sql_definition.rstrip.chomp(';')}
+  #{'WITH NO DATA' if no_data};
+        SQL
+      end
+
+      # @override Scenic::Adapters::Postgres#create_view
+      # to add the `with: ` keyword that can be used for such option.
+      #
+      def create_view(name, version: nil, with: nil, sql_definition: nil, materialized: false, no_data: false)
+        if version.present? && sql_definition.present?
+          raise(
+            ArgumentError,
+            "sql_definition and version cannot both be set",
+          )
+        end
+
+        if version.blank? && sql_definition.blank?
+          version = 1
+        end
+
+        sql_definition ||= definition(name, version)
+
+        if materialized
+          ::Scenic.database.create_materialized_view(
+            name,
+            sql_definition,
+            no_data: no_data,
+            with: with
+          )
+        else
+          ::Scenic.database.create_view(name, sql_definition, with: with)
+        end
+      end
+
+      private
+
+      def definition(name, version)
+        ::Scenic::Definition.new(name, version).to_sql
+      end
+    end
+    module MigrationHelpers
+      # Create a timescale continuous aggregate view
+      def create_scenic_continuous_aggregate(name)
+        ::Scenic.database.create_view(name, materialized: true, no_data: true, with: "timescaledb.continuous")
+      end
+    end
+  end
+end
+
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Timescaledb::Scenic::MigrationHelpers)
+Scenic::Adapters::Postgres.prepend(Timescaledb::Scenic::Extension)

data/lib/{timescale → timescaledb}/schema_dumper.rb

@@ -1,7 +1,7 @@
 require 'active_record/connection_adapters/postgresql_adapter'
 require 'active_support/core_ext/string/indent'
 
-module Timescale
+module Timescaledb
   module SchemaDumper
     def tables(stream)
       super # This will call #table for each table in the database
@@ -10,7 +10,7 @@ module Timescale
 
     def table(table_name, stream)
       super(table_name, stream)
-      if hypertable = Timescale::Hypertable.find_by(hypertable_name: table_name)
+      if hypertable = Timescaledb::Hypertable.find_by(hypertable_name: table_name)
         timescale_hypertable(hypertable, stream)
         timescale_retention_policy(hypertable, stream)
       end
@@ -58,7 +58,7 @@ module Timescale
     end
 
     def timescale_continuous_aggregates(stream)
-      Timescale::ContinuousAggregates.all.each do |aggregate|
+      Timescaledb::ContinuousAggregates.all.each do |aggregate|
         opts = if (refresh_policy = aggregate.jobs.refresh_continuous_aggregate.first)
                  interval = timescale_interval(refresh_policy.schedule_interval)
                  end_offset = timescale_interval(refresh_policy.config["end_offset"])
@@ -85,4 +85,4 @@ module Timescale
   end
 end
 
-ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(Timescale::SchemaDumper)
+ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(Timescaledb::SchemaDumper)

data/lib/{timescale → timescaledb}/stats_report.rb

@@ -1,6 +1,6 @@
 require "active_support/core_ext/numeric/conversions"
 
-module Timescale
+module Timescaledb
   module StatsReport
     module_function
     def resume(scope=Hypertable.all)
@@ -19,7 +19,7 @@ module Timescale
     end
 
     def compression_resume(scope)
-      sum = -> (method) { (scope.map(&method).inject(:+) || 0).to_s(:human_size)}
+      sum = -> (method) { (scope.map(&method).inject(:+) || 0).to_formatted_s(:human_size)}
       {
         uncompressed: sum[:before_total_bytes],
         compressed: sum[:after_total_bytes]

data/lib/timescaledb/version.rb

@@ -0,0 +1,3 @@
+module Timescaledb
+  VERSION = '0.2.0'
+end

data/lib/timescaledb.rb

@@ -0,0 +1,64 @@
+require 'active_record'
+
+require_relative 'timescaledb/acts_as_hypertable'
+require_relative 'timescaledb/acts_as_hypertable/core'
+require_relative 'timescaledb/chunk'
+require_relative 'timescaledb/compression_settings'
+require_relative 'timescaledb/continuous_aggregates'
+require_relative 'timescaledb/dimensions'
+require_relative 'timescaledb/hypertable'
+require_relative 'timescaledb/job'
+require_relative 'timescaledb/job_stats'
+require_relative 'timescaledb/schema_dumper'
+require_relative 'timescaledb/stats_report'
+require_relative 'timescaledb/migration_helpers'
+require_relative 'timescaledb/version'
+
+module Timescaledb
+  module_function
+
+  def chunks
+    Chunk.all
+  end
+
+  def hypertables
+    Hypertable.all
+  end
+
+  def continuous_aggregates
+    ContinuousAggregates.all
+  end
+
+  def compression_settings
+    CompressionSettings.all
+  end
+
+  def jobs
+    Job.all
+  end
+
+  def job_stats
+    JobStats.all
+  end
+
+  def stats(scope=Hypertable.all)
+    StatsReport.resume(scope)
+  end
+
+  def default_hypertable_options
+    Timescaledb::ActsAsHypertable::DEFAULT_OPTIONS
+  end
+end
+
+begin
+  require 'scenic'
+  require_relative 'timescaledb/scenic/adapter'
+  require_relative 'timescaledb/scenic/extension'
+
+  Scenic.configure do |config|
+    config.database = Timescaledb::Scenic::Adapter.new
+  end
+
+rescue LoadError
+  # This is expected when the scenic gem is not being used
+end

data/{timescale.gemspec → timescaledb.gemspec}

@@ -1,14 +1,14 @@
-require_relative 'lib/timescale/version'
+require_relative 'lib/timescaledb/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "timescaledb"
-  spec.version       = Timescale::VERSION
+  spec.version       = Timescaledb::VERSION
   spec.authors       = ["Jônatas Davi Paganini"]
   spec.email         = ["jonatasdp@gmail.com"]
 
   spec.summary       = %q{TimescaleDB helpers for Ruby ecosystem.}
   spec.description   = %q{Functions from timescaledb available in the ActiveRecord models.}
-  spec.homepage      = "https://github.com/jonatas/timescale"
+  spec.homepage      = "https://github.com/jonatas/timescaledb"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")