Difference between revisions of "Backup and Restore Databases"

From Recital Documentation Wiki
Jump to: navigation, search
(Backup and Restore Databases)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Backup and Restore Databases==
 
==Backup and Restore Databases==
 
===Using the recitaldump Command to Backup Your Data===
 
===Using the recitaldump Command to Backup Your Data===
 +
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.
 +
 +
<pre>
 +
recitaldump --help
 +
</pre>
 +
 +
==== -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.
 +
 +
<pre>
 +
recitaldump -D southwind
 +
</pre>
 +
 +
==== -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.
 +
 +
<pre>
 +
recitaldump -d /data/application
 +
</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 ====
 +
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.
 +
 +
<pre>
 +
recitaldump -D southwind -t
 +
</pre>
 +
 
===Using the recitalrestore Command to Restore Your Data===
 
===Using the recitalrestore Command to Restore Your Data===
===Rollback to a Database Timeline===
+
The [[recitalrestore]] utility is is used to restore a backup archive created using the [[recitaldump]] command. The recitaldump command can be used to create a machine independent backup of a database or directory which is restored onto a target system using recitalrestore.
===Summary===
+
 
 +
Note:  recitalrestore must be run as root.  For systems with a hidden root account, please precede commands with '''sudo'''.
 +
 
 +
The recitalrestore command takes the following arguments.
 +
==== --help  ====
 +
Using the ''--help'' or ''-h'' argument  will display a list of arguments for all the services.
 +
 
 +
<pre>
 +
recitalrestore --help
 +
</pre>
 +
==== -i infile ====
 +
Specify the input backup file that was created from [[recitaldump]] to restore from.  If the backup is of a directory, the full path name of the backup file must be specified.
 +
 
 +
<pre>
 +
recitalrestore -i /tmp/application.tar.gz
 +
</pre>
 +
 
 +
For a database, only the file name need be given.
 +
 
 +
<pre>
 +
recitalrestore -i southwind.tar.gz
 +
</pre>
 +
====[ -q ]====
 +
Run in quiet mode.
 +
 
 +
<pre>
 +
recitalrestore -i southwind.tar.gz -q
 +
</pre>
 +
====[ -v ]====
 +
Run in verbose mode.
 +
 
 +
<pre>
 +
recitalrestore -i southwind.tar.gz -v
 +
</pre>
 +
 
 +
===Using the Recital Rollback Timeline Command to Rollback to a Timeline===
 +
Database timelines provide row versioning for Recital database applications. Whenever a change is made to a table that is timeline enabled, delta changes are automatically recorded for each transaction. Changes made to any tables that are timeline enabled can be ''undone'' using the [[ROLLBACK TIMELINE|rollback timeline]] command.
 +
 
 +
For full details on database timelines, please see the [[Database Timelines]] section.

Latest revision as of 10:19, 16 March 2010

Backup and Restore Databases

Using the recitaldump Command to Backup Your Data

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

Using the recitalrestore Command to Restore Your Data

The recitalrestore utility is is used to restore a backup archive created using the recitaldump command. The recitaldump command can be used to create a machine independent backup of a database or directory which is restored onto a target system using recitalrestore.

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

The recitalrestore command takes the following arguments.

--help

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

 recitalrestore --help

-i infile

Specify the input backup file that was created from recitaldump to restore from. If the backup is of a directory, the full path name of the backup file must be specified.

 recitalrestore -i /tmp/application.tar.gz

For a database, only the file name need be given.

 recitalrestore -i southwind.tar.gz

[ -q ]

Run in quiet mode.

 recitalrestore -i southwind.tar.gz -q

[ -v ]

Run in verbose mode.

 recitalrestore -i southwind.tar.gz -v

Using the Recital Rollback Timeline Command to Rollback to a Timeline

Database timelines provide row versioning for Recital database applications. Whenever a change is made to a table that is timeline enabled, delta changes are automatically recorded for each transaction. Changes made to any tables that are timeline enabled can be undone using the rollback timeline command.

For full details on database timelines, please see the Database Timelines section.