activerecord-tidb-adapter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442a2dcd175987185739a1fad7a8ef8788d0b13b7263018795ac144a4c10ee03
-  data.tar.gz: e568154643ebebfc8a9dcfd506b18732d52dea1a19b6500b76e9103965fd2cff
+  metadata.gz: 85ed982e6735cfcb567e2d863975ba8f56e98dd6243578394e2ca01dc07ca91a
+  data.tar.gz: c7aefb6293698e59ce8ff6812b156070622c6ed7c58689e39c4eca5946309959
 SHA512:
-  metadata.gz: d01699afa9a6c147317b8b6fd5763bcbf63852bccaa4fe6dd5bac076405bfc02ff98ae177cd1eef39a8aac95493a4e7eac31896260bceb8b78d2c2b3976605c6
-  data.tar.gz: 932f70292fde728c25d21bf7180dbad488ca4b5d7630bfe669b70dbf1dee0165f24b311d284ed0ab8edd1b5ab1b688d28d29e7a1748c8a571101950568373a00
+  metadata.gz: af4ea51bd264d25cd621e3c95438fd9fd3c7df8b2dea533172cbeb0e07110e661dc68b0d294c23a1420e2b9c0a74334b14c46213d59425764a37336702d17034
+  data.tar.gz: d07ec9fa2f944d6832c7f70287d4583073ea633b7c8364936801e555ac5592a4c5d21b18e9fff5b12a2599b4b8bfc637c5163cbb0b6604e0af1c5b388bc7f70f

data/Gemfile.lock

@@ -87,7 +87,7 @@ GIT
 PATH
   remote: .
   specs:
-    activerecord-tidb-adapter (0.3.0)
+    activerecord-tidb-adapter (0.4.0)
       activerecord (~> 6.1)
       mysql2
 

data/README.md

@@ -44,6 +44,62 @@ development:
 
 * demo repo with rails 6.1.4: https://github.com/hooopo/activerecord-tidb-adapter-demo
 
