[Dbconfig-common-devel] dbconfig-common/doc dbconfig-common-design.html,1.5,1.6 dbconfig-common-using.html,1.12,1.13 dbconfig-common.html,1.8,1.9
seanius@haydn.debian.org
seanius@haydn.debian.org
Update of /cvsroot/dbconfig-common/dbconfig-common/doc
In directory haydn:/org/alioth.debian.org/chroot/home/users/seanius/tmp/cvs-serv19414/doc
Modified Files:
dbconfig-common-design.html dbconfig-common-using.html
dbconfig-common.html
Log Message:
just about ready for an upload to unstable(!)
Index: dbconfig-common-design.html
===================================================================
RCS file: /cvsroot/dbconfig-common/dbconfig-common/doc/dbconfig-common-design.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- dbconfig-common-design.html 3 Mar 2005 22:25:46 -0000 1.5
+++ dbconfig-common-design.html 11 Jul 2005 04:23:01 -0000 1.6
@@ -76,6 +76,7 @@
<h3> per-package database installation code </h3>
<hr>
<li> /usr/share/dbconfig-common/data/$package/install/$dbtype
+<li> /usr/share/dbconfig-common/data/$package/install-dbadmin/$dbtype
<li> /usr/share/dbconfig-common/scripts/$package/install/$dbtype
</ul>
<hr>
@@ -89,11 +90,6 @@
(this is taken care of elsewhere), only the data used to create
the necessary tables and/or otherwise populate the database is
needed here.
-
-<p>
-this code should not assume that it has administrative control over
-anything other than the database in question (that is, it may be run
-as the database user, not the database admin)
<h3> per-package database upgrade code </h3>
<hr>
Index: dbconfig-common-using.html
===================================================================
RCS file: /cvsroot/dbconfig-common/dbconfig-common/doc/dbconfig-common-using.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- dbconfig-common-using.html 21 May 2005 15:59:56 -0000 1.12
+++ dbconfig-common-using.html 11 Jul 2005 04:23:01 -0000 1.13
@@ -96,31 +96,42 @@
<h4> supplying the data/code for your databases </h4>
<p>
-there are two directories in which you can place code for
+there are three directories in which you can place code for
installing the databases of your package. the first directory is for
the majority of situations, in which the database can be constructed
-from it's native language (SQL for mysql/postgresql, for example),
-and the second is for databases that require a more robust solution,
-in which executable shell scripts (or anything else) can be placed.
-these directories can be found under the following format:
+from it's native language (SQL for mysql/postgresql, for example). the
+data will be fed to the underlying database using the credentials
+of the database user. the second directory is like the first directory,
+but will be run using the credentials of the database administrator.
+<b>Warning</b>: use of this second directory should only be done when
+there are excerpts of database code that <i>must</i> be run as the database
+administrator (such as some language constructs in postgresql) and should
+otherwise be avoided. the third location is for databases that require a
+more robust solution, in which executable shell scripts (or anything else)
+can be placed. these directories can be found under the following format:
<ul>
<li>/usr/share/dbconfig-common/data/PACKAGE/install/DBTYPE
+<li>/usr/share/dbconfig-common/data/PACKAGE/install-dbadmin/DBTYPE
<li>/usr/share/dbconfig-common/scripts/PACKAGE/install/DBTYPE
</ul>
<p>
where PACKAGE is the name of the package, DBTYPE is the type of data
(mysql, postgresql, et c). this code will only be executed on new
-installs. in the case of sql databases, in the data directory you
-would find the simple create and insert statements needed to create
-and populate the database. the scripts directory contains
-shell/perl/python/whatever scripts, which are passed the same arguments
-as dbc_go. if you need database connection information (username,
-password, etc), you can source the /bin/sh format package config file,
-or you can instruct dbconfig-common to generate one in your programming
-language of choice (see the advanced tips section).
+installs and reconfiguration of failed installs. in the case of sql
+databases, in the data directory you would find the simple create
+and insert statements needed to create tables and populate the database.
+<b>you do not need to create the underlying database, only populate it</b>.
+the scripts directory contains shell/perl/python/whatever scripts, which
+are passed the same arguments as dbc_go. if you need database connection
+information (username, password, etc) in your scripts, you can source
+the /bin/sh format package config file, or you can instruct
+dbconfig-common to generate one in your programming language of choice
+(see the advanced tips section).
+</p>
+<p>
if files exist in both data and scripts,
they will both be executed in an unspecified order.
</p>
Index: dbconfig-common.html
===================================================================
RCS file: /cvsroot/dbconfig-common/dbconfig-common/doc/dbconfig-common.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- dbconfig-common.html 18 May 2005 19:49:38 -0000 1.8
+++ dbconfig-common.html 11 Jul 2005 04:23:01 -0000 1.9
@@ -42,7 +42,7 @@
<li>comply with an agreed upon set of standards for behaviour
<li>do absolutely nothing if it is the whim of the local admin
<li>perform all operations from within the standard flow of debian
- package maintainance (no additional skill is required of the local
+ package maintenance (no additional skill is required of the local
admin)
</ul>