/create/backup - Kinetica Docs

URL: http://<db.host>:<db.port>/create/backup

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by input parameter datasink_name.

Input Parameter Description

string

Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.

string

Type of snapshot to create.

differential: Snapshot of changes in the database objects and data since the last full snapshot.
full: Snapshot of the given database objects and data.
incremental: Snapshot of changes in the database objects and data since the last snapshot of any kind.

map of string to strings

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.The default value is an empty map ( {} ).

Show backup_objects_map

All object types and data contained in the given schema(s).

Data Lake catalog that is external to the database.

KiFS File directory(ies).

Python UDF function environment(s).

Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects.

Table monitor(s) / SQL stream(s).

Resource group(s).

Role(s), role members (roles or users, recursively), and associated permissions.

SQL procedure(s).

Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active.

User(s) (internal and external) and associated permissions.

UDF(s).

string

Data sink through which the backup will be stored.

map of string to strings

Optional parameters.The default value is an empty map ( {} ).

Show options

Whether or not to block all mutations on target tables while they are being backed up.The default value is false.

true: Block all mutations on target tables while they are being backed up.
false: Only block mutations on a target table at the point a disk eviction is necessary.

Whether or not to calculate checksums for backup files.The default value is false.The supported values are:

true
false

Comments to store with this backup.

Whether or not, for tables, to only backup DDL and not table data.The default value is false.

true: For tables, only back up DDL, not data.
false: For tables, back up DDL and data.

Whether or not to delete any intermediate snapshots when the input parameter backup_type is set to differential.The default value is false.The supported values are:

true
false

Whether or not to perform a dry run of a backup operation.The default value is false.The supported values are:

true
false

Maximum number of incremental snapshots to keep.The default value is -1.

Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists.The default value is false.The supported values are:

true
false

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘create_backup_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /create/backup endpoint:

Show data_str

string

Value of input parameter backup_name.

long

ID of the snapshot created.

long

Total size of all files copied for this snapshot.

long

Total number of files copied for this snapshot.

long

Total number of records in all files copied for this snapshot.

long

Total number of records that can be restored from this snapshot.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description