Laravel Partitions for Migrations
This package extends Illuminate to provide partitioned table creation in migrations for PostgreSQL. Support for other DMBS's will be added soon.
ORPTech
We are ORPTech. Here at ORPTech, we pride ourselves in ensuring that clients and services have a peaceful, safe and smooth interaction. We know how difficult it is to build trust for a service, therefore we are here to help bridge the gaps within the market via our robust applications. Please contact us for further information on how our services might protect your business.
Installation
You can install the package via composer:
composer require orptech/laravel-migration-partition
DBMS Support
- PostgreSQL
Planned Development
- MySQL
- MariaDB
- SQL Server 2017+
- SQLite 3.8.8+
Usage
This package currently, only supports PostgreSQL.
PostgreSQL
PostgreSQL also known as Postgres, is a free and open-source relational database management system (RDBMS) emphasizing extensibility and SQL compliance.
Range Partitioning
Instead of importing Illuminate's Schema import this package's schema:
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
Template Usage
Range Partition
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createRangePartitioned('[YourTableNameHere]', function (Blueprint $table) {
//...
}, '[compositeKeyOne]', '[compositeKeyTwo]', '[rangePartitionKey]');
Creating a Range Partition for a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createRangePartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[startDate]', '[endDate]');
Attaching a Range Partition to a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachRangePartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[startDate]', '[endDate]');
List Partition
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createListPartitioned('[YourTableNameHere]', function (Blueprint $table) {
//...
}, '[compositeKeyOne]', '[compositeKeyTwo]', '[listPartitionKey]');
Creating a List Partition for a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createListPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[listPartitionValue]');
Attaching a List Partition to a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachListPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[listPartitionValue]');
Hash Partition
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createHashPartitioned('[YourTableNameHere]', function (Blueprint $table) {
//...
}, '[compositeKeyOne]', '[compositeKeyTwo]', '[hashPartitionKey]');
Creating a Hash Partition for a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::createHashPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[hashModulus]', '[hashRemainder]');
Attaching a Hash Partition to a Partitioned Table
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachHashPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[hashModulus]', '[hashRemainder]');
Removing a Partition
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::detachPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[partitionTableName]');
Commands
New Series of Range Partition Migrations
This command will create a new series of migrations for all range partitioned tables.
php artisan partition:range
New Series of List Partition Migrations
This command will create a new series of migrations for all list partitioned tables.
php artisan partition:list
New Series of Hash Partition Migrations
This command will create a new series of migrations for all hash partitioned tables.
php artisan partition:hash
Listing Partitions
This command will list all the partitioned tables.
php artisan partition:partitions
Important
- This package currently supports PostgreSQL Range Partitions.
- You shouldn't define any primary keys in your migration. The package creates a composite key while setting up the table.
- You need to create an initial partition to start using the tables. (PostgreSQL)
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
0 Apr 4, 2022
2 Dec 7, 2021
17 Dec 14, 2022
4 Mar 11, 2022
23 Jul 9, 2022
48 Nov 25, 2022
2 Oct 13, 2022
15 Nov 29, 2022
2 Jan 9, 2022
62 Jan 26, 2022
89 Jun 17, 2022
1.5k Dec 28, 2022
51 Dec 11, 2022
9 Nov 29, 2022
618 Dec 28, 2022
3.6k Dec 30, 2022
38 Nov 11, 2022
197 Dec 30, 2022