Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MySQL: Support :size option to change text and blob size #35071

Merged
merged 1 commit into from Jan 29, 2019

Conversation

@kamipo
Copy link
Member

@kamipo kamipo commented Jan 28, 2019

In MySQL, the text column size is 65,535 bytes by default (1 GiB in
PostgreSQL). It is sometimes too short when people want to use a text
column, so they sometimes change the text size to mediumtext (16 MiB) or
longtext (4 GiB) by giving the limit option.

Unlike MySQL, PostgreSQL doesn't allow the limit option for a text
column (raises ERROR: type modifier is not allowed for type "text").
So limit: 4294967295 (longtext) couldn't be used in Action Text.

I've allowed changing text and blob size without giving the limit
option, it prevents that migration failure on PostgreSQL.

Copy link
Member

@jeremy jeremy left a comment

Nice feature for Active Record migrations! And great to expand Action Text support to PostgreSQL. Changelog entries for both, too?

@kamipo
Copy link
Member Author

@kamipo kamipo commented Jan 28, 2019

hm... I've realized that limit: 16777215 is ignored on PostgreSQL adapter, so Action Text originally work on PostgreSQL.

when "text"
# PostgreSQL doesn't support limits on text columns.
# The hard limit is 1GB, according to section 8.3 in the manual.
case limit
when nil, 0..0x3fffffff; super(type)
else raise(ActiveRecordError, "The limit on text can be at most 1GB - 1byte.")

I think that using limit: 16777215 (mediumtext 16 MiB) not limit: 4294967295 (longtext 4 GiB) is to ignore the limit option on PostgreSQL adapter.
So how about changing mediumtext to longtext for MySQL? 16 MiB is still too shorter than PostgreSQL's limit (1 GiB).

@kamipo kamipo force-pushed the kamipo:text_without_limit branch from a0af7d5 to 76b93c9 Jan 28, 2019
@@ -2,7 +2,7 @@ class CreateActionTextTables < ActiveRecord::Migration[6.0]
def change
create_table :action_text_rich_texts do |t|
t.string :name, null: false
t.text :body, limit: 16777215
t.text :body, size: :long

This comment has been minimized.

@kamipo

kamipo Jan 28, 2019
Author Member

Changed from mediumtext (16 MiB) to longtext (4 GiB).

@kamipo kamipo changed the title Allow using Action Text on PostgreSQL MySQL: Support :size option to change text and blob size Jan 28, 2019
In MySQL, the text column size is 65,535 bytes by default (1 GiB in
PostgreSQL). It is sometimes too short when people want to use a text
column, so they sometimes change the text size to mediumtext (16 MiB) or
longtext (4 GiB) by giving the `limit` option.

Unlike MySQL, PostgreSQL doesn't allow the `limit` option for a text
column (raises ERROR: type modifier is not allowed for type "text").
So `limit: 4294967295` (longtext) couldn't be used in Action Text.

I've allowed changing text and blob size without giving the `limit`
option, it prevents that migration failure on PostgreSQL.
@kamipo kamipo force-pushed the kamipo:text_without_limit branch from 76b93c9 to 1745e90 Jan 28, 2019
@kamipo kamipo merged commit 8309cd2 into rails:master Jan 29, 2019
2 checks passed
2 checks passed
codeclimate All good!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@kamipo kamipo deleted the kamipo:text_without_limit branch Jan 29, 2019
kamipo added a commit to kamipo/rails that referenced this pull request Apr 7, 2019
…ther options

When I've added new `:size` option in rails#35071, I've found that invalid
`:limit` and `:precision` raises `ActiveRecordError` unlike other
invalid options.

I think that is hard to distinguish argument errors and statement
invalid errors since the `StatementInvalid` is a subclass of the
`ActiveRecordError`.

https://github.com/rails/rails/blob/c9e4c848eeeb8999b778fa1ae52185ca5537fffe/activerecord/lib/active_record/errors.rb#L103

```ruby
begin
  # execute any migration
rescue ActiveRecord::StatementInvalid
  # statement invalid
rescue ActiveRecord::ActiveRecordError, ArgumentError
  # `ActiveRecordError` except `StatementInvalid` is maybe an argument error
end
```

I'd say this is the inconsistency worth fixing.

Before:

```ruby
add_column :items, :attr1, :binary,   size: 10      # => ArgumentError
add_column :items, :attr2, :decimal,  scale: 10     # => ArgumentError
add_column :items, :attr3, :integer,  limit: 10     # => ActiveRecordError
add_column :items, :attr4, :datetime, precision: 10 # => ActiveRecordError
```

After:

```ruby
add_column :items, :attr1, :binary,   size: 10      # => ArgumentError
add_column :items, :attr2, :decimal,  scale: 10     # => ArgumentError
add_column :items, :attr3, :integer,  limit: 10     # => ArgumentError
add_column :items, :attr4, :datetime, precision: 10 # => ArgumentError
```
suketa added a commit to suketa/rails_sandbox that referenced this pull request Jul 27, 2019
MySQL: Support `:size` option to change text and blob size
rails/rails#35071
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants