mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
1.9 KiB
86 lines
1.9 KiB
.\" $Id$
|
|
.TH kamdbctl 8 05.02.2009 Kamailio "Kamailio"
|
|
.SH NAME
|
|
kamdbctl \- Kamailio database control tool
|
|
.SH SYNOPSIS
|
|
.B kamdbctl
|
|
.BI command
|
|
[
|
|
.BI parameters
|
|
]
|
|
|
|
.SH DESCRIPTION
|
|
.B kamdbctl
|
|
is a script to maintain the database needed by some Kamalio modules.
|
|
|
|
.SH Configuration
|
|
Before you can use
|
|
.B kamdbctl
|
|
you have to select a database engine in the kamctlrc file.
|
|
Just change the DBENGINE parameter in the respective section in kamctlrc.
|
|
.TP
|
|
Valid values are: MYSQL, PGSQL, ORACLE, DB_BERKELEY, DBTEXT.
|
|
.TP
|
|
The default is 'none'.
|
|
.TP
|
|
The username, password, database name and other settings can be configured by editing the kamctrl script.
|
|
|
|
.SH COMMANDS
|
|
.B backup <file>
|
|
Dumps the current database to a file.
|
|
.TP
|
|
.B copy <new_db>
|
|
Creates a new database from an existing one.
|
|
.TP
|
|
.B create <db name or db_path, optional>
|
|
Creates a new database with the specified name, or the default if no name is given.
|
|
.TP
|
|
.B drop <db name or db_path, optional>
|
|
Entirely deletes the database with the specified name, or the default if no name is given.
|
|
.TP
|
|
.B extra
|
|
Adds the extra tables
|
|
.TP
|
|
.B migrate <old_db> <new_db>
|
|
Migrates database tables from an old version to the actual version.
|
|
.TP
|
|
.B presence
|
|
Adds the presence related tables.
|
|
.TP
|
|
.B reinit <db name or db_path, optional>
|
|
Entirely deletes and than re-creates tables.
|
|
.TP
|
|
.B restore <file>
|
|
Restores tables from a file.
|
|
|
|
.SH NOTES
|
|
Not all databases scripts support all commands.
|
|
|
|
.SH FILES
|
|
.PD 0
|
|
.I /etc/kamailio/.kamctlrc
|
|
.br
|
|
.I /usr/local/etc/kamailio/.kamctlrc
|
|
.br
|
|
.I ~/.kamctlrc
|
|
.br
|
|
|
|
.SH AUTHORS
|
|
|
|
see
|
|
.B /usr/share/doc/kamailio/AUTHORS
|
|
|
|
.SH SEE ALSO
|
|
.BR kamailio(8),
|
|
.BR kamailio.cfg(5)
|
|
.PP
|
|
Full documentation on Kamailio is available at
|
|
.I http://www.kamailio.org/.
|
|
.PP
|
|
Mailing lists:
|
|
.nf
|
|
users@lists.kamailio.org - Kamailio user community
|
|
.nf
|
|
devel@lists.kamailio.org - Kamailio development, new features and unstable version
|
|
|