5289c4df3b
- made api.py, cfgparse.py, exceptions.py, genmodel.py, migrate_repository.py, and pathed.py PEP-8 clean - add tools.rst documenting the usage of migrate_repository.py - add more modules to api.rst - reference tools.rst from index.rst
114 lines
3.4 KiB
ReStructuredText
114 lines
3.4 KiB
ReStructuredText
*****************
|
|
API Documentation
|
|
*****************
|
|
|
|
Module :mod:`migrate.changeset`
|
|
===============================
|
|
|
|
.. automodule:: migrate.changeset
|
|
:members:
|
|
:synopsis: Database changeset management
|
|
|
|
Module :mod:`ansisql <migrate.changeset.ansisql>`
|
|
-------------------------------------------------
|
|
|
|
.. automodule:: migrate.changeset.ansisql
|
|
:members:
|
|
:synopsis: Standard SQL implementation for altering database schemas
|
|
|
|
Module :mod:`constraint <migrate.changeset.constraint>`
|
|
-------------------------------------------------------
|
|
|
|
.. automodule:: migrate.changeset.constraint
|
|
:members:
|
|
:synopsis: Standalone schema constraint objects
|
|
|
|
Module :mod:`databases <migrate.changeset.databases>`
|
|
-----------------------------------------------------
|
|
|
|
.. automodule:: migrate.changeset.databases
|
|
:members:
|
|
:synopsis: Database specific changeset implementations
|
|
|
|
Module :mod:`mysql <migrate.changeset.databases.mysql>`
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. automodule:: migrate.changeset.databases.mysql
|
|
:members:
|
|
:synopsis: MySQL database specific changeset implementations
|
|
|
|
Module :mod:`oracle <migrate.changeset.databases.oracle>`
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. automodule:: migrate.changeset.databases.oracle
|
|
:members:
|
|
:synopsis: Oracle database specific changeset implementations
|
|
|
|
Module :mod:`postgres <migrate.changeset.databases.postgres>`
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. automodule:: migrate.changeset.databases.postgres
|
|
:members:
|
|
:synopsis: PostgreSQL database specific changeset implementations
|
|
|
|
Module :mod:`sqlite <migrate.changeset.databases.slite>`
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. automodule:: migrate.changeset.databases.sqlite
|
|
:members:
|
|
:synopsis: SQLite database specific changeset implementations
|
|
|
|
Module :mod:`visitor <migrate.changeset.databases.visitor>`
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. automodule:: migrate.changeset.databases.visitor
|
|
:members:
|
|
|
|
Module :mod:`exceptions <migrate.changeset.exceptions>`
|
|
-------------------------------------------------------
|
|
|
|
.. automodule:: migrate.changeset.exceptions
|
|
:members:
|
|
:synopsis: Changeset exception classes
|
|
|
|
Module :mod:`schema <migrate.changeset.schema>`
|
|
-----------------------------------------------
|
|
|
|
.. automodule:: migrate.changeset.schema
|
|
:members:
|
|
:synopsis: Schema changeset handling functions
|
|
|
|
Module :mod:`migrate.versioning`
|
|
================================
|
|
|
|
.. automodule:: migrate.versioning
|
|
:members:
|
|
:synopsis: Database version and repository management
|
|
|
|
Module :mod:`api <migrate.versioning.api>`
|
|
------------------------------------------
|
|
|
|
.. automodule:: migrate.versioning.api
|
|
:synopsis: External API for :mod:`migrate.versioning`
|
|
|
|
Module :mod:`exceptions <migrate.versioning.exceptions>`
|
|
--------------------------------------------------------
|
|
|
|
.. automodule:: migrate.versioning.exceptions
|
|
:members:
|
|
:synopsis: Exception classes for :mod:`migrate.versioning`
|
|
|
|
Module :mod:`genmodel <migrate.versioning.genmodel>`
|
|
----------------------------------------------------
|
|
|
|
.. automodule:: migrate.versioning.genmodel
|
|
:members:
|
|
:synopsis: Python database model generator and differencer
|
|
|
|
Module :mod:`pathed <migrate.versioning.pathed>`
|
|
------------------------------------------------
|
|
|
|
.. automodule:: migrate.versioning.pathed
|
|
:members:
|
|
:synopsis: File/Directory handling class
|