tablature 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaec79244b29bb6514402673f8cb56f281c9cf25fb73c9a4dab413520e96b652
-  data.tar.gz: 54cfe803f7387135d1334dba6b4b16a0c7d1946adb6c88e092889fe881203511
+  metadata.gz: 37da9dc068662c878b97c2f7cf95274f9893d4a34940d9511db0933d98b3597c
+  data.tar.gz: 261087c9165cba3aa60d4999f398889725979fa0398a5775c2408c0e41a420bb
 SHA512:
-  metadata.gz: f30ffd3c9b8b14b08447b222a2bc5202042ef37f2c530beda33ed651c47ea7095f536bec494eef5767c44ba7a9b9751578bd9e3ff497e53203ac9bba477fc8a2
-  data.tar.gz: 2553bb52f8fecfa642cf2b8c1f3908bcabf01c3a9c6e5902076e7d447e6cf64c8bd13069902d95cc7e4478daff7a08b1d899128b74722687ad5a0dcf6e0962a0
+  metadata.gz: e66f6acf2ae0bbc061b92153b5f3ba798dd37f69302e2f6de5b6cf5363bdc3d8ce3bed6442017b6d85ef4aab52e96301056f72a16a393282396042c4d54334e1
+  data.tar.gz: 3855a566bc693bf97c7b20b2871703bb766fcd2553ef1e0043d5d18c47d7cc80eb60e779b0d2d9baf83aa2447379f9486de7104cb05945b2cc86adc9485fd537

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tablature (0.1.1)
+    tablature (0.2.0)
       activerecord (>= 5.0.0)
       railties (>= 5.0.0)
 
@@ -35,21 +35,21 @@ GEM
     arel (9.0.0)
     builder (3.2.3)
     coderay (1.1.2)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.4)
     crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
