timescaledb 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64be262fa0fbecf13ec6b6b8820b471c9d83e6842306efc59b950a693d4755b
-  data.tar.gz: d702011692906410bd38107d16f9f20801977deb8f4a0cc3372dc5f61aed29ae
+  metadata.gz: d1fef5df000abb1cc12f56397a1e18f452bf35c061260cf403809db25954451a
+  data.tar.gz: d00d7d94a33b52475a6e5415e7bab669be079f62b165abdb666764a907e34dc6
 SHA512:
-  metadata.gz: bc45bab9ddc1e32c1630bb4258299ee1a74b5b7991eb9281332d7de77161e4ad76cedb0cc2ddb30dbf609b68607a2cf0d7799c11130348bda94974fd46d152c1
-  data.tar.gz: 4b6e7da46622c902fc1960fcba1b4d41b4674a8490eef2025f835b767efd3838573befffaed7fffceb65de5e65c793453d3eacfc681a1846f13ba2b485897ce6
+  metadata.gz: 1b814e74e3403c5a0e12ed8d3e115aff9a44e67cf0eff46a94b396e5511c0ce7a316808b1cc563890e27892383e1d0c3358c97abb8f9f49577bc5c8b01fc3fe6
+  data.tar.gz: ac250f31153249745e7db4ce3b7d7bbacaa25934dd7915a5a4b2aaf02595b5332344b890d1ee7a759b193f75c554bf101b7e0c492104f539edf7fa094fba133e

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/.travis.yml

@@ -4,3 +4,6 @@ cache: bundler
 rvm:
   - 2.7.1
 before_install: gem install bundler -v 2.1.4
+gemfile:
+  - Gemfile
+  - Gemfile.scenic

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in timescale.gemspec
 gemspec
+
+# gemika must be listed in the Gemfile rather than as a development dependency in the gemspec.
+# It throws an error, otherwise.
+gem "gemika"

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    timescaledb (0.1.4)
+    timescaledb (0.2.1)
       activerecord
+      activesupport
       pg (~> 1.2)
 
 GEM
@@ -27,11 +28,12 @@ GEM
     database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
