Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 2.97 KB

database.md

File metadata and controls

87 lines (67 loc) · 2.97 KB
Raw

OpenSIPS CLI - Database module

Module used to manipulate the database used by OpenSIPS.

Commands

This module exports the following commands:

  • create - creates a new database. Can receive an optional parameter, specifying the name of the database to be created. This command also deploys the standard OpenSIPS table, as well as other standard tables
  • drop - drops a database. Can receive an optional parameter, specifying which database to delete.
  • add - adds a new module's tables in an existing database. Receives as parameter the name of the module, as specified in the OpenSIPS scripts hierarchy.
  • migrate - copy and convert an OpenSIPS 2.4 database into its OpenSIPS 3.0 equivalent

Configuration

The parameters from this tool can be either provisioned in the configuration file, either prompted for during runtime. If a parameter is specified in the configuration file, you will not be prompted for it!

These are the parameters that can be specified in the config file:

  • database_path - the directory to the OpenSIPS DB scripts, usually the scripts/ directory in the OpenSIPS source tree, or /usr/share/opensips/
  • database_url - an URL to the database, containing schema, username, password, host and port. Example: mysql://user:password@host
  • database_name - the name of the database to create, drop, or add modules to
  • database_modules - a space-separated list of the modules tables that need to be deployed by the create command. Defaults are: acc alias_db auth_db avpops clusterer dialog dialplan dispatcher domain drouting group load_balancer msilo permissions rtpproxy rtpengine speeddial tls_mgm usrloc
  • database_force_drop - indicates whether the drop command should drop the database without prompting the user

Examples

Consider the following configuration file:

[default]
database_url=mysql://root@localhost
database_name=opensips
database_modules=dialog usrloc

The following command will create the opensips table, containing only the version, dialog and location tables (according to the database_modules parameter):

opensips-cli -x database create

If we want to add a new module, let's say rtpproxy, we have to run:

opensips-cli -x database add rtpproxy

The command above will create the rtpproxy_sockets table.

A drop command will prompt the user whether he really wants to drop the database or not:

$ opensips-cli -x database drop
Do you really want to drop the 'opensips_cli' database [Y/n] (Default is n): n

But setting the database_force_drop parameter will drop it without asking:

opensips-cli -o database_force_drop=true -x database drop

Dependencies

Limitations

This module can only manipulate database backends that are supported by the SQLAlchemy project, such as SQLite, Postgresql, MySQL, Oracle, MS-SQL.