[docs] xmldocs - docelic modified 2 files
docs at icdevgroup.org
docs at icdevgroup.org
Tue May 24 03:28:18 EDT 2005
User: docelic
Date: 2005-05-24 07:28:17 GMT
Modified: glossary feature
Modified: refs backup-database.tag
Log:
* One new tag
* Documented the rest of Feature (uninstall etc..)
Revision Changes Path
1.3 +36 -3 xmldocs/glossary/feature
rev 1.3, prev_rev 1.2
Index: feature
===================================================================
RCS file: /var/cvs/xmldocs/glossary/feature,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- feature 20 May 2005 21:41:49 -0000 1.2
+++ feature 24 May 2005 07:28:17 -0000 1.3
@@ -11,8 +11,9 @@
everything was just being added to the "&std-catalog;" catalog.
</para><para>
The basic mechanism is simple:
-Inside "feature" modules, there are two special kinds of files, called by
-extensions <literal>.global</literal> and <literal>.init</literal>.
+Inside "feature" modules, there are three special kinds of files, called by
+extensions <literal>.global</literal>, <literal>.init</literal> and
+<literal>.uninstall</literal>.
(In the included <literal>quickpoll</literal> feature, these are named
<filename>quickpoll.global</filename> and <filename>quickpoll.init</filename>).
</para><para>
@@ -51,4 +52,36 @@
init procedure has already been done.
-->
</para><para>
-Currently, the uninstallation procedure is missing.
+Uninstall files, those with the <literal>.uninstall</literal> extension,
+are &glos-ITL; files that can perform any uninstall
+functions, and they run with temporary &conf-AllowGlobal; access to
+allow dropping of tables, unlinking of files, etc.
+</para><para>
+Automated uninstall features include removing any files installed
+as a part of the feature -- providing they have not changed. If
+the file was edited and is not identical to the originally installed
+file, then it is left there and a warning issued.
+Uninstall creates file
+<filename>&conf-ConfDir;/init/<replaceable>FEATURE</replaceable>/uninstall</filename>
+to note the uninstall, and which prevents the Init process from happening
+again (assuming &IC; has not been restarted since the
+feature installation).
+</para><para>
+The uninstall routine is called with the &tag-uninstall-feature; tag.
+</para>
+<caution>
+<para>
+The catalog user must remove the &conf-Feature; directive from their
+&ccf; <emphasis>before</emphasis> running &tag-uninstall-feature;, otherwise
+the &conf-Feature; will be re-installed the next time &IC; is
+restarted!
+</para><para>
+Also, there is a short window where a SQL table, if dropped
+as a part of the uninstall procedure, could be re-instantiated
+based on the existence of the configuration in memory. It
+is recommended that if &tag-uninstall-feature; is called, a
+&tag-reconfig; tag is called shortly thereafter to reduce this
+possiblility to a minimum.
+</para>
+</caution>
+<para>
1.2 +67 -14 xmldocs/refs/backup-database.tag
rev 1.2, prev_rev 1.1
Index: backup-database.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/backup-database.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- backup-database.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ backup-database.tag 24 May 2005 07:28:17 -0000 1.2
@@ -2,19 +2,36 @@
<row>
<entry>
+ tables
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ Tables to back-up
+ </entry>
+
+</row>
+<row>
+
+ <entry>
dir
</entry>
<entry>
- <!-- POS -->
</entry>
<entry>
- <!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <varname>BACKUP_DIRECTORY</varname> or
+ <filename class='directory'>&glos-CATROOT;/backup/</filename>
</entry>
<entry>
- <!-- DSC -->
+ Backup directory to dump database contents to
</entry>
</row>
@@ -30,10 +47,11 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ 0
</entry>
<entry>
- <!-- DSC -->
+ Save all backed databases to a gnumeric file
+ <filename>DBDOWNLOAD.all</filename> in the backup directory?
</entry>
</row>
@@ -49,10 +67,13 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ 0
</entry>
<entry>
- <!-- DSC -->
+ Save all backed databases to a Microsoft Excel file
+ <filename>DBDOWNLOAD.xls</filename> in the backup directory?
+ This option requires
+ <classname>Spreadsheet::WriteExcel</classname> &PERL; module.
</entry>
</row>
@@ -68,10 +89,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ 255
</entry>
<entry>
- <!-- DSC -->
+ Maximum length of a field within the Microsoft Excel .xls format
</entry>
</row>
@@ -90,7 +111,8 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ An additional WHERE= &glos-SQL; clause to selectively back-up only
+ parts of databases
</entry>
</row>
@@ -106,13 +128,44 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ 0
</entry>
<entry>
- <!-- DSC -->
+ GZip output backup files? This option requires
+ <classname>Compress:Zlib</classname> &PERL; module.
</entry>
</row>
+&ROW_HIDE_0;
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ description
+The tag allows database backups. Databases are dumped into the backup directory,
+and named after their corresponding source files (taken from &conf-Database;
+definitions).
+</para><para>
+The tag can also produce dumps in gnumeric or Microsoft Excel formats.
+__END__
+
+
+__NAME__ notes
+The backup directory, whichever it is, must exist before
+&tag-backup-database; is called.
+__END__
+
+__NAME__ example: Backing-up the products database
+For this example to work,
+<filename class='directory'>&glos-CATROOT;/backup/</filename> directory must
+exist:
+<programlisting>
+[either]
+ [tmp name=backup set="[backup-database tables=products]" hide=1]
+[or]
+ [scratch ui_error]
+[/either]
+</programlisting>
+__END__
+
More information about the docs
mailing list