mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 04:11:08 +00:00

Files

Ben Ford 64279e5992 alembic: Fix errors during upgrade head.

When trying to upgrade using alembic, a couple different errors kept
popping up that prevented the upgrade. An additional parameter was
needed when changing the schema for mwi_subscribe_replaces_unsolicited
from an integer to an enum. When changing from a string to an enum, the
type needed to be cast for postgresql. The other issue was a parameter
being used during column creation that did not exist.

After fixing the upgrade process, it revealed errors with the downgrade
process. One was a variable not being defined in the downgrade function,
and the other was tables not existing when using MySQL. This was due to
a context check that should have encompassed MySQL, but in the end was
not doing so.

Change-Id: Ib4d70cf3ce5080023a50be496272a777b55d6c8e

2019-03-28 08:17:50 -06:00

cdr

Remove as much trailing whitespace as possible.

2017-12-22 09:23:22 -05:00

config

alembic: Fix errors during upgrade head.

2019-03-28 08:17:50 -06:00

voicemail

Remove as much trailing whitespace as possible.

2017-12-22 09:23:22 -05:00

cdr.ini.sample

alembic: Adjust sippeers, queue_members, and voicemail_messages tables.

2014-08-06 17:04:08 +00:00

config.ini.sample

alembic: Adjust sippeers, queue_members, and voicemail_messages tables.

2014-08-06 17:04:08 +00:00

env.py

Remove as much trailing whitespace as possible.

2017-12-22 09:23:22 -05:00

README.md

Add text of cdr directory into README.md for ast-db-manage

2016-09-30 18:32:19 -03:00

voicemail.ini.sample

alembic: Adjust sippeers, queue_members, and voicemail_messages tables.

2014-08-06 17:04:08 +00:00

README.md

Asterisk Database Manager

Asterisk includes optional database integration for a variety of features. The purpose of this effort is to assist in managing the database schema for Asterisk database integration.

This is implemented as a set of repositories that contain database schema migrations, using Alembic. The existing repositories include:

cdr - Table used for Asterisk to store CDR records
config - Tables used for Asterisk realtime configuration
voicemail - Tables used for ODBC_STOARGE of voicemail messages

Alembic uses SQLAlchemy, which has support for many databases.

IMPORTANT NOTE: This is brand new and the initial migrations are still subject to change. Only use this for testing purposes for now.

Example Usage

First, create an ini file that contains database connection details. For help with connection string details, see the SQLAlchemy docs.

$ cp config.ini.sample config.ini
... edit config.ini and change sqlalchemy.url ...

Next, bring the database up to date with the current schema.

$ alembic -c config.ini upgrade head

In the future, as additional database migrations are added, you can run alembic again to migrate the existing tables to the latest schema.

$ alembic -c config.ini upgrade head

The migrations support both upgrading and downgrading. You could go all the way back to where you started with no tables by downgrading back to the base revision.

$ alembic -c config.ini downgrade base

base and head are special revisions. You can refer to specific revisions to upgrade or downgrade to, as well.

$ alembic -c config.ini upgrade 4da0c5f79a9c

Offline Mode

If you would like to just generate the SQL statements that would have been executed, you can use alembic's offline mode.

$ alembic -c config.ini upgrade head --sql

Adding Database Migrations

The best way to learn about how to add additional database migrations is to refer to the Alembic documentation.