sequel-mysql_generated_columns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cebd0e3d382ad56563cc96ab8f07ce0f4936455c
-  data.tar.gz: fa6d22d714976ed109e45a474936427141f6d06e
+  metadata.gz: f89990321a4c7b4523b5e3065df8106095d85a75
+  data.tar.gz: bba7a2bb5d8309a441d4c78bbc01b6eefda23b69
 SHA512:
-  metadata.gz: 00a490e3c86c400f023612c92e54b4927ade888017d7be3c5773d719405ec6424d9b33b6040901475f7acd723e49bae4af1c96ae8ca9b6cc615ca91eae8b0d43
-  data.tar.gz: a8ce7cf5f97015e61f92d6bf2b581c60eaee234a24b70b08d47677ca3c71f64d47d240b6cdb5bcd06ed775e6f221b1f9524a886f1aff0707296425cfd49b16f4
+  metadata.gz: 5315b306cb5247eb13602a9a41c7295c9e6e419ea43203a25556804ba508404df6a2c533f12267b90148acd2806851e14b80736ac646758550471ac891c3be81
+  data.tar.gz: ade24da7fcb5a53687d224a8f766be398622993b4c7acbb856da39a941eefa15333a32c9be7301e2ea96099f3e052d83dd2856cfe40fe992b80db1997870e45d

data/README.md

@@ -3,18 +3,22 @@
 Sequel extension that adds support for MySQL generated columns (added first on
 MySQL 5.7.5).
 
-When enabled, use `#generated_column` method on `DB#create_table` blocks, and
-`#add_generated_column` method on `DB#alter_table` blocks.
+When enabled, it allows passing an SQL expression with the option `:as` to
+`#column` and `#add_column` methods, inside `DB#create_table` and
+`DB#alter_table` blocks.
 
 ## Example
 
+When used in a `create_table` block:
+
 ```ruby
 create_table(:triangles) do
-  Integer :a
-  Integer :b
-  generated_column :c, Integer, :sqrt.sql_function(:a*:a + :b*:b)
+  integer :a
+  integer :b
+  integer :c, :as => :sqrt.sql_function(:a*:a + :b*:b)
 end
 ```
+This will generate the following SQL statement:
 
 ```sql
 CREATE TABLE `triangles` (
@@ -24,16 +28,24 @@ CREATE TABLE `triangles` (
 )
 ```
 
+In this example, after creating a table with a single JSON column, the next
+`alter_table` block:
+
 ```ruby
 create_table(:docs) do
   json :doc
 end
 
 alter_table(:docs) do
-  add_generated_column :id, Integer, :json_extract.sql_function(:doc, '$.id'), primary_key: true, stored: true
+  add_column :id, Integer, :as => :json_extract.sql_function(:doc, '$.id'),
+                           :stored => true,
+                           :primary_key => true
 end
 ```
 
+will add a stored generated column with a primary key over the JSON object
+property `id` in from the JSON document stored in column `doc`:
+
 ```sql
 CREATE TABLE `documents` (`doc` json)
 ALTER TABLE `documents` ADD COLUMN `id` integer AS (json_extract(`doc`, '$.id')) STORED PRIMARY KEY

data/lib/sequel/extensions/mysql_generated_columns.rb

@@ -9,55 +9,12 @@ module Sequel
       NOT_NULL = ' NOT NULL'.freeze
       PRIMARY_KEY = ' PRIMARY KEY'.freeze
 
-      # Additional methods for the create_table generator to support constraint validations.
-      module CreateTableGeneratorMethods
-        def generated_column(name, type, expr, opts={})
-          index_opts = opts.delete(:index)
-          columns << {:name => name, :type => type, :expr => expr, :gen => true}.merge!(opts)
-          if index_opts
-            index(name, index_opts.is_a?(Hash) ? index_opts : {})
-          end
-        end
-      end
-
-      # Additional methods for the alter_table generator to support constraint validations,
-      # used to give it a more similar API to the create_table generator.
-      module AlterTableGeneratorMethods
-        include CreateTableGeneratorMethods
-
-        # Add a generated column with the given name, type, and opts to the DDL for the table.
-        #
-        #   add_generated_column(:name, String, Sequel.function(:sum, :a, :b)) # ADD COLUMN name varchar(255) AS (SUM(a, b))
-        def add_generated_column(name, type, expr, opts={})
-          @operations << {:op => :add_column, :name => name, :type => type, :expr => expr, :gen => true}.merge!(opts)
-        end
-      end
-
-      # Modify the default create_table generator to include
-      # the generated columns methods.
-      def create_table_generator(&block)
-        super do
-          extend CreateTableGeneratorMethods
-          @generated_columns = []
-          instance_eval(&block) if block
-        end
-      end
-
-      # Modify the default alter_table generator to include
-      # the generated columns methods.
-      def alter_table_generator(&block)
-        super do
-          extend AlterTableGeneratorMethods
-          instance_eval(&block) if block
-        end
-      end
-
       # Modify column definition generator method to support generated columns
       def column_definition_sql(column)
-        if column[:gen]
+        if expr = column[:as]
           sql = String.new
           sql << "#{quote_identifier(column[:name])} #{type_literal(column)}"
-          sql << " AS (#{literal(column[:expr])})"
+          sql << " AS (#{literal(expr)})"
           generated_column_definition_order.each{|m| send(:"generated_column_definition_#{m}_sql", sql, column)}
           sql
         else

data/sequel-mysql_generated_columns.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "sequel-mysql_generated_columns"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Damián Silvani"]
   spec.email         = ["munshkr@gmail.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-mysql_generated_columns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Damián Silvani