[docs] xmldocs - jon modified refs/DatabaseAuto

docs at icdevgroup.org docs at icdevgroup.org
Thu Oct 13 01:47:34 EDT 2005

User:      jon
Date:      2005-10-13 05:47:34 GMT
Modified:  refs     DatabaseAuto
Document extensions to DatabaseAuto.

Revision  Changes    Path
1.3       +28 -6     xmldocs/refs/DatabaseAuto

rev 1.3, prev_rev 1.2
Index: DatabaseAuto
RCS file: /var/cvs/xmldocs/refs/DatabaseAuto,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- DatabaseAuto	3 Sep 2005 14:01:23 -0000	1.2
+++ DatabaseAuto	13 Oct 2005 05:47:34 -0000	1.3
@@ -32,23 +32,45 @@
 Database <replaceable>TABLENAME</replaceable> PASS <replaceable>pass</replaceable>
-for every table (not view) found in the database
+for every table (not view by default) found in the database
+Any additional space-separated arguments are passed to DBI's table_info
+method as the catalog, schema, name, and type (optionally quoted in
+shell syntax). Since order is significant, use '' to skip a value.
+Currently the catalog setting is not used by any database driver, but it
+may be in the future. See the DBI manual and your DBD module's manual
+for details on these arguments.
+For example, for a PostgreSQL database, a setting of
+DatabaseAuto   dbi:<replaceable>Pg:standard  interch  pass  ''  public
+would only see tables in the "public" schema of database <database>standard</database>,
+not other schemas such as "information_schema". This avoids the need of the
+&conf-DatabaseAutoIgnore; directive, which may exclude tables you want.
+To find views, a separate directive is needed. For example, again in PostgreSQL:
+DatabaseAuto   dbi:<replaceable>Pg:standard  interch  pass  ''  public  ''  VIEW
 If the &PERL; module <classname>DBIx::DBSchema</classname> was found,
 it would also dump the specification needed to re-create the table structures
-(which you can use as the <literal>CREATE_SQL</literal> parameter to
+(just like the <literal>CREATE_SQL</literal> parameter to &conf-Database;):
 Database  <replaceable>TABLENAME</replaceable> CREATE_SQL   CREATE TABLE <replaceable>TABLENAME ( ...)</replaceable>
-This information is available in <varname>$Vend:Cfg</varname> or 
-<varname>$Config</varname> (depending on whether the context is global 
-or local) and it is trivial to dump it to the screen or file.
+This information is available in <varname>$Vend:Cfg</varname> (global
+context) or <varname>$Config</varname> (catalog context) and it is
+trivial to dump it to the screen or file.
 See <xref linkend="DatabaseAuto_examples"/>.

More information about the docs mailing list