schema-keeper / schema-keeper
Database development kit for PostgreSQL
Installs: 5 797
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 2
Forks: 1
Open Issues: 2
Requires
- php: >=5.6
- ext-json: *
- ext-pdo: *
- ext-pdo_pgsql: *
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^5.0||^6.0||^7.0||^8.0
- squizlabs/php_codesniffer: ^3.0
Suggests
README
Track a structure of your PostgreSQL database in a VCS using SchemaKeeper.
SchemaKeeper provides 3 functions:
save
— saves a database structure as separate text files to a specified directoryverify
— detects changes between an actual database structure and the saved onedeploy
— deploys stored procedures to a database from the saved structure
SchemaKeeper allows to use gitflow
principles for a database development. Each branch contains its own database structure dump, and when branches are merged, dumps are merged too.
Table of contents
Installation
If you choose the installation via Composer or PHAR, please, install psql app on machines where SchemaKeeper will be used. A Docker build includes pre-installed psql.
Composer
$ composer require schema-keeper/schema-keeper
PHAR
$ wget https://github.com/dmytro-demchyna/schema-keeper/releases/latest/download/schemakeeper.phar
Docker
$ docker pull dmytrodemchyna/schema-keeper
Basic Usage
Create a config.php
file:
<?php use SchemaKeeper\Provider\PostgreSQL\PSQLParameters; // Connection parameters $params = new PSQLParameters('localhost', 5432, 'dbname', 'username', 'password'); // These schemas will be ignored $params->setSkippedSchemas(['information_schema', 'pg_%']); // These extensions will be ignored $params->setSkippedExtensions(['pgtap']); // The path to psql executable $params->setExecutable('/bin/psql'); return $params;
Now you can use the schemakeeper
binary. It returns exit-code 0
on success and exit-code 1
on failure.
save
$ schemakeeper -c config.php -d /project_path/db_name save
The command above saves a database structure to a /project_path/db_name
directory.
- /project_path/db_name:
- structure:
- public:
- functions:
- func1(int8).sql
- materialized_views:
- mat_view1.txt
- sequences:
- sequence1.txt
- tables:
- table1.txt
- triggers:
- trigger1.sql
- types:
- type1.txt
- views:
- view1.txt
- functions:
- schema2:
- views:
- view2.txt
- views:
- ...
- public:
- extensions:
- plpgsql.txt
- structure:
Examples of conversion database structure to files:
The file path stores information about a type, a scheme and a name of a object. This approach makes an easier navigation through the database structure, as well as code review of changes in VCS.
verify
$ schemakeeper -c config.php -d /project_path/db_name verify
The command above compares an actual database structure with the previously saved in /project_path/db_name
one and displays an information about changed objects.
If changes exists, the verify
will returns an exit-code 1
.
An alternative way to find changes is to call the save
again, specifying the same directory /project_path/db_name
, and check changes in the VCS. Since objects from the database are stored in separate files, the VCS will show only changed objects. A main disadvantage of this way — a need to overwrite files.
deploy
$ schemakeeper -c config.php -d /project_path/db_name deploy
The command above deploys stored procedures from the /project_path/db_name
to the actual database.
You can edit a source code of stored procedures in the same way as a rest of an application source code. Modification of a stored procedure occurs by making changes to the corresponding file in the /project_path/db_name
directory, which is automatically reflected in the VCS.
For example, to create a new stored procedure in the public
schema, just create a new file with a .sql
extension in the /project_path/db_name/structure/public/functions
directory, place a source code of the stored procedure into it, including a CREATE OR REPLACE FUNCTION
block, then call the deploy
. Similarly occur modifying or removal of stored procedures. Thus, the code simultaneously enters both the VCS and the database.
The deploy
changes parameters of a function or a return type without additional actions, while with a classical approach it would be necessary to first perform DROP FUNCTION
, and only then CREATE OR REPLACE FUNCTION
.
Unfortunately, in some situations deploy
is not able to automatically apply changes. For example, if you try to delete a trigger function, that is used by at least one trigger. Such situations must be solved manually using migration files.
The deploy
transfers changes only from stored procedures. To transfer other changes, please, use migration files (for example, doctrine/migrations).
Migrations must be applied before the deploy
to resolve possible problem situations.
The
deploy
is designed to work with stored procedures written in PL/pgSQL. Using with other languages may be less effective or impossible.
Extended usage
You can inject SchemaKeeper to your own code.
<?php use SchemaKeeper\Keeper; use SchemaKeeper\Provider\PostgreSQL\PSQLParameters; $host = 'localhost'; $port = 5432; $dbName = 'dbname'; $user = 'username'; $password = 'password'; $dsn = 'pgsql:dbname=' . $dbName . ';host=' . $host.';port='.$port; $conn = new PDO($dsn, $user, $password, [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION]); $params = new PSQLParameters($host, $port, $dbName, $user, $password); $keeper = new Keeper($conn, $params);
<?php $keeper->saveDump('path_to_dump'); $keeper->verifyDump('path_to_dump'); $keeper->deployDump('path_to_dump');
PHPUnit
You can wrap verifyDump
into a PHPUnit test:
<?php class SchemaTest extends \PHPUnit\Framework\TestCase { function testOk() { // Initialize $keeper here... try { $keeper->verifyDump('/path_to_dump'); } catch (\SchemaKeeper\Exception\NotEquals $e) { $expectedFormatted = print_r($e->getExpected(), true); $actualFormatted = print_r($e->getActual(), true); // assertEquals will show the detailed diff between the saved dump and actual database self::assertEquals($expectedFormatted, $actualFormatted); } } }
Custom transaction block
You can wrap deployDump
into a custom transaction block:
<?php // Initialize $conn and $dbParams here... $keeper = new \SchemaKeeper\Keeper($conn, $dbParams); $conn->beginTransaction(); try { $result = $keeper->deployDump('/path_to_dump'); // $result->getDeleted() - these functions were deleted from the current database // $result->getCreated() - these functions were created in the current database // $result->getChanged() - these functions were changed in the current database $conn->commit(); } catch (\Exception $e) { $conn->rollBack(); }
Workflow recommendations
Safe deploy to a production
A dump of a database structure saved in a VCS allows you to check a production database for exact match to a required structure. This ensures that only intended changes were transferred to the production-DB by deploy.
Since the PostgreSQL DDL is transactional, the following deployment order is recommended:
- Start transaction
- Apply all migrations in the transaction
- In the same transaction, perform
deployDump
- Perform
verifyDump
. If there are no errors, executeCOMMIT
. If there are errors, executeROLLBACK
Conflicts resolving
A possible conflict situation: branch1 and branch2 are branched from develop. They haven't conflict with develop, but have conflict with each other. A goal is to merge branch1 and branch2 into develop.
First, merge branch1 into develop, then merge develop into branch2, resolve conflicts in branch2, and then merge branch2 into develop. At the stage of conflict resolution inside branch2, you may have to correct a migration file in branch2 to match the final dump that contains merge results.
Extra links
If you are not satisfied with SchemaKeeper, look at the list of another tools: https://wiki.postgresql.org/wiki/Change_management_tools_and_techniques
Contributing
Any contributions are welcome.
Please refer to CONTRIBUTING.md for information on how to contribute to SchemaKeeper.