install_prereq: Download latest Jansson.
[asterisk/asterisk.git] / contrib / ast-db-manage / README.md
1 Asterisk Database Manager
2 =========================
3
4 Asterisk includes optional database integration for a variety of features.
5 The purpose of this effort is to assist in managing the database schema
6 for Asterisk database integration.
7
8 This is implemented as a set of repositories that contain database schema
9 migrations, using [Alembic](http://alembic.readthedocs.org).  The existing
10 repositories include:
11
12  * `cdr` - Table used for Asterisk to store CDR records
13  * `config` - Tables used for Asterisk realtime configuration
14  * `voicemail` - Tables used for `ODBC_STOARGE` of voicemail messages
15
16 Alembic uses SQLAlchemy, which has support for
17 [many databases](http://docs.sqlalchemy.org/en/rel_0_8/dialects/index.html).
18
19 IMPORTANT NOTE: This is brand new and the initial migrations are still subject
20 to change.  Only use this for testing purposes for now.
21
22 Example Usage
23 -------------
24
25 First, create an ini file that contains database connection details.  For help
26 with connection string details, see the
27 [SQLAlchemy docs](http://docs.sqlalchemy.org/en/rel_0_8/core/engines.html#database-urls).
28
29     $ cp config.ini.sample config.ini
30     ... edit config.ini and change sqlalchemy.url ...
31
32 Next, bring the database up to date with the current schema.
33
34     $ alembic -c config.ini upgrade head
35
36 In the future, as additional database migrations are added, you can run
37 alembic again to migrate the existing tables to the latest schema.
38
39     $ alembic -c config.ini upgrade head
40
41 The migrations support both upgrading and downgrading.  You could go all the
42 way back to where you started with no tables by downgrading back to the base
43 revision.
44
45     $ alembic -c config.ini downgrade base
46
47 `base` and `head` are special revisions.  You can refer to specific revisions
48 to upgrade or downgrade to, as well.
49
50     $ alembic -c config.ini upgrade 4da0c5f79a9c
51
52 Offline Mode
53 ------------
54
55 If you would like to just generate the SQL statements that would have been
56 executed, you can use alembic's offline mode.
57
58     $ alembic -c config.ini upgrade head --sql
59
60 Adding Database Migrations
61 --------------------------
62
63 The best way to learn about how to add additional database migrations is to
64 refer to the [Alembic documentation](http://alembic.readthedocs.org).