Skip to main content
Version: V1.1.0

delete - Delete data

delete() is used to delete records from a collection. You can delete records by ID, metadata filter, or document filter.

info

This API is only available when you are connected using a client. For more information, see Client.

Prerequisites​

  • You have installed pyseekdb. For installation details, see Quick Start.

  • You are connected to the database. For connection details, see Client.

  • If you are using seekdb in client/server mode or OceanBase Database, ensure the connected user has DELETE privilege on the target table. To view privileges, see View user privileges. To grant privileges, see Directly grant privileges.

Request parameters​

delete(
    ids=ids,
    where=where,
    where_document=where_document
)
ParameterTypeRequiredDescriptionExample value
idsstring or List[str]NoIDs of the records to delete. A single ID or a list of IDs.item1
wheredictNoMetadata filter.{"category": {"$eq": "AI"}}
where_documentdictNoDocument filter.{"$contains": "obsolete"}
info

At least one of ids, where, or where_document must be provided.

Request example​

import pyseekdb


# Create a client
client = pyseekdb.Client()

collection = client.get_collection("my_collection")

# Delete by IDs
collection.delete(ids=["item1", "item2", "item3"])

# Delete by single ID
collection.delete(ids="item1")

# Delete by metadata filter
collection.delete(where={"category": {"$eq": "AI"}})

# Delete by comparison operator
collection.delete(where={"score": {"$lt": 50}})

# Delete by document filter
collection.delete(where_document={"$contains": "obsolete"})

# Delete with combined filters
collection.delete(
    where={"category": {"$eq": "AI"}},
    where_document={"$contains": "deprecated"}
)

Response parameters​

None

Contents

Edit this page