caf.db: rename file from caf-assocs.db

[cgi-auth-flexible.git] / caf.pod

diff --git a/caf.pod b/caf.pod
index 8ed5d518227c7c903cc1344caaebec0771781829..216410332ba969741638bbd470be110c907944fd 100644 (file)
--- a/caf.pod
+++ b/caf.pod
@@ -779,13 +779,13 @@ C<assocdb_dbh> is not supplied.
 =item C<assocdb_path>
 
 Path to the sqlite3 database used for CAF's session storage.  The
-default is currently C<caf-assocs.db> but will change in the future.
+default is C<caf.db>.
 
 Used only if neither C<assocdb_dbh> or C<assocdb_dsn> are supplied.
 
 If this is a relative path, it is in C<dir>.
 
-=item C<assocdb_table>
+=item C<db_prefix>
 
 Prefix for the SQL tables and indices to use (and to create, if
 necessary).
@@ -1311,6 +1311,21 @@ your application runs on multiple frontend hosts with a shared
 database, you may need to create for yourself the tables and indices
 used by CGI::Auth::Flexible.
 
+By default, every time CAF starts up, it attempts to execute certain
+fixed database statements to create the tables and indices it needs.
+These are run with C<$dbh->{PrintError}> set to 0.  The effect with
+sqlite (the default database) is that the tables and indices are
+created iff they do not already exist, and that no spurious errors are
+reported anywhere.
+
+If you use a different database, or just prefer to do things
+differently, you can set up the tables yourself and/or disable or
+modify the default setup statements, via the C<assocdb_setup_stmts>
+setting.
+
+The tables needed are:
+
+
 xxx document _db_setup_do
 xxx make _db_setup_do explicitly overrideable
 
@@ -1327,9 +1342,11 @@ xxx remaining settings
 xxx document cookie usage
 xxx document construct_cookie fn
 
+xxx document @default_db_setup_statements
+
 xxx bugs wrong default random on Linux
 xxx bugs wrong default random on *BSD
 xxx bugs keys not shared should be in db
-xxx rename caf-assocs.db
 xxx rename caf_assocsecret default cookie name
 xxx mention relationship between login_timeout and cookies
+xxx rename assocdb settings to db