+    gemika (0.6.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.4)
-    pg (1.2.3)
+    pg (1.3.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -62,6 +64,7 @@ PLATFORMS
 DEPENDENCIES
   database_cleaner-active_record
   dotenv
+  gemika
   pry
   rake (~> 12.0)
   rspec (~> 3.0)
@@ -69,4 +72,4 @@ DEPENDENCIES
   timescaledb!
 
 BUNDLED WITH
-   2.1.4
+   2.2.31

data/Gemfile.scenic

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in timescale.gemspec
+gemspec
+
+gem "scenic"
+gem "gemika"

data/Gemfile.scenic.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    timescaledb (0.1.5)
+      activerecord
+      activesupport
+      pg (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    erubi (1.10.0)
+    gemika (0.6.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    pg (1.3.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    scenic (1.5.4)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  database_cleaner-active_record
+  dotenv
+  gemika
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-its
+  scenic
+  timescaledb!
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -1,6 +1,6 @@
-# Timescale
+# TimescaleDB
 
-Welcome to the Timescale gem! To experiment with the code, start installing the
+Welcome to the TimescaleDB gem! To experiment with the code, start installing the
 gem:
 
 ```bash
@@ -29,7 +29,7 @@ tsdb postgres://<user>@localhost:5432/<dbname> --stats
 Or just check the stats:
 
 ```bash
-tsdb "postgres://jonatasdp@localhost:5432/timescale_test" --stats
+tsdb "postgres://jonatasdp@localhost:5432/timescaledb_test" --stats
 ```
 
 These is a sample output from database example with almost no data:
@@ -89,7 +89,7 @@ continuous aggregates views.
 
 ```ruby
 Tick
-=> Timescale::Tick(time: datetime, symbol: string, price: decimal, volume: integer)
+=> Timescaledb::Tick(time: datetime, symbol: string, price: decimal, volume: integer)
 ```
 
 Note that it's only created for this session and will never be cached in the
@@ -102,7 +102,7 @@ Let's start with the `.hypertable` method.
 
 ```ruby
 Tick.hypertable
-=> #<Timescale::Hypertable:0x00007fe99c258900
+=> #<Timescaledb::Hypertable:0x00007fe99c258900
  hypertable_schema: "public",
  hypertable_name: "ticks",
  owner: "jonatasdp",
@@ -122,7 +122,7 @@ from the hypertable relation.
 ```ruby
 Tick.hypertable.chunks
 unknown OID 2206: failed to recognize type of 'primary_dimension_type'. It will be treated as String.
-=> [#<Timescale::Chunk:0x00007fe99c31b068
+=> [#<Timescaledb::Chunk:0x00007fe99c31b068
   hypertable_schema: "public",
   hypertable_name: "ticks",
   chunk_schema: "_timescaledb_internal",
@@ -175,14 +175,14 @@ The `ohlc_1m` view is also available as an ActiveRecord:
 
 ```ruby
 Ohlc1m
-=> Timescale::Ohlc1m(bucket: datetime, symbol: string, open: decimal, high: decimal, low: decimal, close: decimal, volume: integer)
+=> Timescaledb::Ohlc1m(bucket: datetime, symbol: string, open: decimal, high: decimal, low: decimal, close: decimal, volume: integer)
 ```
 
 And you can run any query as you do with regular active record queries.
 
 ```ruby
 Ohlc1m.order(bucket: :desc).last
-=> #<Timescale::Ohlc1m:0x00007fe99c2c38e0
+=> #<Timescaledb::Ohlc1m:0x00007fe99c2c38e0
  bucket: 2000-01-01 00:00:00 UTC,
  symbol: "SYMBOL",
  open: 0.13e2,
@@ -211,7 +211,9 @@ Or install it yourself as:
 
 ## Usage
 
-You can check the [all_in_one.rb](examples/all_in_one.rb) that will:
+Check the [examples/ranking](examples/ranking) to get a Rails complete example.
+
+You can check the [all_in_one.rb](examples/all_in_one/all_in_one.rb) example that will:
 
 1. Create hypertable with compression settings
 2. Insert data
@@ -221,6 +223,11 @@ You can check the [all_in_one.rb](examples/all_in_one.rb) that will:
 6. Check chunk status
 7. Decompress a chunk
 
+### Testing
+
+If you need some inspiration for how are you going to test your hypertables,
+please check the [spec/spec_helper.rb](spec/spec_helper.rb) for inspiration.
+
 ### Migrations
 
 Create table is now with the `hypertable` keyword allowing to pass a few options
@@ -243,7 +250,7 @@ create_table(:events, id: false, hypertable: hypertable_options) do |t|
 end
 ```
 
-#### create_continuous_aggregates
+#### create_continuous_aggregate
 
 This example shows a ticks table grouping ticks as OHLCV histograms for every
 minute.
@@ -287,9 +294,19 @@ options = {
   }
 }
 
-create_continuous_aggregates('ohlc_1m', query, **options)
+create_continuous_aggregate('ohlc_1m', query, **options)
 ```
 
+#### Scenic integration
+
+The [Scenic](https://github.com/scenic-views/scenic) gem is an easy way to
+manage database view definitions for a Rails application. TimescaleDB's
+continuous aggregates are more complex than regular PostgreSQL views, and
+the schema dumper included with Scenic can't dump a complete definition.
+
+This gem automatically configures Scenic to use a `Timescaledb::Scenic::Adapter`
+which will correctly handle schema dumping.
+
 ### Enable ActsAsHypertable
 
 You can declare a Rails model as a Hypertable by invoking the `acts_as_hypertable` macro. This macro extends your existing model with timescaledb-related functionality.
@@ -318,7 +335,7 @@ end
 To get all the chunks from a model's hypertable, you can use `.chunks`.
 
 ```ruby
-Event.chunks # => [#<Timescale::Chunk>, ...]
+Event.chunks # => [#<Timescaledb::Chunk>, ...]
 ```
 
 ### Hypertable metadata
@@ -326,20 +343,20 @@ Event.chunks # => [#<Timescale::Chunk>, ...]
 To get the models' hypertable metadata, you can use `.hypertable`.
 
 ```ruby
-Event.hypertable # => #<Timescale::Hypertable>
+Event.hypertable # => #<Timescaledb::Hypertable>
 ```
 
-To get hypertable metadata for all hypertables: `Timescale.hypertables`.
+To get hypertable metadata for all hypertables: `Timescaledb.hypertables`.
 
 ### Compression Settings
 
 Compression settings are accessible through the hypertable.
 
 ```ruby
-Event.hypertable.compression_settings # => [#<Timescale::CompressionSettings>, ...]
+Event.hypertable.compression_settings # => [#<Timescaledb::CompressionSettings>, ...]
 ```
 
-To get compression settings for all hypertables: `Timescale.compression_settings`.
+To get compression settings for all hypertables: `Timescaledb.compression_settings`.
 
 ### Scopes
 
@@ -388,7 +405,7 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install the development dependencies. Then, `bundle exec rake test:setup` to setup the test database and tables. Finally, run `bundle exec rspec` to run the tests.
+After checking out the repo, run `bin/setup` to install the development dependencies. Then, `bundle exec rake test:setup` to setup the test database and tables. Finally, run `bundle exec rake` to run the tests.
 
 You can also run `tsdb` for an interactive prompt that will allow you to experiment.
 
@@ -405,7 +422,7 @@ You can put some postgres URI directly as a parameter of
 `tsdb`. Here is an example from the console:
 
 ```bash
-tsdb "postgres://jonatasdp@localhost:5432/timescale_test"
+tsdb "postgres://jonatasdp@localhost:5432/timescaledb_test"
 ```
 
 ## More resources

data/Rakefile

@@ -1,9 +1,15 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+begin
+  require "gemika/tasks"
+rescue LoadError
+  puts "Run `gem install gemika` for additional tasks"
+end
+
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: "matrix:spec"
 
 namespace :test do
   task :setup do

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "timescale"
+require "timescaledb"
 
 def uri_from_test
   require 'dotenv'
@@ -11,7 +11,7 @@ end
 
 ActiveRecord::Base.establish_connection(ARGV[0] || uri_from_test)
 
-Timescale::Hypertable.find_each do |hypertable|
+Timescaledb::Hypertable.find_each do |hypertable|
   class_name = hypertable.hypertable_name.singularize.camelize
 
   model = Class.new(ActiveRecord::Base) do
@@ -21,7 +21,7 @@ Timescale::Hypertable.find_each do |hypertable|
     acts_as_hypertable
   end
 
-  Timescale.const_set(class_name, model)
+  Timescaledb.const_set(class_name, model)
 end
 
 require "pry"

data/bin/setup

@@ -7,5 +7,7 @@ set -vx
 
 bundle install
 
+bundle install --gemfile Gemfile.scenic
+
 # For running tests it's going to use PG_URI_TEST env variable.
 # Please make sure  you set it properly to a TEST database!"

data/bin/tsdb

@@ -1,26 +1,26 @@
 #!/usr/bin/env ruby
 require "bundler/setup"
-require "timescale"
+require "timescaledb"
 require "pry"
 
 ActiveRecord::Base.establish_connection(ARGV[0])
 
-Timescale::Hypertable.find_each do |hypertable|
+Timescaledb::Hypertable.find_each do |hypertable|
   class_name = hypertable.hypertable_name.singularize.camelize
   model = Class.new(ActiveRecord::Base) do
     self.table_name = hypertable.hypertable_name
     acts_as_hypertable
   end
-  Timescale.const_set(class_name, model)
+  Timescaledb.const_set(class_name, model)
 end
 
-Timescale::ContinuousAggregates.find_each do |cagg|
+Timescaledb::ContinuousAggregates.find_each do |cagg|
   class_name = cagg.view_name.singularize.camelize
   model = Class.new(ActiveRecord::Base) do
     self.table_name = cagg.view_name
     acts_as_hypertable
   end
-  Timescale.const_set(class_name, model)
+  Timescaledb.const_set(class_name, model)
 end
 
 def show(obj)
@@ -28,7 +28,7 @@ def show(obj)
 end
 
 if ARGV.index("--stats")
-  scope = Timescale::Hypertable.all
+  scope = Timescaledb::Hypertable.all
 
   if (only = ARGV.index("--only"))
     only_hypertables = ARGV[only+1].split(",")
@@ -40,7 +40,7 @@ if ARGV.index("--stats")
     scope = scope.where.not(hypertable_name: except_hypertables)
   end
 
-  show(Timescale.stats(scope))
+  show(Timescaledb.stats(scope))
 end
 
 if ARGV.index("--console")

data/examples/{all_in_one.rb → all_in_one/all_in_one.rb}

@@ -1,5 +1,5 @@
 require 'bundler/setup'
-require 'timescale'
+require 'timescaledb'
 require 'pp'
 require 'pry'
 # ruby all_in_one.rb postgres://user:pass@host:port/db_name

data/examples/ranking/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/examples/ranking/.gitignore

@@ -0,0 +1,29 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/examples/ranking/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/examples/ranking/Gemfile

@@ -0,0 +1,33 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "2.7.1"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.2"
+
+gem "timescaledb", path: "../../"
+gem "pg", "~> 1.1"
+gem "puma", "~> 5.0"
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem "rack-cors"
+
+group :development, :test do
+  gem "pry-rails"
+end
+
+group :development do
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+
+gem "scenic", "~> 1.5"