Split db_mysql_live into two modules so other modules can make use of the asynchronous command interface

1 files changed, 18 insertions, 5 deletions

diff --git a/data/example.conf b/data/example.conf
index 61f5069f0..3eb1c0125 100644
--- a/data/example.conf
+++ b/data/example.conf
@@ -278,6 +278,8 @@ options
 	 *  - db_mysql
 	 *  - db_mysql_live
 	 *
+	 * You may have more than one loaded at once!
+	 *
 	 * The db_mysql_live module is an extension to db_mysql, and should only be used if
 	 * db_mysql is being used. This module pulls data in real time from SQL as it is
 	 * requested by the core as a result of someone executing commands.
@@ -285,12 +287,11 @@ options
 	 * This effectively allows you to edit your database and have it be immediately
 	 * reflected back in Anope.
 	 *
-	 * It is highly recommended you only use this module if your databases are located
-	 * locally as this module will generate many queries per command.
-	 * db_mysql_live only uses threads for commands and non-blocking queries, so it is safe to
-	 * use on large networks without worrying about response times.
+	 * For information on how to make db_mysql_live use asynchronous queries see
+	 * m_async_commands.
 	 *
-	 * NOTE: You can and probably should use db_plain together with db_mysql/db_mysql_live
+	 * At this time db_mysql_live only supports pulling data in real time from the four
+	 * main tables: anope_bs_core, anope_cs_info, anope_ns_alias, and anope_ns_core.
 	 *
 	 */
 	database = "db_plain"
@@ -2030,6 +2031,18 @@ alias
 	
 }
 
+/*
+ * m_async_commands
+ *
+ * Creates a thread for each command executed by a user. You should
+ * only load this if you are using a module designed to work with this.
+ *
+ * If this is loaded with db_mysql_live then Anope will support
+ * processing multiple commands at once which will help very busy networks
+ * with lag issues caused from the overhead of SQL queries caused by db_mysq_live.
+ */
+#module { name = "m_async_commands" }
+
 /* Provides the !kb fantasy command */
 alias
 {