A long-lived project that still receives updates
simple generate partition sql
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 0.5.6
~> 13.0
~> 3.13

Runtime

>= 6.1.0, < 9.0
~> 1.3.0, < 1.3.7
>= 6.1.0, < 9.0
 Project Readme

SimpleMysqlPartitioning

CI

A Ruby gem that provides simple MySQL table partitioning functionality for ActiveRecord models. This gem allows you to easily manage RANGE partitions in MySQL databases through an intuitive Ruby API.

Requirements

  • Ruby 3.0 or higher
  • Rails/ActiveRecord 6.1 or higher
  • MySQL 8.0 or higher

Compatibility

This gem is tested against:

  • Ruby: 3.0, 3.1, 3.2, 3.3
  • Rails: 6.1, 7.0, 7.1, 7.2
  • MySQL: 8.0

Installation

Add this line to your application's Gemfile:

gem 'simple_mysql_partitioning', '~> 2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_mysql_partitioning

Usage

class DailyReport < ActiveRecord::Base
  include SimpleMySQLPartitioning

  # arg1: column
  # type: partitiong type
  partitioning_by :day, type: :range
end


# partition name, less than value
pairs_name_with_values = [
  ['p201808', '2018-09-01']
]

# create partition
DailyReport.partition.create(pairs_name_with_values)

NOTE: No support MAXVALUE, please use add method after created partition.

# add partition
DailyReport.partition.add(pairs_name_with_values)

# reorganize partition
# If you want to reorganize partition, use this method and set reorganize partition name to second arg.
# Reorganize partitiong default value is 'MAXVALUE'.
DailyReport.partition.reorganize(pairs_name_with_values, 'p999999', 'MAXVALUE')

# drop
DailyReport.partition.drop('p201808')

# exists?
DailyReport.partition.exists?('p201808')

We support only range partitioning.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

How to test for local

BUNDLE_GEMFILE=gemfiles/Gemfile.rails-** bundle exec rspec
ex) BUNDLE_GEMFILE=gemfiles/Gemfile.rails-7.0 bundle exec rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Andryu/simple_mysql_partitioning.