summaryrefslogtreecommitdiff
path: root/doc/plugin-schema-migrations.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2017-01-29 11:07:42 -0500
committerFrederic Guillot <fred@kanboard.net>2017-01-29 11:07:42 -0500
commit0371acff89b14b9bdcb03e72fd9637e26e6b517c (patch)
treef5878c9c07705379d137843cb8f92e3cdf7c20a8 /doc/plugin-schema-migrations.markdown
parent3bf4789be255650b64f42231f41383cb13b65572 (diff)
Move English documentation to folder en_US
Diffstat (limited to 'doc/plugin-schema-migrations.markdown')
-rw-r--r--doc/plugin-schema-migrations.markdown39
1 files changed, 0 insertions, 39 deletions
diff --git a/doc/plugin-schema-migrations.markdown b/doc/plugin-schema-migrations.markdown
deleted file mode 100644
index 36a57f37..00000000
--- a/doc/plugin-schema-migrations.markdown
+++ /dev/null
@@ -1,39 +0,0 @@
-Plugin Schema Migrations
-========================
-
-Kanboard executes database migrations automatically for you.
-Migrations must be stored in a folder **Schema** and the filename must be the same as the database driver:
-
-```bash
-Schema
-├── Mysql.php
-├── Postgres.php
-└── Sqlite.php
-```
-
-Each file contains all migrations, here an example for Sqlite:
-
-```php
-<?php
-
-namespace Kanboard\Plugin\Something\Schema;
-
-const VERSION = 1;
-
-function version_1($pdo)
-{
- $pdo->exec('CREATE TABLE IF NOT EXISTS something (
- "id" INTEGER PRIMARY KEY,
- "project_id" INTEGER NOT NULL,
- "something" TEXT,
- FOREIGN KEY(project_id) REFERENCES projects(id) ON DELETE CASCADE
- )');
-}
-```
-
-- The constant `VERSION` is the last version of your schema
-- Each function is a migration `version_1()`, `version_2()`, etc.
-- A `PDO` instance is passed as first argument
-- Everything is executed inside a transaction, if something doesn't work a rollback is performed and the error is displayed to the user
-
-Kanboard will compare the version defined in your schema and the version stored in the database. If the versions are different, Kanboard will execute one by one each migration until to reach the last version.