A set of parameters for Kinetica.deleteRecords. More...
Inheritance diagram for kinetica.DeleteRecordsRequest:
Collaboration diagram for kinetica.DeleteRecordsRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. 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, in [schema_name. More... | |
| IList< string > | expressions = new List<string>() [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 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.deleteRecords.
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 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 24 of file DeleteRecords.cs.
Constructor & Destructor Documentation
◆ DeleteRecordsRequest() [1/2]
|
inline |
Constructs a DeleteRecordsRequest object with default parameters.
Definition at line 132 of file DeleteRecords.cs.
◆ DeleteRecordsRequest() [2/2]
|
inline |
Constructs a DeleteRecordsRequest object with the specified parameters.
- Parameters
-
table_name Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views. expressions A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying RECORD_ID in the options . options Optional parameters. - GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the expressions . The default value is ''.
- 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.
- 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 193 of file DeleteRecords.cs.
Property Documentation
◆ expressions
|
getset |
A list of the actual predicates, one for each select; format should follow the guidelines provided here.
Specifying one or more expressions is mutually exclusive to specifying RECORD_ID in the options.
Definition at line 82 of file DeleteRecords.cs.
◆ options
|
getset |
Optional parameters.
- GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the expressions. The default value is ''.
- 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.
- 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.
Definition at line 128 of file DeleteRecords.cs.
◆ table_name
|
getset |
Name of the table from which to delete records, in [schema_name.
]table_name format, using standard name resolution rules.
Must contain the name of an existing table; not applicable to views.
Definition at line 72 of file DeleteRecords.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/DeleteRecords.cs