+## TiDB features
+
+**[Sequence](https://docs.pingcap.com/tidb/stable/sql-statement-create-sequence)**
+
+Sequence as primary key
+
+```ruby
+class TestSeq < ActiveRecord::Migration[6.1]
+  def up
+    # more options: increment, min_value, cycle, cache
+    create_sequence :orders_seq, start: 1024
+    create_table :orders, id: false do |t|
+      t.primary_key :id, default: -> { "nextval(orders_seq)" }
+      t.string :name
+    end
+  end
+
+  def down
+    drop_table :orders
+    drop_sequence :orders_seq
+  end
+end
+```
+
+Generated DDL
+```sql
+mysql> show create table orders_seq\G;
+*************************** 1. row ***************************
+       Sequence: orders_seq
+Create Sequence: CREATE SEQUENCE `orders_seq` start with 1024 minvalue 1 maxvalue 9223372036854775806 increment by 1 nocache nocycle ENGINE=InnoDB
+
+mysql> show create table orders\G;
+*************************** 1. row ***************************
+       Table: orders
+Create Table: CREATE TABLE `orders` (
+  `id` bigint(20) NOT NULL DEFAULT nextval(`activerecord_tidb_adapter_demo_development`.`orders_seq`),
+  `name` varchar(255) COLLATE utf8mb4_general_ci DEFAULT NULL,
+  PRIMARY KEY (`id`) /*T![clustered_index] CLUSTERED */
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
+
+```
+
+This gem also adds a few helpers to interact with `SEQUENCE`
+
+```ruby
+# Advance sequence and return new value
+ActiveRecord::Base.nextval("numbers")
+
+# Return value most recently obtained with nextval for specified sequence.
+ActiveRecord::Base.lastval("numbers")
+
+# Set sequence's current value
+ActiveRecord::Base.setval("numbers", 1234)
+```
+
+
 ## Setting up local TiDB server
 
 Install [tiup](https://github.com/pingcap/tiup)
@@ -93,7 +149,7 @@ MYSQL_USER=root MYSQL_HOST=127.0.0.1 MYSQL_PORT=4000 tidb=1 ARCONN=tidb bundle e
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-tidb-adapter.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pingcap/activerecord-tidb-adapter.
 
 ## License
 

data/Rakefile

@@ -15,7 +15,7 @@ namespace :test do
   Rake::TestTask.new('tidb') do |t|
     t.libs = ARTest::TiDB.test_load_paths
     t.test_files = test_files
-    t.warning = !!ENV['WARNING']
+    t.warning = !ENV['WARNING'].nil?
     t.verbose = false
   end
 

data/lib/active_record/connection_adapters/tidb/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Type
     class << self

data/lib/active_record/connection_adapters/tidb_adapter.rb

@@ -4,6 +4,7 @@ require 'active_record/connection_adapters'
 require 'active_record/connection_adapters/mysql2_adapter'
 require 'active_record/connection_adapters/tidb/setup'
 require_relative '../../version'
+require_relative '../sequence'
 
 ActiveRecord::ConnectionAdapters::Tidb.initial_setup
 
@@ -31,6 +32,7 @@ module ActiveRecord
 
   module ConnectionAdapters
     class TidbAdapter < Mysql2Adapter
+      include ActiveRecord::Sequence::Adapter
       ADAPTER_NAME = 'Tidb'
 
       def supports_savepoints?
@@ -93,10 +95,38 @@ module ActiveRecord
       end
 
       def self.database_exists?(config)
-        !!ActiveRecord::Base.tidb_connection(config)
+        !ActiveRecord::Base.tidb_connection(config).nil?
       rescue ActiveRecord::NoDatabaseError
         false
       end
+
+      def new_column_from_field(_table_name, field)
+        type_metadata = fetch_type_metadata(field[:Type], field[:Extra])
+        default = field[:Default]
+        default_function = nil
+
+        if type_metadata.type == :datetime && /\ACURRENT_TIMESTAMP(?:\([0-6]?\))?\z/i.match?(default)
+          default_function = default
+          default = nil
+        elsif type_metadata.extra == 'DEFAULT_GENERATED'
+          default = +"(#{default})" unless default.start_with?('(')
+          default_function = default
+          default = nil
+        elsif default.to_s =~ /nextval/i
+          default_function = default
+          default = nil
+        end
+
+        MySQL::Column.new(
+          field[:Field],
+          default,
+          type_metadata,
+          field[:Null] == 'YES',
+          default_function,
+          collation: field[:Collation],
+          comment: field[:Comment].presence
+        )
+      end
     end
   end
 end

data/lib/active_record/sequence.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'active_record'
+require 'active_record/connection_adapters/mysql/schema_dumper'
+require 'active_record/migration/command_recorder'
+require 'active_record/schema_dumper'
+
+module ActiveRecord
+  module Sequence
+    require 'active_record/sequence/command_recorder'
+    require 'active_record/sequence/adapter'
+    require 'active_record/sequence/schema_dumper'
+    require 'active_record/sequence/model_methods'
+  end
+end
+
+ActiveRecord::Migration::CommandRecorder.include(ActiveRecord::Sequence::CommandRecorder)
+
+ActiveRecord::SchemaDumper.prepend(ActiveRecord::Sequence::SchemaDumper)
+ActiveRecord::Base.extend(ActiveRecord::Sequence::ModelMethods)

data/lib/active_record/sequence/adapter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Sequence
+    module Adapter
+      def check_sequences
+        select_all(
+          'SELECT * FROM information_schema.sequences ORDER BY sequence_name'
+        ).to_a
+      end
+
+      def create_sequence(name, options = {})
+        increment = options[:increment] || options[:step]
+        name = quote_column_name(name)
+
+        sql = ["CREATE SEQUENCE IF NOT EXISTS #{name}"]
+        sql << "INCREMENT BY #{increment}" if increment
+        sql << "START WITH #{options[:start]}" if options[:start]
+        sql << if options[:cache]
+                 "CACHE #{options[:cache]}"
+               else
+                 'NOCACHE'
+               end
+
+        sql << if options[:cycle]
+                 'CYCLE'
+               else
+                 'NOCYCLE'
+               end
+
+        sql << "MIN_VALUE #{options[:min_value]}" if options[:min_value]
+
+        sql << "COMMENT #{quote(options[:comment].to_s)}" if options[:comment]
+
+        execute(sql.join("\n"))
+      end
+
+      def drop_sequence(name)
+        name = quote_column_name(name)
+        sql = "DROP SEQUENCE #{name}"
+        execute(sql)
+      end
+    end
+  end
+end

data/lib/active_record/sequence/command_recorder.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Sequence
+    module CommandRecorder
+      def create_sequence(name, options = {})
+        record(__method__, [name, options])
+      end
+
+      def drop_sequence(name)
+        record(__method__, [name])
+      end
+
+      def invert_create_sequence(args)
+        name, = args
+        [:drop_sequence, [name]]
+      end
+    end
+  end
+end

data/lib/active_record/sequence/model_methods.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Sequence
+    module ModelMethods
+      def nextval(name)
+        name = connection.quote_column_name(name)
+        connection.query_value("SELECT nextval(#{name})")
+      end
+
+      def lastval(name)
+        name = connection.quote_column_name(name)
+        connection.query_value("SELECT lastval(#{name})")
+      end
+
+      def setval(name, value)
+        name = connection.quote_column_name(name)
+        connection.query_value("SELECT setval(#{name}, #{value})")
+      end
+    end
+  end
+end

data/lib/active_record/sequence/schema_dumper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Sequence
+    module SchemaDumper
+      def header(stream)
+        super
+        sequences(stream)
+      end
+
+      def sequences(stream)
+        sequences = @connection.check_sequences
+        return if sequences.empty?
+
+        sequences.each do |seq|
+          start_value = seq['START']
+          increment = seq['INCREMENT']
+          cache = seq['CACHE']
+          cache_value = seq['CACHE_VALUE']
+          min_value = seq['MIN_VALUE']
+          cycle = seq['CYCLE']
+          comment = seq['COMMENT']
+
+          options = []
+
+          options << "start: #{start_value}" if start_value && Integer(start_value) != 1
+
+          options << "increment: #{increment}" if increment && Integer(increment) != 1
+
+          options << "cache: #{cache_value}" if cache_value && Integer(cache_value) != 0
+
+          options << "min_value: #{min_value}" if min_value
+
+          options << 'cycle: true' if cycle.to_i != 0
+
+          options << "comment: #{comment.inspect}" if comment.present?
+
+          statement = [
+            'create_sequence',
+            seq['SEQUENCE_NAME'].inspect
+          ].join(' ')
+
+          if options.any?
+            statement << (options.any? ? ", #{options.join(', ')}" : '')
+          end
+
+          stream.puts "  #{statement}"
+        end
+
+        stream.puts
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  TIDB_ADAPTER_VERSION = '0.3.0'
+  TIDB_ADAPTER_VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-tidb-adapter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Hooopo Wang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -59,6 +59,11 @@ files:
 - lib/active_record/connection_adapters/tidb/setup.rb
 - lib/active_record/connection_adapters/tidb/type.rb
 - lib/active_record/connection_adapters/tidb_adapter.rb
+- lib/active_record/sequence.rb
+- lib/active_record/sequence/adapter.rb
+- lib/active_record/sequence/command_recorder.rb
+- lib/active_record/sequence/model_methods.rb
+- lib/active_record/sequence/schema_dumper.rb
 - lib/activerecord-tidb-adapter.rb
 - lib/version.rb
 homepage: https://github.com/pingcap/activerecord-tidb-adapter