A set of parameters for Kinetica.deleteRecords. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter DeleteRecordsRequest.options. More… | |
Public Member Functions | |
| DeleteRecordsRequest () | |
| Constructs a DeleteRecordsRequest object with default parameters. | |
| DeleteRecordsRequest (string table_name, IList< string > expressions, IDictionary< string, string > options=null) | |
| Constructs a DeleteRecordsRequest object with the specified parameters. | |
| DeleteRecordsRequest () | |
| Constructs a DeleteRecordsRequest object with default parameters. | |
| DeleteRecordsRequest (string table_name, IList< string > expressions, IDictionary< string, string > options=null) | |
| Constructs a DeleteRecordsRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | table_name [get, set] |
| Name of the table from which to delete records, in [schema_name. | |
| 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. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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 DeleteRecordsRequest.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 25 of file DeleteRecords.cs.
Constructor & Destructor Documentation
◆ DeleteRecordsRequest() [1/4]
| inline |
Constructs a DeleteRecordsRequest object with default parameters.
Definition at line 152 of file DeleteRecords.cs.
◆ DeleteRecordsRequest() [2/4]
| inline |
Constructs a DeleteRecordsRequest object with the specified 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.
|
Definition at line 220 of file DeleteRecords.cs.
◆ DeleteRecordsRequest() [3/4]
| inline |
Constructs a DeleteRecordsRequest object with default parameters.
Definition at line 152 of file DeleteRecords.cs.
◆ DeleteRecordsRequest() [4/4]
| inline |
Constructs a DeleteRecordsRequest object with the specified 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.
|
Definition at line 220 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 DeleteRecordsRequest.expressions is mutually exclusive to specifying RECORD_ID in the DeleteRecordsRequest.options.
Definition at line 95 of file DeleteRecords.cs.
◆ options
| getset |
Optional parameters.
- GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the DeleteRecordsRequest.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 148 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 85 of file DeleteRecords.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/DeleteRecords.cs
- Kinetica/Protocol/DeleteRecords.cs