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

Documentation for adding named foreign keys #1020

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/migrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1187,6 +1187,36 @@ This allows us to establish a foreign key relationship to a table which uses a c
}
}

We can add named foreign keys using the ``constraint`` parameter. This feature is supported as of Phinx version 0.6.5

.. code-block:: php

<?php

use Phinx\Migration\AbstractMigration;

class MyNewMigration extends AbstractMigration
{
/**
* Migrate Up.
*/
public function up()
{
$table = $this->table('your_table');
$table->addForeignKey('foreign_id', 'reference_table', array('id'),
array('constraint'=>'your_foreign_key_name'));
->save();
}

/**
* Migrate Down.
*/
public function down()
{

}
}

We can also easily check if a foreign key exists:

.. code-block:: php
Expand Down