PHP - RRD rrd_restore() Function

---

---

The PHP RRD rrd_restore() function is used to restore the contents of an RRD file from an XML file. For recovery and backup cases, this function helps recreate the RRD file using the given XML data.

Syntax

Below is the syntax of the PHP RRD rrd_restore() function −

bool rrd_restore(string $xml_file, string $rrd_file, array $options = ?)

Parameters

Below are the parameters of the rrd_restore() function −

• $xml_file − It is the path to the XML file which contains the backup data.

• $rrd_file − It is the path to the RRD file which will be created.

• $options − It is an array of options to control the restore process.

Return Value

The rrd_restore() function returns TRUE on success and FALSE on failure.

PHP Version

This function is available from version 0.9.0 of the PECL rrd extension onwards.

Example 1

Here is the basic example of the PHP RRD rrd_restore() function to restore an RRD file from the given XML backup file.

<?php
   // Provide file names
   $xml_file = 'backup.xml';
   $rrd_file = 'data.rrd';
   
   if (rrd_restore($xml_file, $rrd_file)) {
       echo "RRD restored successfully.";
   } else {
       echo "Failed to restore RRD.";
   }
?>

Output

The above code will result something like this −

RRD restored successfully.

Example 2

In the below PHP code we will try to use the rrd_restore() function and restore an RRD file with additional options provided.

<?php
   // Provide the file names Here
   $xml_file = 'backup.xml';
   $rrd_file = 'data.rrd';
   $options = array('--force-overwrite');
   
   if (rrd_restore($xml_file, $rrd_file, $options)) {
       echo "RRD restored with options successfully.";
   } else {
       echo "Failed to restore RRD with options.";
   }
?> 

Output

After running the above program, it generates the following output −

RRD restored with options successfully.

Example 3

Now this example uses rrd_restore() function and shows how you can restore an RRD file to a different location.

<?php
   // Provide the file names Here
   $xml_file = 'backup.xml';
   $rrd_file = '/PHP/PhpProjects/data.rrd';
   
   if (rrd_restore($xml_file, $rrd_file)) {
       echo "RRD restored to a new location successfully.";
   } else {
       echo "Failed to restore RRD to a new location.";
   }
?> 

Output

This will create the below output −

RRD restored to a new location successfully.

Example 4

In the following example, we will handle errors while using the rrd_restore() function and print the message to the console.

<?php
   // Mention files here
   $xml_file = 'my_backup.xml';
   $rrd_file = 'data.rrd';
   
   if (rrd_restore($xml_file, $rrd_file)) {
       echo "RRD restored successfully.";
   } else {
       echo "Error: Could not restore RRD.";
   }
?> 

Output

When the above program is executed, it will produce the below output −

Error: Could not restore RRD.