kinetica.AdminVerifyDbRequest Class Reference
A set of parameters for Kinetica.adminVerifyDb. More...
Inheritance diagram for kinetica.AdminVerifyDbRequest:
Collaboration diagram for kinetica.AdminVerifyDbRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| AdminVerifyDbRequest () | |
| Constructs an AdminVerifyDbRequest object with default parameters. More... | |
| AdminVerifyDbRequest (IDictionary< string, string > options=null) | |
| Constructs an AdminVerifyDbRequest object with the specified parameters. More... | |
| AdminVerifyDbRequest () | |
| Constructs an AdminVerifyDbRequest object with default parameters. More... | |
| AdminVerifyDbRequest (IDictionary< string, string > options=null) | |
| Constructs an AdminVerifyDbRequest 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... | |
| 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... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.adminVerifyDb.
Verify database is in a consistent state. When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
Definition at line 18 of file AdminVerifyDb.cs.
Constructor & Destructor Documentation
◆ AdminVerifyDbRequest() [1/4]
|
inline |
Constructs an AdminVerifyDbRequest object with default parameters.
Definition at line 319 of file AdminVerifyDb.cs.
◆ AdminVerifyDbRequest() [2/4]
|
inline |
Constructs an AdminVerifyDbRequest object with the specified parameters.
- Parameters
-
options Optional parameters. - REBUILD_ON_ERROR: [DEPRECATED – Use the Rebuild DB feature of GAdmin instead.]. Supported values: The default value is FALSE.
- VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values: The default value is FALSE.
- VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values: The default value is FALSE.
- CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values: The default value is TRUE.
- VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values: The default value is FALSE.
- DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values: The default value is FALSE.
- VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values: The default value is FALSE.
- TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
- TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.
Definition at line 485 of file AdminVerifyDb.cs.
◆ AdminVerifyDbRequest() [3/4]
|
inline |
Constructs an AdminVerifyDbRequest object with default parameters.
Definition at line 319 of file AdminVerifyDb.cs.
◆ AdminVerifyDbRequest() [4/4]
|
inline |
Constructs an AdminVerifyDbRequest object with the specified parameters.
- Parameters
-
options Optional parameters. - REBUILD_ON_ERROR: [DEPRECATED – Use the Rebuild DB feature of GAdmin instead.]. Supported values: The default value is FALSE.
- VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values: The default value is FALSE.
- VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values: The default value is FALSE.
- CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values: The default value is TRUE.
- VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values: The default value is FALSE.
- DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values: The default value is FALSE.
- VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values: The default value is FALSE.
- TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
- TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.
Definition at line 485 of file AdminVerifyDb.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- REBUILD_ON_ERROR: [DEPRECATED – Use the Rebuild DB feature of GAdmin instead.]. Supported values: The default value is FALSE.
- VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values: The default value is FALSE.
- VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values: The default value is FALSE.
- CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values: The default value is TRUE.
- VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values: The default value is FALSE.
- DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values: The default value is FALSE.
- VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values: The default value is FALSE.
- TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
- TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.
The default value is an empty Dictionary.
Definition at line 315 of file AdminVerifyDb.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AdminVerifyDb.cs
