Kinetica C# API  Version 6.2.0.1
kinetica.DeleteRecordsRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string GLOBAL_EXPRESSION = "global_expression"
 An optional global expression to reduce the search space of the expressions. More...
 
const string RECORD_ID = "record_id"
 A record ID identifying a single record, obtained at the time of insertion of the record or by calling Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>) with the return_record_ids option. More...
 
const string DELETE_ALL_RECORDS = "delete_all_records"
 If set to true, all records in the table will be deleted. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 

Detailed Description

Optional parameters.

  • GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the . The default value is ''.
  • RECORD_ID: A record ID identifying a single record, obtained at the time of /insert/records or by calling /get/records/fromcollection with the return_record_ids option. This option cannot be used to delete records from replicated tables.
  • DELETE_ALL_RECORDS: If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values: The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 74 of file DeleteRecords.cs.

Member Data Documentation

◆ DELETE_ALL_RECORDS

const string kinetica.DeleteRecordsRequest.Options.DELETE_ALL_RECORDS = "delete_all_records"

If set to true, all records in the table will be deleted.

If set to false, then the option is effectively ignored. Supported values:

The default value is FALSE.

Definition at line 109 of file DeleteRecords.cs.

◆ FALSE

const string kinetica.DeleteRecordsRequest.Options.FALSE = "false"

Definition at line 111 of file DeleteRecords.cs.

◆ GLOBAL_EXPRESSION

const string kinetica.DeleteRecordsRequest.Options.GLOBAL_EXPRESSION = "global_expression"

An optional global expression to reduce the search space of the expressions.

The default value is ''.

Definition at line 80 of file DeleteRecords.cs.

◆ RECORD_ID

const string kinetica.DeleteRecordsRequest.Options.RECORD_ID = "record_id"

A record ID identifying a single record, obtained at the time of insertion of the record or by calling Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>) with the return_record_ids option.

This option cannot be used to delete records from replicated tables.

Definition at line 91 of file DeleteRecords.cs.

◆ TRUE

const string kinetica.DeleteRecordsRequest.Options.TRUE = "true"

Definition at line 110 of file DeleteRecords.cs.


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