Kinetica   C#   API  Version 7.2.3.0
kinetica.AdminBackupBeginRequest Class Reference

A set of parameters for Kinetica.adminBackupBegin. More...

+ Inheritance diagram for kinetica.AdminBackupBeginRequest:
+ Collaboration diagram for kinetica.AdminBackupBeginRequest:

Public Member Functions

 AdminBackupBeginRequest ()
 Constructs an AdminBackupBeginRequest object with default parameters. More...
 
 AdminBackupBeginRequest (IDictionary< string, string > options=null)
 Constructs an AdminBackupBeginRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

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. More...
 

Detailed Description

A set of parameters for Kinetica.adminBackupBegin.

Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using Kinetica.adminBackupEnd.

Definition at line 21 of file AdminBackupBegin.cs.

Constructor & Destructor Documentation

◆ AdminBackupBeginRequest() [1/2]

kinetica.AdminBackupBeginRequest.AdminBackupBeginRequest ( )
inline

Constructs an AdminBackupBeginRequest object with default parameters.

Definition at line 30 of file AdminBackupBegin.cs.

◆ AdminBackupBeginRequest() [2/2]

kinetica.AdminBackupBeginRequest.AdminBackupBeginRequest ( IDictionary< string, string >  options = null)
inline

Constructs an AdminBackupBeginRequest object with the specified parameters.

Parameters
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 37 of file AdminBackupBegin.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.AdminBackupBeginRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 26 of file AdminBackupBegin.cs.


The documentation for this class was generated from the following file: