You are viewing an older version of this section. View current production version.
RESTORE
Restore data from a binary backup file.
Syntax
Local Restore
RESTORE [DATABASE] db_name FROM "backup_path" [WITH {SYNC | ASYNC} REPLICATION]
S3 Restore
RESTORE [DATABASE] db_name FROM S3 "bucket/path" [CONFIG configuration_json] CREDENTIALS credentials_json [WITH {SYNC | ASYNC} REPLICATION]
configuration_json:
'{"region":"your_region"}'
'{"aws_access_key_id": "replace_with_your_access_key_id",
"aws_secret_access_key": "replace_with_your_secret_access_key",
["aws_session_token": "replace_with_your_temp_session_token",]
["role_arn":"replace_with_your_role_arn"]
}'
Remarks
db_nameis the name of the MemSQL database to restore to.- If you wish to restore the backup into a differently-named database, you can do so by specifying the full path to the .backup file in
backup_pathfor local backups orpathfor S3. For example, you can doBACKUP DATABASE db TO './path/'followed byRESTORE DATABASE newdb FROM './path/db.backup'. See the Examples section for an example using S3. - The
RESTOREcommand replays a binary backup file in the same manner in which MemSQL recovers a database snapshot during startup. WITH {SYNC | ASYNC} REPLICATIONcontrols whether replication in high availability will be done synchronously or asynchronously. The default mode isASYNC. Partitions replicated synchronously will ensure commits have reached all replicas before acknowledging the transaction to the user client. While providing stronger consistency guarantees, this can negatively impact write performance. For more information, see Managing High Availability.- A
RESTOREoperation temporarily puts the database being restored into therecovering snapshotstate. A database in this state cannot be queried. When theRESTOREcommand finishes, it puts the database into theonlinestate. (see the Database topic for more information). - This command must be run on the master aggregator node (see Node Requirements for MemSQL Commands).
MemSQL does not support restoring database backups from a newer version of MemSQL into an older version.
Local Restore Remarks
backup_pathis the path used in BACKUP .- The path
backup_pathneeds to be accessible by thememsqldprocess. Paths are resolved relative to thememsqlbin/datadirectory.
S3 Restore Remarks
aws_session_tokenis optional. This is only needed if your AWS account uses the AWS Security Token Service.role_arnis optional. This is only needed if your AWS security is setup to require a role.
Example
Local Restore
The following example restores from the /var/lib/memsql/data/ directory.
RESTORE DATABASE memsql_demo FROM "./";
S3 Restore
The following example restores from an S3 bucket.
RESTORE DATABASE memsql_demo FROM S3 "backup_bucket/backups/6_1_2018" CONFIG '{"region":"us-east-1"}' CREDENTIALS '{"aws_access_key_id":"replace_with_your_access_key_id","aws_secret_access_key":"replace_with_your_secret_access_key"}';
The following example restores a database from an S3 bucket to a database with a different name.
RESTORE DATABASE new_memsql_demo FROM S3 "backup_bucket/backups/6_1_2018/memsql_demo.backup" CONFIG '{"region":"us-east-1"}' CREDENTIALS '{"aws_access_key_id":"replace_with_your_access_key_id","aws_secret_access_key":"replace_with_your_secret_access_key"}';
This MemSQL feature is only available in MemSQL Enterprise Edition. MemSQL Enterprise Edition includes 24x7 support and several enterprise-only features for critical deployments. For more information about MemSQL Developer and MemSQL Enterprise, see the MemSQL Editions page.