diff options
| -rw-r--r-- | data/anope.example.conf | 52 |
1 files changed, 30 insertions, 22 deletions
diff --git a/data/anope.example.conf b/data/anope.example.conf index 578830186..4a93dc6ad 100644 --- a/data/anope.example.conf +++ b/data/anope.example.conf @@ -1202,17 +1202,21 @@ module /* * db_sql and db_sql_live * - * db_sql module allows saving and loading databases using one of the SQL engines. - * This module loads the databases once on startup, then incrementally updates - * objects in the database as they are changed within Anope in real time. Changes - * to the SQL tables not done by Anope will have no effect and will be overwritten. + * Allows saving and loading databases to a SQL database. * - * db_sql_live module allows saving and loading databases using one of the SQL engines. - * This module reads and writes to SQL in real time. Changes to the SQL tables - * will be immediately reflected into Anope. This module should not be loaded - * in conjunction with db_sql. It should also not be used on large networks as it - * executes quite a lot of queries which can cause performance issues. + * db_sql loads the databases once on startup and then incrementally updates in + * in the database as they are changed within Anope. Changes to the SQL tables + * not done by Anope will have no effect and will be overwritten. * + * db_sql_live module reads and writes to SQL in real time. Changes to the SQL + * tables will be immediately reflected in Anope. This module can not be loaded + * at the same time as db_sql. It should also not be used on large networks as + * it executes quite a lot of queries which can cause performance issues. + * + * IMPORTANT: The SQL schema has changed in the 2.1 branch. Whilst Anope will + * try to update your schema it is recommended that before upgrading you export + * to a file and re-import your database on 2.1. This will remove any obsolete + * columns and change the types of existing columns to match the new schema. */ #module { @@ -1220,10 +1224,10 @@ module #name = "db_sql_live" /* - * The SQL service db_sql(_live) should use, these are configured in modules.conf. - * For MySQL, this should probably be mysql/main. + * The SQL service that db_sql(_live) should use. These are configured in + * modules.example.conf. For MySQL, this should probably be mysql/main. */ - engine = "sqlite/main" + engine = "mysql/main" /* * An optional prefix to prepended to the name of each created table. @@ -1231,18 +1235,22 @@ module */ #prefix = "anope_db_" - /* Whether or not to import data from another database module in to SQL on startup. - * If you enable this, be sure that the database services is configured to use is - * empty and that another database module to import from is loaded BEFORE db_sql. - * After you enable this and do a database import you MUST disable it for - * subsequent restarts. If you want to keep writing a flatfile database after the - * SQL import is done you should load db_flatfile AFTER this module. + /* + * Whether or not to import data from another database module in to SQL on + * startup. + * + * If you enable this, be sure that the database Anope is configured to use + * is empty and that another database module to import from is loaded BEFORE + * db_sql. After you enable this and do a database import you MUST disable + * it for subsequent restarts. If you want to keep writing a file database + * after the SQL import is done you should load db_flatfile or db_json AFTER + * this module. * - * Note that you can not import databases using db_sql_live. If you want to import - * databases and use db_sql_live you should import them using db_sql, then shut down - * and start services with db_sql_live. + * Note that you can not import databases using db_sql_live. If you want to + * import databases and use db_sql_live you should import them using db_sql, + * then shut down and start Anope with db_sql_live. */ - import = false + import = no } /* |