pg_party 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0edf666f9d4e7d3a7af82990be55d58b970949c5a549c1d8f1e1aeb2c066b09
-  data.tar.gz: 8c1164c72ffec0f00a892f9f4cf7028969a7aa39d056f4aae5e05674651a6142
+  metadata.gz: b833474e06e9a20278f5ad629e4c26f290baeeac56a0aa9c4ec6dc1104023393
+  data.tar.gz: 881f312c5714dc37760ef49537a5a200b46e72bace05a944890fe78dcc110f71
 SHA512:
-  metadata.gz: 60baccd0471cd1628714d9d10e918d5b3be2708d07850bedf8751323cd91737321f93441fec5a576346de409580c3a7f2bb99a384c7edb0b1c70b0e96a2be84b
-  data.tar.gz: 12126fee3f2eae1b3a70771c79a07cab254b061c3b11ed20fbc8095f7521db05672219e93437f7a3cbb062b4ed95dd56aa2f09ae8e032b7a26cfaab7f6878def
+  metadata.gz: 6b9a253b6fe399aa6908bc4d7a4e8625622fadf4877af642d22c52f1e52c211a89b23e4cf3d4bec94b461fc9daf4db5de23384091255a33d055872cd337f97ef
+  data.tar.gz: 8425ced0e015ceada85d6fedf1b553358a774ff39b85a0d4700c058a8747a24049e4f6d52a7d138722cb7cca3e04f75d883eed51f10df8f8ddbe88de629ead6a

data/README.md

@@ -66,7 +66,10 @@ These values can be accessed and set via `PgParty.config` and `PgParty.configure
   - Default: `true`
 - `create_with_primary_key`
   - Whether to add primary key constraints to partitioned (parent) tables by default.
-    * This is not supported for Postgres 10 but is recommended for Postgres 11
+    * This behavior is disabled by default as this configuration usually requires composite primary keys to be specified
+      and ActiveRecord does not natively support composite primary keys. There are workarounds such as the
+      [composite_primary_keys gem](https://github.com/composite-primary-keys/composite_primary_keys).
+    * This is not supported for Postgres 10 (requires Postgres 11+)
     * Primary key constraints must include all partition keys, for example: `primary_key: [:id, :created_at], partition_key: :created_at`
     * Partition keys cannot use expressions
     * Can be overridden via the `create_with_primary_key:` option when creating partitioned tables
@@ -86,7 +89,8 @@ PgParty.configure do |c|
   c.caching_ttl = 60
   c.schema_exclude_partitions = false
   c.include_subpartitions_in_partition_list = true
-  # Postgres 11+ users starting fresh may want to use below options
+  # Postgres 11+ users starting fresh may consider the below options to rely on Postgres' native features instead of
+  # this gem's template tables feature.
   c.create_template_tables = false
   c.create_with_primary_key = true
 end
@@ -221,7 +225,7 @@ class CreateSomeListRecord < ActiveRecord::Migration[5.1]
 end
 ```
 
-Create _hash_ partitioned table on `id` with two partitions (Postgres 11+ required):
+Create _hash_ partitioned table on `account_id` with two partitions (Postgres 11+ required):
   * A hash partition can be used to spread keys evenly(ish) across partitions
   * `modulus:` should always equal the total number of partitions planned for the table
   * `remainder:` is an integer which should be in the range of 0 to modulus-1
@@ -232,7 +236,11 @@ class CreateSomeHashRecord < ActiveRecord::Migration[5.1]
     # symbol is used for partition keys referring to individual columns
     # create_with_primary_key: true, template: false on Postgres 11 will rely on PostgreSQL's native partition schema
     # management vs this gem's template tables
-    create_hash_partition :some_hash_records, partition_key: :id, create_with_primary_key: true, template: false do |t|
+    # Note composite primary keys will require a workaround in ActiveRecord, such as through the use of the composite_primary_keys gem
+    create_hash_partition :some_hash_records, partition_key: :account_id, primary_key: [:id, :account_id],
+    create_with_primary_key: true, template: false do |t|
+      t.bigserial :id, null: false
+      t.bigint :account_id, null: false
       t.text :some_value
       t.timestamps
     end
@@ -252,26 +260,18 @@ class CreateSomeHashRecord < ActiveRecord::Migration[5.1]
 end
 ```
 
-Advanced example with subpartitioning: Create _list_ partitioned table on `id` subpartitioned by _range_ on `created_at`
-with default partitions
-* We can use Postgres 11's support for primary keys vs template tables, using the composite primary key `[:id, :created_at]`
-  to ensure all partition keys are present in the primary key
+Advanced example with subpartitioning: Create _list_ partitioned table on `account_id` subpartitioned by _range_ on `created_at`
+with default partitions. This example is for a table with no primary key... perhaps for some analytics use case.
 * Default partitions are only supported in Postgres 11+
 
 ```ruby
 class CreateSomeListSubpartitionedRecord < ActiveRecord::Migration[5.1]
   def up
