diff --git a/docs/architecture.rst b/docs/architecture.rst index 2ede51816..ea5c25773 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -3,12 +3,14 @@ The CGRateS suite consists of **four** software applications described below. .. hlist:: - :columns: 4 + :columns: 5 - cgr-engine - cgr-loader - cgr-console - cgr-tester + - cgr-migrator + CGRateS has an internal cache. @@ -499,3 +501,71 @@ Command line stress testing tool. .. hint:: # cgr-tester -runs=10000 +2.5. cgr-migrator +----------------- +Command line migration tool. + +:: + + cgrates@OCS:~$ cgr-migrator --help + Usage of cgr-migrator: + -datadb_host string + The DataDb host to connect to. (default "127.0.0.1") + -datadb_name string + The name/number of the DataDb to connect to. (default "10") + -datadb_passwd string + The DataDb user's password. + -datadb_port string + The DataDb port to bind to. (default "6379") + -datadb_type string + The type of the DataDb database (default "redis") + -datadb_user string + The DataDb user to sign in as. (default "cgrates") + -dbdata_encoding string + The encoding used to store object data in strings (default "msgpack") + -load_history_size int + Limit the number of records in the load history (default 10) + -migrate string + Fire up automatic migration <*set_versions|*cost_details|*accounts|*actions|*action_triggers|*action_plans|*shared_groups> + -old_datadb_host string + The DataDb host to connect to. (default "127.0.0.1") + -old_datadb_name string + The name/number of the DataDb to connect to. (default "10") + -old_datadb_passwd string + The DataDb user's password. + -old_datadb_port string + The DataDb port to bind to. (default "6379") + -old_datadb_type string + The type of the DataDb database + -old_datadb_user string + The DataDb user to sign in as. (default "cgrates") + -old_dbdata_encoding string + The encoding used to store object data in strings + -old_load_history_size int + Limit the number of records in the load history + -old_stordb_host string + The storDb host to connect to. (default "127.0.0.1") + -old_stordb_name string + The name/number of the storDb to connect to. (default "cgrates") + -old_stordb_passwd string + The storDb user's password. + -old_stordb_port string + The storDb port to bind to. (default "3306") + -old_stordb_type string + The type of the storDb database + -old_stordb_user string + The storDb user to sign in as. (default "cgrates") + -stordb_host string + The storDb host to connect to. (default "127.0.0.1") + -stordb_name string + The name/number of the storDb to connect to. (default "cgrates") + -stordb_passwd string + The storDb user's password. + -stordb_port string + The storDb port to bind to. (default "3306") + -stordb_type string + The type of the storDb database (default "mysql") + -stordb_user string + The storDb user to sign in as. (default "cgrates") + -version + Prints the application version.