Skip to main content
  • Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasink_name.

    Parameters

    • backup_name: 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.

    • backup_type: string

      Type of snapshot to create.

    • backup_objects_map: Record<string, string> | undefined

      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.

    • datasink_name: string

      Data sink through which the backup will be stored.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<CreateBackupResponse>

    Promise<Types.CreateBackupResponse> - Promise resolving to the response