-    erubi (1.7.1)
-    i18n (1.1.1)
+    erubi (1.8.0)
+    i18n (1.5.1)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.0)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.10.0)
+      mini_portile2 (~> 2.4.0)
     pg (0.21.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -103,4 +103,4 @@ DEPENDENCIES
   tablature!
 
 BUNDLED WITH
-   1.16.6
+   1.17.2

data/README.md

@@ -55,14 +55,69 @@ class CreateEvents < ActiveRecord::Migration[5.0]
     # Create partitions with the bounds of the partition.
     create_list_partition_of :events_by_list,
       name: 'events_list_y2018m12', values: (Date.parse('2018-12-01')..Date.parse('2018-12-31')).to_a
+
   end
 
   def down
-    drop_table :events
+    drop_table :events_by_range
+    drop_table :events_by_list
   end
 end
 ```
 
+### Having a partition back a model
+
+
+In your migration:
+```ruby
+# db/migrate/create_events.rb
+class CreateEvents < ActiveRecord::Migration
+  def change
+    # You can use blocks when the partition key are SQL expression instead of
+    # being only a field.
+    create_range_partition :events, partition_key: -> { '(timestamp::DATE)' } do |t|
+      t.string :event_type, null: false
+      t.integer :value, null: false
+      t.datetime :timestamp, null: false
+      t.timestamps
+    end
+
+    create_range_partition_of :events,
+      name: 'events_y2018m12', range_start: '2018-12-01', range_end: '2019-01-01'
+
+    create_range_partition_of :events,
+      name: 'events_y2019m01', range_start: '2019-01-01', range_end: '2019-02-01'
+  end
+end
+```
+
+In your model, calling one of `range_partition` or `list_partition` to inject
+methods:
+```
+# app/models/event.rb
+class Event < ApplicationRecord
+  range_partition
+end
+```
+
+Finally, you can now list the partitions :
+```ruby
+>> Event.partitions
+# => ["events_y2018m12", "events_y2019m01"]
+```
+
+You can also create new partitions directly from the model :
+```ruby
+>> Event.create_range_partition(
+    name: 'events_y2019m02',
+    range_start: '2019-02-01'.to_date,
+    range_end: '2019-03-01'.to_date
+  )
+# => ...
+>> Event.partitions
+# => ["events_y2018m12", "events_y2019m01", "events_y2019m02"]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/tablature/adapters/postgres/partitioned_tables.rb

@@ -25,7 +25,8 @@ module Tablature
               c.oid,
               c.relname AS table_name,
               p.partstrat AS type,
-              (i.inhrelid::REGCLASS)::TEXT AS partition_name
+              (i.inhrelid::REGCLASS)::TEXT AS partition_name,
+              pg_get_partkeydef(c.oid) AS partition_key_definition
             FROM pg_class c
               INNER JOIN pg_partitioned_table p ON c.oid = p.partrelid
               LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
@@ -47,11 +48,17 @@ module Tablature
 
         def to_tablature_table(table_name, rows)
           result = rows.first
-          partioning_method = METHOD_MAP.fetch(result['type'])
+          partitioning_method = METHOD_MAP.fetch(result['type'])
           partitions = rows.map { |row| row['partition_name'] }.compact.map(&method(:unquote))
+          # This is very fragile code. This makes the assumption that:
+          # - Postgres will always have a function `pg_get_partkeydef` that returns the partition
+          # method with the partition key
+          # - Postgres will never have a partition method with two words in its name.
+          _, partition_key = result['partition_key_definition'].split(' ', 2)
 
           Tablature::PartitionedTable.new(
-            name: table_name, partioning_method: partioning_method, partitions: partitions
+            name: table_name, partitioning_method: partitioning_method,
+            partitions: partitions, partition_key: partition_key
           )
         end
 

data/lib/tablature/adapters/postgres/quoting.rb

@@ -4,7 +4,11 @@ module Tablature
       # @api private
       module Quoting
         def quote_partition_key(key)
-          key.to_s.split('::').map(&method(:quote_column_name)).join('::')
+          if key.respond_to?(:call)
+            key.call.to_s
+          else
+            key.to_s.split('::').map(&method(:quote_column_name)).join('::')
+          end
         end
 
         def quote_collection(values)

data/lib/tablature/adapters/postgres.rb

@@ -47,7 +47,7 @@ module Tablature
       # @param [String, Symbol] table_name The name of the table to partition.
       # @param [Hash] options The options to create the partition. Keys besides +:partition_key+
       #   will be passed to +create_table+.
-      # @option options [String, Symbol] :partition_key The partition key.
+      # @option options [String, Symbol, #call] :partition_key The partition key.
       # @yield [td] A TableDefinition object. This allows creating the table columns the same way
       #   as Rails's +create_table+ does.
       #
@@ -84,7 +84,6 @@ module Tablature
       # @param [String, Symbol] table_name The name of the table to partition.
       # @param [Hash] options The options to create the partition. Keys besides +:partition_key+
       #   will be passed to +create_table+.
-      # @option options [String, Symbol] :partition_key The partition key.
       # @yield [td] A TableDefinition object. This allows creating the table columns the same way
       #   as Rails's +create_table+ does.
       #

data/lib/tablature/model/partition_methods.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Tablature
+  module Model
+    module PartitionMethods
+      extend Forwardable
+      def_delegators :tablature_partition, :partitions, :partition_key, :partitioning_method
+
+      def tablature_partition
+        partition = Tablature.database.partitioned_tables.find do |pt|
+          pt.name == partition_name.to_s
+        end
+        raise Tablature::MissingPartition if partition.nil?
+
+        partition
+      end
+
+      def partitioned?
+        begin
+          tablature_partition
+        rescue Tablature::MissingPartition
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/tablature/model.rb

@@ -1,4 +1,51 @@
+require 'tablature/model/partition_methods'
+
 module Tablature
   module Model
+    module ListPartitionMethods
+      def create_list_partition(options)
+        Tablature.database.create_list_partition_of(tablature_partition.name, options)
+      end
+    end
+
+    module RangePartitionMethods
+      def create_range_partition(options)
+        Tablature.database.create_range_partition_of(tablature_partition.name, options)
+      end
+    end
+
+    module ClassMethods
+      def list_partition(partition_name = table_name)
+        setup_partition(partition_name)
+        extend(PartitionMethods)
+        extend(ListPartitionMethods)
+      end
+
+      def range_partition(partition_name = table_name)
+        setup_partition(partition_name)
+        extend(PartitionMethods)
+        extend(RangePartitionMethods)
+      end
+
+      # @api private
+      def inspect
+        return super unless partitioned?
+
+        # Copied from the Rails source.
+        attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ', '
+        "#{self}(#{attr_list})"
+      end
+
+      private
+
+      def setup_partition(partition_name)
+        class_attribute(:partition_name)
+        self.partition_name = partition_name
+      end
+    end
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
   end
 end

data/lib/tablature/partitioned_table.rb

@@ -13,21 +13,27 @@ module Tablature
 
     # The partitioning method of the table
     # @return [Symbol]
-    attr_reader :partioning_method
+    attr_reader :partitioning_method
 
     # The partitions of the table.
     # @return [Array]
     attr_reader :partitions
 
+    # The partition key expression.
+    # @return [String]
+    attr_reader :partition_key
+
     # Returns a new instance of PartitionTable.
     #
     # @param name [String] The name of the view.
-    # @param partioning_method [:symbol] One of :range, :list or :hash
+    # @param partitioning_method [:symbol] One of :range, :list or :hash
     # @param partitions [Array] The partitions of the table.
-    def initialize(name:, partioning_method:, partitions: [])
+    # @param partition_key [String] The partition key expression.
+    def initialize(name:, partitioning_method:, partitions: [], partition_key:)
       @name = name
-      @partioning_method = partioning_method
+      @partitioning_method = partitioning_method
       @partitions = partitions
+      @partition_key = partition_key
     end
   end
 end

data/lib/tablature/version.rb

@@ -1,3 +1,3 @@
 module Tablature
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/tablature.rb

@@ -20,7 +20,7 @@ module Tablature
     ActiveRecord::ConnectionAdapters::AbstractAdapter.include Tablature::Statements
     ActiveRecord::Migration::CommandRecorder.include Tablature::CommandRecorder
     ActiveRecord::SchemaDumper.prepend Tablature::SchemaDumper
-    ActiveRecord::Base.prepend Tablature::Model
+    ActiveRecord::Base.include Tablature::Model
   end
 
   # The current database adapter used by Tablature.
@@ -29,4 +29,10 @@ module Tablature
   def self.database
     configuration.database
   end
+
+  class MissingPartition < StandardError
+    def initialize
+      super('Missing partition')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablature
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Aliou Diallo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - lib/tablature/command_recorder.rb
 - lib/tablature/configuration.rb
 - lib/tablature/model.rb
+- lib/tablature/model/partition_methods.rb
 - lib/tablature/partitioned_table.rb
 - lib/tablature/railtie.rb
 - lib/tablature/schema_dumper.rb