Deletes record(s) matching the provided criteria from the given table. The
record selection criteria can either be one or more input parameter
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.
Input Parameter Description
string
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.
array of strings
A list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more input parameter expressions is mutually exclusive to specifying record_id in the input parameter options.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
An optional global expression to reduce the search space of the input parameter expressions.The default value is ”.
If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored.The default value is false.The supported values are:
true
false
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘delete_records_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /delete/records endpoint:
Show data_str
long
Total number of records deleted across all expressions.
array of longs
Total number of records deleted per expression.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.