PHPackages                             peehaa/migres - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. peehaa/migres

ActiveProject[Database & ORM](/categories/database)

peehaa/migres
=============

Postgresql migration tool

v0.2.0(6y ago)1713[7 issues](https://github.com/PeeHaa/migres/issues)[1 PRs](https://github.com/PeeHaa/migres/pulls)MITPHPPHP ^7.4

Since Jul 30Pushed 6y ago2 watchersCompare

[ Source](https://github.com/PeeHaa/migres)[ Packagist](https://packagist.org/packages/peehaa/migres)[ RSS](/packages/peehaa-migres/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (3)Dependencies (6)Versions (5)Used By (0)

Migres
======

[](#migres)

The PostgreSQL migration tool

[![Latest Stable Version](https://camo.githubusercontent.com/815d9f0b728005d4921cb6bbb49b5e8962d3cf75597920e19ddf029b478a8fc6/68747470733a2f2f706f7365722e707567782e6f72672f7065656861612f6d69677265732f762f737461626c65)](https://packagist.org/packages/peehaa/migres)[![Build Status](https://camo.githubusercontent.com/1d558a2e1f1f12119e0adf4bc62b96598c3dac4153df4b19bf0a7d80cb101dad/68747470733a2f2f7472617669732d63692e6f72672f5065654861612f6d69677265732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/PeeHaa/migres)[![Build status](https://camo.githubusercontent.com/9233515c4cba91c6caf0ff24a2110a8aac97e6246219a6b3d9de22f827fc9ff6/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f7635786276616874316f7665793775682f6272616e63682f6d61737465723f7376673d74727565)](https://ci.appveyor.com/project/PeeHaa/migres/branch/master)[![Coverage Status](https://camo.githubusercontent.com/0bdd65530b6804a2c33d05c8d81c9739cfc9c80a68390295cbf0236b49a90525/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f5065654861612f6d69677265732f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/PeeHaa/migres?branch=master)[![License](https://camo.githubusercontent.com/899979ab5e3a6c175fb08fde45c8b28b3fa42fe26e4fd9e16ca4ceca695df705/68747470733a2f2f706f7365722e707567782e6f72672f7065656861612f6d69677265732f6c6963656e7365)](https://packagist.org/packages/peehaa/migres)

Requirements
------------

[](#requirements)

- PHP 7.4
- PostgreSQL 9.5

Usage
-----

[](#usage)

Note: this is alpha software. Do not use in production (yet). I would appreciate if you could test it and provide feedback in [GitHub issues](https://github.com/PeeHaa/migres/issues/new). <3

***Warning: never allow untrusted input in table specifications as all migrations are translated to raw SQL!***

- Add the project using composer `composer install peehaa/migres`
- Run the setup `./vendor/bin/migres setup`
- Run without arguments to view the available commands `./vendor/bin/migres`

All native PostgreSQL data types are implemented and the list can be found at:

### TOC

[](#toc)

- [Creating a table](#creating-a-table)
- [Renaming a table](#renaming-a-table)
- [Dropping a table](#dropping-a-table)
- [Table methods](#table-methods)
    - [addColumn](#tableaddcolumnstring-name-migresdatatypetype-datatype)
    - [dropColumn](#tabledropcolumnstring-name)
    - [renameColumn](#tablerenamecolumnstring-oldname-string-newname)
    - [changeColumn](#tablechangecolumnstring-name-migresdatatypetype-datatype)
    - [primaryKey](#tableprimarykeystring-column-string-columns)
    - [namedPrimaryKey](#tablenamedprimarykeystring-name-string-column-string-columns)
    - [dropPrimaryKey](#tabledropprimarykeystring-name)
    - [renamePrimaryKey](#tablerenameprimarykeystring-oldname-string-newname)
    - [addUniqueConstraint](#tableadduniqueconstraintstring-constraintname-string-column-string-columns)
    - [dropUniqueConstraint](#tabledropuniqueconstraintstring-constraintname)
    - [addIndex](#tableaddindexstring-indexname-string-column-string-columns)
    - [addBtreeIndex](#tableaddbtreeindexstring-indexname-string-column-string-columns)
    - [addHashIndex](#tableaddhashindexstring-indexname-string-column-string-columns)
    - [addGistIndex](#tableaddgistindexstring-indexname-string-column-string-columns)
    - [addGinIndex](#tableaddginindexstring-indexname-string-column-string-columns)
    - [dropIndex](#tabledropindexstring-indexname)
    - [addCheck](#tableaddcheckstring-checkname-string-expression)
    - [dropCheck](#tabledropcheckstring-checkname)
- [Command line](#command-line)
    - [Setup](#setup)
    - [Create new migration](#create-new-migration)
    - [Run migrations](#run-migrations)
    - [Run rollbacks](#run-rollbacks)

### Creating a table

[](#creating-a-table)

```