Pithos alembic migration wrapper tool
[pithos] / snf-pithos-backend / pithos / backends / migrate.py
1 # Copyright 2011-2012 GRNET S.A. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
5 # conditions are met:
6 #
7 #   1. Redistributions of source code must retain the above
8 #      copyright notice, this list of conditions and the following
9 #      disclaimer.
10 #
11 #   2. Redistributions in binary form must reproduce the above
12 #      copyright notice, this list of conditions and the following
13 #      disclaimer in the documentation and/or other materials
14 #      provided with the distribution.
15 #
16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
28 #
29 # The views and conclusions contained in the software and
30 # documentation are those of the authors and should not be
31 # interpreted as representing official policies, either expressed
32 # or implied, of GRNET S.A.
33
34 """
35 Alembic migration wrapper for pithos backend database.
36
37 - Locate alembic.ini in backends/lib/sqlalchemy package and pass it
38   as parameter to alembic
39
40 e.g::
41
42     $ pithos-migrate upgrade head
43
44 """
45
46 import sys
47 import os
48
49 from alembic.config import main as alembic_main
50 from pithos.backends.lib import sqlalchemy as sqlalchemy_backend
51
52 DEFAULT_ALEMBIC_INI_PATH = os.path.join(
53         os.path.abspath(os.path.dirname(sqlalchemy_backend.__file__)),
54         'alembic.ini')
55
56 def main(argv=None, **kwargs):
57     if not argv:
58         argv = sys.argv
59
60     # clean up args
61     argv.pop(0)
62
63     # default config arg, if not already set
64     if not '-c' in argv:
65         argv.insert(0, DEFAULT_ALEMBIC_INI_PATH)
66         argv.insert(0, '-c')
67
68
69     alembic_main(argv, **kwargs)
70 if __name__ == '__main__':
71     import sys
72     main(sys.argv)
73