Difference between revisions of "Recitaldump"

From Recital Documentation Wiki
Jump to: navigation, search
(-o outfile)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The dbdump utility is administrated with the dbdump command. It takes the following arguments.
+
The recitaldump command is used to perform backups of either a database or a directory tree. The format of the backup file is machine independent and can be restored onto another machine with a different architecture e.g. backup on aix and restore on linux. You use the [[recitalrestore]] command to restore the backup onto another machine.  
  
'''Note:  dbdump must be run as root.  For systems with a hidden root account, please precede commands with ’sudo’.'''
+
Note:  recitaldump and recitalrestore must be run as root.  For systems with a hidden root account, please precede the commands with '''sudo'''.
  
==== help  ====
+
The recitaldump command takes the following arguments.
Using the ''help'' or ''-h'' argument  will display a list of arguments for all the services.
+
==== --help  ====
 +
Using the ''--help'' or ''-h'' argument  will display a list of arguments for all the services.
 +
 
 +
<pre>
 +
recitaldump --help
 +
</pre>
  
<code lang="bash">
 
dbdump help
 
</code>
 
 
==== -D database ====
 
==== -D database ====
This argument is used to specify the name of a database to create the dump from.
+
This argument is used to specify the name of a database to backup.  If no ''-o output file'' is specified, the backup file will be given the same basename as the database, with a ''.tar.gz'' extension.
  
<code lang="bash">
+
<pre>
  dbdump -D southwind  
+
  recitaldump -D southwind  
</code>
+
</pre>
  
 
==== -d directory ====
 
==== -d directory ====
This argument is used to specify the name of a directory create the dump from.
+
This argument is used to specify the name of a directory to backup. If no ''-o output file'' is specified, the backup file will be given the same basename as the directory, with a ''.tar.gz'' extension.  If there is a file called _reindex.prg located in the directory this file will be executed to recreate single index files when the backup is restored on a target system.  You should add the Recital script commands used to rebuild the index files (.ndx) into this file.  Multiple tag index files (.dbx) are handled automatically.
  
<code lang="bash">
+
<pre>
  dbdump -d /data/application  
+
  recitaldump -d /data/application  
</code>
+
</pre>
 +
 
 +
==== -r ====
 +
This argument is used in conjunction with the -d option to recursively process subdirectories.
 +
 
 +
<pre>
 +
recitaldump -d /data/application -r
 +
</pre>
  
 
==== -o outfile ====
 
==== -o outfile ====
Specify the output backup file name. When you need to restore this file use the [[dbrestore]] command. For example to create a backup file of the southwind database called accountants.tar.gz;
+
Specify the output backup file name. When you need to restore this file use the [[recitalrestore]] command. For example to create a backup file of the southwind database called accountants.tar.gz;
 +
 
 +
<pre>
 +
recitaldump -D southwind -o accountants
 +
</pre>
 +
 
 +
==== -t  ====
 +
This argument is used to add a time stamp to the output file name. For example if today was the 2nd of November 2009 at 03:27pm the following command would create a file called  southwind-20091102-1527.tar.gz from backing up the southwind database.
  
<code lang="bash">
+
<pre>
  dbdump -D southwind -o accountants
+
  recitaldump -D southwind -t
</code>
+
</pre>

Latest revision as of 17:20, 15 March 2010

The recitaldump command is used to perform backups of either a database or a directory tree. The format of the backup file is machine independent and can be restored onto another machine with a different architecture e.g. backup on aix and restore on linux. You use the recitalrestore command to restore the backup onto another machine.

Note: recitaldump and recitalrestore must be run as root. For systems with a hidden root account, please precede the commands with sudo.

The recitaldump command takes the following arguments.

--help

Using the --help or -h argument will display a list of arguments for all the services.

 recitaldump --help

-D database

This argument is used to specify the name of a database to backup. If no -o output file is specified, the backup file will be given the same basename as the database, with a .tar.gz extension.

 recitaldump -D southwind 

-d directory

This argument is used to specify the name of a directory to backup. If no -o output file is specified, the backup file will be given the same basename as the directory, with a .tar.gz extension. If there is a file called _reindex.prg located in the directory this file will be executed to recreate single index files when the backup is restored on a target system. You should add the Recital script commands used to rebuild the index files (.ndx) into this file. Multiple tag index files (.dbx) are handled automatically.

 recitaldump -d /data/application 

-r

This argument is used in conjunction with the -d option to recursively process subdirectories.

recitaldump -d /data/application -r 

-o outfile

Specify the output backup file name. When you need to restore this file use the recitalrestore command. For example to create a backup file of the southwind database called accountants.tar.gz;

 recitaldump -D southwind -o accountants

-t

This argument is used to add a time stamp to the output file name. For example if today was the 2nd of November 2009 at 03:27pm the following command would create a file called southwind-20091102-1527.tar.gz from backing up the southwind database.

 recitaldump -D southwind -t