logger.conf.sample: add missing comment mark
[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  * `queue_log` - Table used for Asterisk to store Queue Log records
15  * `voicemail` - Tables used for `ODBC_STOARGE` of voicemail messages
16
17 Alembic uses SQLAlchemy, which has support for
18 [many databases](http://docs.sqlalchemy.org/en/rel_0_8/dialects/index.html).
19
20 IMPORTANT NOTE: This is brand new and the initial migrations are still subject
21 to change.  Only use this for testing purposes for now.
22
23 Example Usage
24 -------------
25
26 First, create an ini file that contains database connection details.  For help
27 with connection string details, see the
28 [SQLAlchemy docs](http://docs.sqlalchemy.org/en/rel_0_8/core/engines.html#database-urls).
29
30     $ cp config.ini.sample config.ini
31     ... edit config.ini and change sqlalchemy.url ...
32
33 Next, bring the database up to date with the current schema.
34
35     $ alembic -c config.ini upgrade head
36
37 In the future, as additional database migrations are added, you can run
38 alembic again to migrate the existing tables to the latest schema.
39
40     $ alembic -c config.ini upgrade head
41
42 The migrations support both upgrading and downgrading.  You could go all the
43 way back to where you started with no tables by downgrading back to the base
44 revision.
45
46     $ alembic -c config.ini downgrade base
47
48 `base` and `head` are special revisions.  You can refer to specific revisions
49 to upgrade or downgrade to, as well.
50
51     $ alembic -c config.ini upgrade 4da0c5f79a9c
52
53 Offline Mode
54 ------------
55
56 If you would like to just generate the SQL statements that would have been
57 executed, you can use alembic's offline mode.
58
59     $ alembic -c config.ini upgrade head --sql
60
61 Adding Database Migrations
62 --------------------------
63
64 The best way to learn about how to add additional database migrations is to
65 refer to the [Alembic documentation](http://alembic.readthedocs.org).