kinetica.DeleteRecordsRequest Class Reference

A set of parameters for Kinetica.deleteRecords(string,IList{string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.DeleteRecordsRequest:

Collaboration diagram for kinetica.DeleteRecordsRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	DeleteRecordsRequest ()
	Constructs a DeleteRecordsRequest object with default parameters. More...
	DeleteRecordsRequest (string table_name, IList< string > expressions, IDictionary< string, string > options=null)
	Constructs a DeleteRecordsRequest 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
string	table_name [get, set]
	Name of the table from which to delete records. More...
IList< string >	expressions [get, set]
	A list of the actual predicates, one for each select; format should follow the guidelines provided here. More...
IDictionary< string, string >	options = new List<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.deleteRecords(string,IList{string},IDictionary{string, string}).

Deletes record(s) matching the provided criteria from the given table. The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Definition at line 27 of file DeleteRecords.cs.

Constructor & Destructor Documentation

kinetica.DeleteRecordsRequest.DeleteRecordsRequest ( )

inline

Constructs a DeleteRecordsRequest object with default parameters.

Definition at line 176 of file DeleteRecords.cs.

kinetica.DeleteRecordsRequest.DeleteRecordsRequest ( string  table_name, IList< string >  expressions, IDictionary< string, string >  options = null  )

inline

Constructs a DeleteRecordsRequest object with the specified parameters.

Parameters

table_name	Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
expressions	A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more is mutually exclusive to specifying record_id in the .
options	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: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 234 of file DeleteRecords.cs.

Property Documentation

IList<string> kinetica.DeleteRecordsRequest.expressions

getset

A list of the actual predicates, one for each select; format should follow the guidelines provided here.

Specifying one or more is mutually exclusive to specifying record_id in the .

Definition at line 127 of file DeleteRecords.cs.

IDictionary<string, string> kinetica.DeleteRecordsRequest.options = new List<string>()

getset

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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 171 of file DeleteRecords.cs.

string kinetica.DeleteRecordsRequest.table_name

getset

Name of the table from which to delete records.

The set must be a currently existing table and not a collection or a view.

Definition at line 118 of file DeleteRecords.cs.

---

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

• Kinetica/Protocol/DeleteRecords.cs