-    # when specifying a composite primary key, the primary keys must be specified as columns
-    create_list_partition \
-      :some_list_subpartitioned_records,
-      partition_key: [:id],
-      primary_key: [:id, :created_at],
-      template: false,
-      create_with_primary_key: true do |t|
-
-      t.integer :id
+    create_list_partition :some_list_subpartitioned_records, partition_key: :account_id, id: false,
+      template: false do |t|
+      t.bigint :account_id, null: false
       t.text :some_value
-      t.timestamps
+      t.created_at
     end
 
     create_default_partition_of \
@@ -331,7 +331,8 @@ To avoid explicit index creation for _every_ new partition, we've introduced the
 For every call to `create_list_partition` and `create_range_partition`, a clone `<table_name>_template` is created.
 Indexes, constraints, etc. created on the template table will propagate to new partitions in calls to `create_list_partition_of` and `create_range_partition_of`:
 * Subpartitions will correctly clone from template tables if a template table exists for the top-level ancestor
-* When using Postgres 11 or higher, you may wish to disable template tables and use the native features instead, see [Configuration](#configuration)
+* When using Postgres 11 or higher, you may wish to disable template tables and use the native features instead, see [Configuration](#configuration)\
+  but this may result in you using composite primary keys, which is not natively supported by ActiveRecord.
 
 ```ruby
 class CreateSomeListRecord < ActiveRecord::Migration[5.1]

data/lib/pg_party/adapter_decorator.rb

@@ -149,9 +149,9 @@ module PgParty
               '`disable_ddl_transaction!` and break out this operation into its own migration.'
       end
 
-      index_name, index_type, index_columns, index_options, algorithm, using = add_index_options(
-          table_name, column_name, options
-        )
+      index_name, index_type, index_columns, index_options, algorithm, using = extract_index_options(
+        add_index_options(table_name, column_name, **options)
+      )
 
       # Postgres limits index name to 63 bytes (characters). We will use 8 characters for a `_random_suffix`
       # on partitions to ensure no conflicts, leaving 55 chars for the specified index name
@@ -200,7 +200,7 @@ module PgParty
       end
       modified_options[:options] = partition_by_clause(type, partition_key)
 
-      create_table(table_name, modified_options) do |td|
+      create_table(table_name, **modified_options) do |td|
         if !modified_options[:id] && id == :uuid
           td.column(primary_key, id, null: false, default: uuid_function)
         elsif !modified_options[:id] && id
@@ -316,6 +316,27 @@ module PgParty
               "#{quote_table_name(table_name)} #{using} (#{columns})#{options}"
     end
 
+    def extract_index_options(add_index_options_result)
+      # Rails 6.1 changes the result of #add_index_options
+      index_definition = add_index_options_result.first
+      return add_index_options_result unless index_definition.is_a?(ActiveRecord::ConnectionAdapters::IndexDefinition)
+
+      index_columns = if index_definition.columns.is_a?(String)
+                        index_definition.columns
+                      else
+                        quoted_columns_for_index(index_definition.columns, index_definition.column_options)
+                      end
+
+      [
+        index_definition.name,
+        index_definition.unique ? 'UNIQUE' : index_definition.type,
+        index_columns,
+        index_definition.where ? " WHERE #{index_definition.where}" : nil,
+        add_index_options_result.second, # algorithm option
+        index_definition.using ? "USING #{index_definition.using}" : nil
+      ]
+    end
+
     def drop_indices_if_exist(index_names)
       index_names.uniq.each { |name| execute "DROP INDEX IF EXISTS #{quote_column_name(name)}" }
     end

data/lib/pg_party/model/shared_methods.rb

@@ -8,7 +8,7 @@ module PgParty
       def reset_primary_key
         return base_class.primary_key if self != base_class
 
-        partitions = partitions(include_subpartitions: true)
+        partitions = partitions(include_subpartitions: PgParty.config.include_subpartitions_in_partition_list)
         return get_primary_key(base_class.name) if partitions.empty?
 
         first_partition = partitions.detect { |p| !connection.table_partitioned?(p) }
@@ -23,8 +23,8 @@ module PgParty
         connection.schema_cache.data_source_exists?(target_table)
       end
 
-      def partitions(*args)
-        PgParty::ModelDecorator.new(self).partitions(*args)
+      def partitions(**args)
+        PgParty::ModelDecorator.new(self).partitions(**args)
       end
 
       def in_partition(*args)

data/lib/pg_party/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgParty
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_party
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ryan Krage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement