this section discusses the internal API of Alembic as regards internal configuration constructs. This section is only useful for developers who wish to extend the capabilities of Alembic. For documentation on configuration of an Alembic environment, please see Tutorial.

The Config object represents the configuration passed to the Alembic environment. From an API usage perspective, it is needed for the following use cases:

  • to create a ScriptDirectory, which allows you to work with the actual script files in a migration environment
  • to create an EnvironmentContext, which allows you to actually run the module within the migration environment
  • to programatically run any of the commands in the Commands module.

The Config is not needed for these cases: