Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orptech-com/laravel-migration-partition
This package extends Illuminate to enable partitioned table creation within Laravel migrations.
https://github.com/orptech-com/laravel-migration-partition
laravel laravel-framework laravel-package mysql partition partitioning postgres postgresql
Last synced: 4 days ago
JSON representation
This package extends Illuminate to enable partitioned table creation within Laravel migrations.
- Host: GitHub
- URL: https://github.com/orptech-com/laravel-migration-partition
- Owner: orptech-com
- License: mit
- Created: 2022-10-06T08:45:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-08T11:06:35.000Z (4 months ago)
- Last Synced: 2024-06-09T22:06:04.675Z (4 months ago)
- Topics: laravel, laravel-framework, laravel-package, mysql, partition, partitioning, postgres, postgresql
- Language: PHP
- Homepage: https://orptech-com.github.io/laravel-migration-partition/
- Size: 75.2 KB
- Stars: 20
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Database Partitions via Migrations for Laravel (aka Laravel Migration Partitions)
This package extends Illuminate to provide partitioned table creation in migrations for PostgreSQL. Support for other DMBS's will be added soon.
[](https://packagist.org/packages/orptech/laravel-migration-partition)
[](https://packagist.org/packages/orptech/laravel-migration-partition)
## ORPtech Software
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 help your business.
## Installation
You can install the package via composer:
```bash
composer require orptech/laravel-migration-partition
```
## DBMS Support
- PostgreSQL
### Planned Development
- MySQL - Looking for Contributors
- MariaDB - Looking for Contributors
- 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:
```php
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
```
## Template Usage
### Range Partition
```php
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
```php
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
```php
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachRangePartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[startDate]', '[endDate]');
```
### List Partition
```php
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
```php
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
```php
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachListPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[listPartitionValue]');
```
### Hash Partition
```php
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
```php
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
```php
use ORPTech\MigrationPartition\Database\Schema\Blueprint;
use ORPTech\MigrationPartition\Support\Facades\Schema;
Schema::attachHashPartition('[YourPartitionedTableNameHere]', function (Blueprint $table) {}, '[suffixForPartition]', '[hashModulus]', '[hashRemainder]');
```
#### Removing a Partition
```php
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.
```bash
php artisan partition:range
```
##### New Series of List Partition Migrations
This command will create a new series of migrations for all list partitioned tables.
```bash
php artisan partition:list
```
##### New Series of Hash Partition Migrations
This command will create a new series of migrations for all hash partitioned tables.
```bash
php artisan partition:hash
```
##### Listing Partitions
This command will list all the partitioned tables.
```bash
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [ORPtech](https://github.com/orptech-com)
- [Retrocket](https://github.com/retrocket)
- [Laravel](https://github.com/laravel)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.