Delete Documents
- Capella Operational
- how-to
How to delete documents with a command line tool or an SDK.
Introduction
In situations where data is no longer needed, Couchbase Capella provides a remove operation to delete a document from the database permanently.
Read the following for further information about the clients available:
-
Couchbase Shell (cbsh) — developer preview
| Please note that the examples in this guide will alter the data in your sample database. To restore your sample data, remove and reinstall the travel sample data. Refer to Import Data with the Capella UI for details. |
Deleting a Document
To delete a document, perform a remove operation.
-
cbsh
-
.NET
-
Java
-
Node.js
-
Python
-
If you haven’t already done so, use
cb-envto set the bucket, scope, and collection where the document is stored. -
Use the
doc removecommand to delete the document by ID.
The example below deletes document hotel-123 from the database.
console╭───┬───────────┬─────────┬────────┬──────────┬─────────╮ │ # │ processed │ success │ failed │ failures │ cluster │ ├───┼───────────┼─────────┼────────┼──────────┼─────────┤ │ 0 │ 1 │ 1 │ 0 │ │ capella │ ╰───┴───────────┴─────────┴────────┴──────────┴─────────╯
For further details, refer to Removing in the Couchbase Shell documentation.
Use the RemoveAsync() method to delete a document from the database.
The example below deletes document hotel-123 from the database.
If the document doesn’t exist, the SDK will return a DocumentNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to CollectionExtensions.
Use the remove() method to delete a document from the database.
The example below deletes document hotel-123 from the database.
If the document doesn’t exist, the SDK will return a DocumentNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to Collection.
Use the remove() function to delete a document from the database.
The example below deletes document hotel-123 from the database.
If the document doesn’t exist, the SDK will return a DocumentNotFoundError error.
|
Click the View button to see this code in context.
For further details, refer to Collection.
Use the remove() function to delete a document from the database.
The example below deletes document hotel-123 from the database.
If the document doesn’t exist, the SDK will return a DocumentNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to Collection.
Deleting a Sub-Document
To delete a specific field within a document you can perform a sub-document remove operation.
-
cbsh
-
.NET
-
Java
-
Node.js
-
Python
-
If you haven’t already done so, use
cb-envto set the bucket, scope, and collection where the document is stored. -
Use the
doc getcommand to retrieve a document by ID. -
Pipe the document through the
rejectfilter to remove the field containing the sub-document. -
Pipe the output, including the
idandcontentfields, through thedoc replacecommand to update the document.
The example below deletes the url field from document hotel-123.
console╭───┬───────────┬─────────┬────────┬──────────┬─────────╮ │ # │ processed │ success │ failed │ failures │ cluster │ ├───┼───────────┼─────────┼────────┼──────────┼─────────┤ │ 0 │ 1 │ 1 │ 0 │ │ capella │ ╰───┴───────────┴─────────┴────────┴──────────┴─────────╯
If the field containing the sub-document cannot be found, the reject command returns a Cannot find column error.
|
For further details, refer to reject for filters in the Nushell documentation.
-
Call the
MutateInAsync()method, which takes a document ID and an IEnumerable containingMutateInSpecobjects. -
Use a
MutateInSpecobject to specify the sub-operation to be performed within the lookup.
A MutateInResult object is returned containing the result and metadata relevant to the sub-document remove operation.
The example below deletes the url field from document hotel-123.
If the path doesn’t exist, the SDK will return a PathNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to CollectionExtensions.
-
Call the
mutateIn()method, which takes a document ID and an array ofMutateInSpecobjects. -
Use a
MutateInSpecobject to specify the sub-operation to be performed within the lookup.
A MutateInResult object is returned, containing the result and metadata relevant to the sub-document remove operation.
The example below deletes the url field from document hotel-123.
If the path doesn’t exist, the SDK will return a PathNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to Collection.
-
Call the
mutateIn()method, which takes a document ID and an array ofMutateInSpecobjects. -
Use a
MutateInSpecobject to specify the sub-operation to be performed within the lookup.
A MutateInResult object is returned, containing the result and metadata relevant to the sub-document remove operation.
The example below deletes the url field from document hotel-123.
If the path doesn’t exist, the SDK will return a PathNotFoundError error.
|
Click the View button to see this code in context.
For further details, refer to Collection.
-
Call the
lookup_in()function, which takes a document ID and a list ofMutateInSpecobjects. -
Use a
MutateInSpecobject to specify the sub-operation to be performed within the lookup.
A MutateInResult object is returned, containing the result and metadata relevant to the sub-document remove operation.
The example below deletes the url field from document hotel-123.
If the path doesn’t exist, the SDK will return a PathNotFoundException error.
|
Click the View button to see this code in context.
For further details, refer to Collection.