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

A set of string constants for the parameter options. 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 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

A set of string constants for the parameter options.

Optional parameters.

Definition at line 29 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.

Supported values:

The default value is FALSE.

Definition at line 60 of file DeleteRecords.cs.

◆ FALSE

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

Definition at line 63 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 34 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 with the return_record_ids option.

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

Definition at line 45 of file DeleteRecords.cs.

◆ TRUE

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

Definition at line 62 of file DeleteRecords.cs.


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