Link Search Menu Expand Document

SqlBak-CLI documentation

Folder Storage

SqlBak-CLI can store backups to a local folder. Also, SqlBak-CLI can send the backups via SMB protocol to a remote folder (only Windows).

{
	"type" : folder
	"path" : <string>,
	"user_name": <string>,
	"user_password": <string>,
	...
}

Mandatory parameters

path

Path where backups should be stored.

Optional parameters

user_name

Username for connection via SMB protocol.

user_password

User password for connection via SMB protocol.

validate_file_checksum

Use checksum verification for a file transfer.

VALUES:

true – after copying a backup file to the directory specified in the path field, the application will calculate the checksum of the file and compare it with the checksum of the original backup file (default).

false – no checks will be made.

Examples

Saving a backup to your home directory on Linux

...
"storages":
	[
		{
			"destination_type": "folder",
			"path": "/home/mike/backups/",
			"keep_settings": [
					{ "backup_type": "full", "hours": 1 }
			]
		}
	]

}

Sending a backup to a network directory via SMB protocol on Windows

...
"storages":
	[
		{
			"type": "folder",
			"path": "\\backupserver\backup\sql-server",
			"user_name": "mike",
			"user_password": "*********",
			"keep_settings": [
				{ "backup_type": "full", "hours": 1 }
			]
		}
	]

}