History

Richard Mudgett 8494e78010 res_pjsip: Split type=identify to IP address and SIP header matching priorities The type=identify endpoint identification method can match by IP address and by SIP header. However, the SIP header matching has limited usefulness because you cannot specify the SIP header matching priority relative to the IP address matching. All the matching happens at the same priority and the order of evaluating the identify sections is indeterminate. e.g., If you had two type=identify sections where one matches by IP address for endpoint alice and the other matches by SIP header for endpoint bob then you couldn't predict which endpoint is matched when a request comes in that matches both. * Extract the SIP header matching criteria into its own "header" endpoint identification method so the user can specify the relative priority of the SIP header and the IP address matching criteria in the global endpoint_identifier_order option. The "ip" endpoint identification method now only matches by IP address. ASTERISK-27491 Change-Id: I9df142a575b7e1e3471b7cda5d3ea156cef08095		2018-01-16 12:50:34 -06:00
..
cdr	Remove as much trailing whitespace as possible.	2017-12-22 09:23:22 -05:00
config	res_pjsip: Split type=identify to IP address and SIP header matching priorities	2018-01-16 12:50:34 -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.