A set of parameters for Kinetica.restoreBackup. More…
Inheritance diagram for kinetica.RestoreBackupRequest:
[legend]
Collaboration diagram for kinetica.RestoreBackupRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter RestoreBackupRequest.options. More… | |
| struct | RestoreObjectsMap |
| A set of string constants for the parameter RestoreBackupRequest.restore_objects_map. More… | |
Public Member Functions | |
| RestoreBackupRequest () | |
| Constructs a RestoreBackupRequest object with default parameters. | |
| RestoreBackupRequest (string backup_name, IDictionary< string, string > restore_objects_map, string datasource_name, IDictionary< string, string > options=null) | |
| Constructs a RestoreBackupRequest object with the specified parameters. | |
| RestoreBackupRequest () | |
| Constructs a RestoreBackupRequest object with default parameters. | |
| RestoreBackupRequest (string backup_name, IDictionary< string, string > restore_objects_map, string datasource_name, IDictionary< string, string > options=null) | |
| Constructs a RestoreBackupRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | backup_name = "" [get, set] |
| Name of the backup to restore from, which must refer to an existing backup. | |
| IDictionary< string, string > | restore_objects_map = new Dictionary<string, string>() [get, set] |
| Map of database objects to be restored from the backup. | |
| string | datasource_name [get, set] |
| Data source through which the backup will be restored. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.restoreBackup.
Restores database objects from a backup accessible via the data source specified by RestoreBackupRequest.datasource_name.
Definition at line 20 of file RestoreBackup.cs.
Constructor & Destructor Documentation
◆ RestoreBackupRequest() [1/4]
| inline |
Constructs a RestoreBackupRequest object with default parameters.
Definition at line 679 of file RestoreBackup.cs.
◆ RestoreBackupRequest() [2/4]
| inline |
Constructs a RestoreBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup to restore from, which must refer to an existing backup. The default value is ”. |
| restore_objects_map | Map of database objects to be restored from the backup.
|
| datasource_name | Data source through which the backup will be restored. |
| options | Optional parameters.
|
Definition at line 1030 of file RestoreBackup.cs.
◆ RestoreBackupRequest() [3/4]
| inline |
Constructs a RestoreBackupRequest object with default parameters.
Definition at line 679 of file RestoreBackup.cs.
◆ RestoreBackupRequest() [4/4]
| inline |
Constructs a RestoreBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup to restore from, which must refer to an existing backup. The default value is ”. |
| restore_objects_map | Map of database objects to be restored from the backup.
|
| datasource_name | Data source through which the backup will be restored. |
| options | Optional parameters.
|
Definition at line 1030 of file RestoreBackup.cs.
Property Documentation
◆ backup_name
| getset |
Name of the backup to restore from, which must refer to an existing backup.
The default value is ”.
Definition at line 325 of file RestoreBackup.cs.
◆ datasource_name
| getset |
Data source through which the backup will be restored.
Definition at line 449 of file RestoreBackup.cs.
◆ options
| getset |
Optional parameters.
- BACKUP_ID: ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ”.
- CHECKSUM: Whether or not to verify checksums for backup files when restoring. Supported values:The default value is FALSE.
- CREATE_SCHEMA_IF_NOT_EXIST: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
- TRUE: If the schema containing any restored object does not exist, create it automatically.
- FALSE: If the schema containing any restored object does not exist, return an error.
- DDL_ONLY: Behavior to apply when restoring tables. Supported values:The default value is FALSE.
- DRY_RUN: Whether or not to perform a dry run of the restoration operation. Supported values:The default value is FALSE.
- RESTORE_SUBSCRIPTIONS: Behavior to apply when restoring datasource subscriptions on tables. Supported values:
- RESUME: Resume subscriptions that were active when the backup was made.
- PAUSE: Pause subscriptions that were active when the backup was made.
- CANCEL: Cancel active subscriptions.
- REINGEST: Behavior to apply when restoring table data. Supported values:
- TRUE: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
- FALSE: Restore the persisted data files directly.
- RENAMED_OBJECTS_SCHEMA: If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one. The default value is ”.
- RESTORE_POLICY: Behavior to apply when any database object to restore already exists. Supported values:
- NONE: If an object to be restored already exists with the same name, abort and return error.
- REPLACE: If an object to be restored already exists with the same name, replace it with the backup version.
- RENAME: If an object to be restored already exists with the same name, move that existing one to the schema specified by RENAMED_OBJECTS_SCHEMA. This policy does not apply to non-schema objects.
The default value is an empty Dictionary.
Definition at line 675 of file RestoreBackup.cs.
◆ restore_objects_map
| getset |
Map of database objects to be restored from the backup.
- ALL: All object types and data contained in the given schema(s).
- CONTEXT: Context(s).
- CREDENTIAL: Credential(s).
- DATASINK: Data sink(s).
- DATASOURCE: Data source(s).
- FUNCTION_ENVIRONMENT: Python UDF function environment(s).
- GRAPH: Graph(s) definition.
- MONITOR: Table monitor(s) / SQL stream(s).
- RESOURCE_GROUP: Resource group(s).
- ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
- STORED_PROCEDURE: SQL procedure(s).
- TABLE: Table(s) and SQL view(s). Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See RESTORE_SUBSCRIPTIONS for options to override the default behavior.
- USER: User(s) (internal and external) and associated permissions.
- USER_DEFINED_FUNCTION: UDF(s).
Definition at line 445 of file RestoreBackup.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/RestoreBackup.cs
- Kinetica/Protocol/RestoreBackup.cs