com.gpudb.protocol

Class CreateBackupRequest

java.lang.Object

com.gpudb.protocol.CreateBackupRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateBackupRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createBackup.

Creates a database backup containing a current snapshot of existing objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateBackupRequest.BackupObjectsMap A set of string constants for the CreateBackupRequest parameter backupObjectsMap.
static class	CreateBackupRequest.BackupType A set of string constants for the CreateBackupRequest parameter backupType.
static class	CreateBackupRequest.Options A set of string constants for the CreateBackupRequest parameter options.

Constructor Summary

Constructors

Constructor and Description
CreateBackupRequest() Constructs a CreateBackupRequest object with default parameters.
CreateBackupRequest(String backupName, String backupType, Map<String,String> backupObjectsMap, String datasinkName, Map<String,String> options) Constructs a CreateBackupRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
String	getBackupName() Name for this backup object.
Map<String,String>	getBackupObjectsMap() Map of objects to be captured in the backup.
String	getBackupType() Type of backup to create.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getDatasinkName() Datasink where backup will be stored.
Map<String,String>	getOptions() Optional parameters.
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
CreateBackupRequest	setBackupName(String backupName) Name for this backup object.
CreateBackupRequest	setBackupObjectsMap(Map<String,String> backupObjectsMap) Map of objects to be captured in the backup.
CreateBackupRequest	setBackupType(String backupType) Type of backup to create.
CreateBackupRequest	setDatasinkName(String datasinkName) Datasink where backup will be stored.
CreateBackupRequest	setOptions(Map<String,String> options) Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateBackupRequest

public CreateBackupRequest()

Constructs a CreateBackupRequest object with default parameters.

CreateBackupRequest

public CreateBackupRequest(String backupName,
                           String backupType,
                           Map<String,String> backupObjectsMap,
                           String datasinkName,
                           Map<String,String> options)

Constructs a CreateBackupRequest object with the specified parameters.

Parameters:

backupName - Name for this backup object. If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified

backupType - Type of backup to create. Supported values:

• INCREMENTAL
• DIFFERENTIAL
• FULL

backupObjectsMap - Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

datasinkName - Datasink where backup will be stored.

options - Optional parameters.

• COMMENT: Comments to store with this backup
• CHECKSUM: Calculate checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• DDL_ONLY: Only save the DDL, do not backup table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides MAX_INCREMENTAL_BACKUPS_TO_KEEP. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• RECREATE: Replace the existing backup object with a new full backup if it already exists. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Dry run of backup. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getBackupName

public String getBackupName()

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

Returns:

The current value of backupName.

setBackupName

public CreateBackupRequest setBackupName(String backupName)

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

Parameters:

backupName - The new value for backupName.

Returns:

this to mimic the builder pattern.

getBackupType

public String getBackupType()

Type of backup to create. Supported values:

• INCREMENTAL
• DIFFERENTIAL
• FULL

Returns:

The current value of backupType.

setBackupType

public CreateBackupRequest setBackupType(String backupType)

Type of backup to create. Supported values:

• INCREMENTAL
• DIFFERENTIAL
• FULL

Parameters:

backupType - The new value for backupType.

Returns:

this to mimic the builder pattern.

getBackupObjectsMap

public Map<String,String> getBackupObjectsMap()

Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

Returns:

The current value of backupObjectsMap.

setBackupObjectsMap

public CreateBackupRequest setBackupObjectsMap(Map<String,String> backupObjectsMap)

Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

Parameters:

backupObjectsMap - The new value for backupObjectsMap.

Returns:

this to mimic the builder pattern.

getDatasinkName

public String getDatasinkName()

Datasink where backup will be stored.

Returns:

The current value of datasinkName.

setDatasinkName

public CreateBackupRequest setDatasinkName(String datasinkName)

Datasink where backup will be stored.

Parameters:

datasinkName - The new value for datasinkName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• COMMENT: Comments to store with this backup
• CHECKSUM: Calculate checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• DDL_ONLY: Only save the DDL, do not backup table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides MAX_INCREMENTAL_BACKUPS_TO_KEEP. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• RECREATE: Replace the existing backup object with a new full backup if it already exists. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Dry run of backup. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public CreateBackupRequest setOptions(Map<String,String> options)

Optional parameters.

• COMMENT: Comments to store with this backup
• CHECKSUM: Calculate checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• DDL_ONLY: Only save the DDL, do not backup table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides MAX_INCREMENTAL_BACKUPS_TO_KEEP. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• RECREATE: Replace the existing backup object with a new full backup if it already exists. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Dry run of backup. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object