Add SQLite support (default if a filename is given as the database).

[mailbox-count.git] / doc / mailbox-countrc.example

diff --git a/doc/mailbox-countrc.example b/doc/mailbox-countrc.example
index 8a3529de5d9f310b65c4186473771f7e4df27fa5..3e9559d02935aa326b959809b0d7edcd01c2d591 100644 (file)
--- a/doc/mailbox-countrc.example
+++ b/doc/mailbox-countrc.example
@@ -2,7 +2,7 @@
 # Sample configuration file for mailbox-count.
 #
 
-# The name of the database to which we should connect.
+# The name of the database (or file, if SQLite) to which we should connect.
 #
 # Default: The name of the current user (Postgres only)
 #
@@ -16,28 +16,46 @@
 # detail = true
 
 
-# Hostname where the database is located.
+# SQL query used to produce the detail report. This should return the
+# set of all (domain, username) pairs. See the default value for an
+# example.
+#
+# Default: "SELECT domain,username FROM mailbox ORDER BY domain;"
+#
+# detail_query = "SELECT domain,username FROM mailbox LIMIT 1000;"
+
+
+# Hostname where the database is located (postgres-only).
 #
 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
 #
 # host = "localhost"
 
 
-# Password used to connect to the database.
+# Password used to connect to the database (postgres-only).
 #
 # Default: None (assumes passwordless authentication)
 #
 # password = "hunter2"
 
 
-# Port number used to connect to the database.
+# Port number used to connect to the database (postgres-only).
 #
 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
 #
 # port = 5432
 
 
-# Username used to connect to the database.
+# SQL query used to produce the summary report. This should return
+# (domain, user count) pairs. See the default value for an
+# example.
+#
+# Default: "SELECT domain,COUNT(username) FROM mailbox GROUP BY domain ORDER BY domain;"
+#
+# summary_query = "SELECT domain,COUNT(username) as cnt GROUP BY domain ORDER by cnt;"
+
+
+# Username used to connect to the database (postgres-only).
 #
 # Default: The current user
 #