↓ Skip to main content
credativ-pg-migrator
credativ-pg-migrator

Get Involved

Table of Contents

credativ-pg-migrator is open source under the GPLv3 and developed in the open. Contributions are welcome, and they do not have to be code.

Report a problem
#

The most valuable contribution is a well-described failure. Legacy databases are endlessly inventive, and the conversion logic can only cover what it has seen.

Open an issue on GitHub and include:

  • the source database engine and version, and the connectivity type you used (odbc, jdbc, ddl or native);
  • the relevant part of your configuration file — with credentials removed;
  • the log output around the failure (--log-level=DEBUG gives considerably more detail);
  • for a conversion problem, the original object definition and the generated PostgreSQL code. Both are stored side by side in the migration database protocol tables, which makes them easy to extract.

Contribute code
#

Pull requests are welcome — for a new source database connector, better coverage of an existing one, or a fix for a conversion edge case.

A source database connector implements the DatabaseConnector class from the credativ_pg_migrator.database_connector module. Its methods document the expected behaviour and return values, so the class is the place to start when adding an engine. Sources are reached via ODBC, JDBC or native Python libraries — not every option is available for every engine.

The feature matrix is a good map of where the gaps are: every --, WIP and ? is work that has not been done or not been verified yet. The ? entries in particular are usually blocked on one thing — finding a test database that uses the feature realistically. If you have such a schema, that alone is a real contribution.

Improve the documentation
#

Documentation lives in the docs/ directory of the repository, next to the code. If something was unclear or missing when you ran your migration, a pull request against those files helps the next person.

Professional support
#

If you are planning a migration and want it handled rather than done yourself, credativ GmbH offers professional support for PostgreSQL and database migrations — from assessing the source system through to running the migration.

Get in touch with credativ.

Authors and license
#

credativ-pg-migrator was primarily developed and is maintained by Josef Machytka at credativ GmbH — see AUTHORS for the full list.

The project is released under the GNU General Public License, version 3 (or any later version). See COPYING for the full text.