timescaledb 0.1.4 → 0.2.1

data/examples/ranking/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/examples/ranking/config/environments/development.rb

@@ -0,0 +1,60 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end

data/examples/ranking/config/environments/production.rb

@@ -0,0 +1,75 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = "http://assets.example.com"
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
+  # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Include generic and useful information about system operation, but avoid logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII).
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "ranking_production"
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require "syslog/logger"
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name")
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/examples/ranking/config/environments/test.rb

@@ -0,0 +1,53 @@
+require "active_support/core_ext/integer/time"
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Turn false under Spring and add config.action_view.cache_template_loading = true.
+  config.cache_classes = true
+
+  # Eager loading loads your whole application. When running a single test locally,
+  # this probably isn't necessary. It's a good idea to do in a continuous integration
+  # system, or in some way before deploying your code.
+  config.eager_load = ENV["CI"].present?
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory.
+  config.active_storage.service = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+end

data/examples/ranking/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins "example.com"
+#
+#     resource "*",
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/examples/ranking/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be filtered from the log file. Use this to limit dissemination of
+# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
+# notations and behaviors.
+Rails.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]

data/examples/ranking/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/examples/ranking/config/initializers/timescale.rb

@@ -0,0 +1,2 @@
+require 'timescaledb'
+require 'scenic'

data/examples/ranking/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   "true": "foo"
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/examples/ranking/config/puma.rb

@@ -0,0 +1,43 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart

data/examples/ranking/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Defines the root path route ("/")
+  # root "articles#index"
+end

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,6 +1,7 @@
-module Timescale
-  class CompressionSettings < ActiveRecord::Base
+module Timescaledb
+  class CompressionSetting < ActiveRecord::Base
     self.table_name = "timescaledb_information.compression_settings"
     belongs_to :hypertable, foreign_key: :hypertable_name
   end
+  CompressionSettings = CompressionSetting
 end

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

@@ -1,13 +1,13 @@
-module Timescale
-  class ContinuousAggregates < ActiveRecord::Base
+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
       {
@@ -15,4 +15,5 @@ module Timescale
       }
     end
   end
+  ContinuousAggregates = ContinuousAggregate
 end

data/lib/timescaledb/dimensions.rb

@@ -0,0 +1,6 @@
+module Timescaledb
+  class Dimension < ActiveRecord::Base
+    self.table_name = "timescaledb_information.dimensions"
+  end
+  Dimensions = Dimension
+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"
@@ -6,17 +6,17 @@ module Timescale
     has_many :jobs, foreign_key: "hypertable_name"
     has_many :chunks, foreign_key: "hypertable_name"
 
-    has_one :compression_settings,
+    has_many :compression_settings,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::CompressionSettings"
+      class_name: "Timescaledb::CompressionSetting"
 
     has_one :dimensions,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::Dimensions"
+      class_name: "Timescaledb::Dimension"
 
     has_many :continuous_aggregates,
       foreign_key: "hypertable_name",
-      class_name: "Timescale::ContinuousAggregates"
+      class_name: "Timescaledb::ContinuousAggregate"
 
     def chunks_detailed_size
       struct_from "SELECT * from chunks_detailed_size('#{self.hypertable_name}')"

data/lib/timescaledb/job.rb

@@ -0,0 +1,10 @@
+module Timescaledb
+  class Job < ActiveRecord::Base
+    self.table_name = "timescaledb_information.jobs"
+    self.primary_key = "job_id"
+
+    scope :compression, -> { where(proc_name: [:tsbs_compress_chunks, :policy_compression]) }
+    scope :refresh_continuous_aggregate, -> { where(proc_name: :policy_refresh_continuous_aggregate) }
+    scope :scheduled, -> { where(scheduled: true) }
+  end
+end