DeleteDescriptor

Deletes descriptor objects that satisfy the specified constraints,

and all the connections to/from those descriptor objects.

Parameters

At least one of ref, set, or constraints is required. All supplied selectors are intersected.

Parameter	JSON type	Behavior
constraints	array expression	Optional. No property filter; the command-specific selector requirement still applies. Filters existing objects using the constraints expression language. When ref is supplied it filters that referenced set.
ref	integer, 1 through 100000	Optional. Select using the other supplied selectors; see the selection rule above. Uses an earlier compatible Descriptor reference in this transaction; forward references, wrong types, and undeclared references are rejected.
set	string	Optional. No set-name restriction; another selector is required. Restricts descriptors by their descriptor-set name; applied together with ref and constraints.

Details

Deleting objects selected by ref invalidates that reference for the remaining commands in the transaction.

A preceding Find command can select objects using more complex criteria and pass its result to the delete command through ref.

Deletion is computationally expensive; ApertureDB is optimized for workloads that perform more reads than deletes.

Response and errors

An authenticated session with the objects delete permission is required.

The response is an object under DeleteDescriptor with integer status and, on success, integer count. Status 0 means the mutation completed; count is the number of selected objects affected, including zero when none match. No output blobs are returned.

Invalid field types, missing required fields, malformed expressions, and invalid references fail validation. Execution failures include a nonzero status and an info message; inspect the transaction response before assuming a mutation succeeded. Deleting nodes also removes incident connections.

Examples

Delete descriptors with “confidence” property less than 0.8:

[{
    "DeleteDescriptor": {
        "set": "embeddings",
        "constraints": ["$confidence", "<=", 0.8]
    }
}]

Successful response:

[{
    "DeleteDescriptor": {
        "count": 9,
        "status": 0
    }
}]

Delete descriptors with “confidence” property less than 0.8 and connections to entities of class “Person” with the “age” property equal to 30:

[{
    "FindEntity": {
        "with_class": "Person",
        "_ref": 1,
        "constraints": ["$age", "==", 30]
    }
}, {
    "FindDescriptor": {
        "_ref": 2,
        "constraints": ["$confidence", "<=", 0.8],
        "is_connected_to": {
            "ref": 1
        }
    }
}, {
    "DeleteDescriptor": {
        "ref": 2
    }
}]

Successful response:

[{
    "FindEntity": {
        "returned": 0,
        "status": 0
    }
}, {
    "FindDescriptor": {
        "returned": 0,
        "status": 0
    }
}, {
    "DeleteDescriptor": {
        "count": 1,
        "status": 0
    }
}]