Difference between revisions of "Recitaldump"

From Recital Documentation Wiki
Jump to: navigation, search
Line 8: Line 8:
 
Using the ''--help'' or ''-h'' argument  will display a list of arguments for all the services.
 
Using the ''--help'' or ''-h'' argument  will display a list of arguments for all the services.
  
<code lang="bash">
+
<pre>
 
  recitaldump --help
 
  recitaldump --help
</code>
+
</pre>
  
 
==== -D database ====
 
==== -D database ====
 
This argument is used to specify the name of a database to backup.
 
This argument is used to specify the name of a database to backup.
  
<code lang="bash">
+
<pre>
 
  recitaldump -D southwind  
 
  recitaldump -D southwind  
</code>
+
</pre>
  
 
==== -d directory ====
 
==== -d directory ====
 
This argument is used to specify the name of a directory to backup. 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 into this file. Multiple tag index files are handled automatically.
 
This argument is used to specify the name of a directory to backup. 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 into this file. Multiple tag index files are handled automatically.
  
<code lang="bash">
+
<pre>
 
  recitaldump -d /data/application  
 
  recitaldump -d /data/application  
</code>
+
</pre>
  
 
==== -r ====
 
==== -r ====
 
This argument is used in conjunction with the -d option to recursively process subdirectories.
 
This argument is used in conjunction with the -d option to recursively process subdirectories.
  
<code lang="bash">
+
<pre>
 
recitaldump -d /data/application -r  
 
recitaldump -d /data/application -r  
</code>
+
</pre>
  
 
==== -o outfile ====
 
==== -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;
 
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;
  
<code lang="bash">
+
<pre>
 
  recitaldump -D southwind -o accountants
 
  recitaldump -D southwind -o accountants
</code>
+
</pre>
  
 
==== -t  ====
 
==== -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.
 
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.
  
 
+
<pre>
<code lang="bash">
+
 
  recitaldump -D southwind -t
 
  recitaldump -D southwind -t
</code>
+
</pre>

Revision as of 11:26, 22 January 2010

The recitaldump command is used to perform machine independent 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.

The recitaldump command takes the following arguments.

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

--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.

 recitaldump -D southwind 

-d directory

This argument is used to specify the name of a directory to backup. 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 into this file. Multiple tag index files 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