Delete Many

Deletes all the documents by a specified filter.

Use this API action when you request the mass deletion of your collection documents. You can set a filter to delete some portions of documents.

[DeleteMany] - Deletes all the documents by a specified filter.

delete

Use this API action when you request the mass deletion of your collection documents. You can set a filter to delete some portions of documents. https://docs.codemash.io/api/database/collections/delete-many

Authorizations

Path parameters

CollectionNameanyRequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Header parameters

AcceptanyRequired

Accept Header

X-CM-ClusteranyOptional

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyRequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeanyOptional

Specify culture code when your response from the API should be localised. E.g.: en

Body

FilterstringOptional

Deletes all the documents by a specified filter (in JSON format).

IgnoreTriggersbooleanOptional

Ignore the delete trigger when executing mass deletion. When this property is set to "true", all delete triggers won't be executed.

Responses

application/json

objectOptional

DeleteManyResponse

delete

HTTPcURLJavaScriptPython

DELETE //{version}/db/{CollectionName}/bulk HTTP/1.1
Host: api.codemash.io
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39

"Filter='text'&IgnoreTriggers=true"

200

Success

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "result": {
    "deletedCount": 1,
    "isAcknowledged": true
  }
}

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

await service.DeleteManyAsync(
    x => x.Name == "John"
);

Check the information about entities on how your filter parameters are mapped.

Node

PHP

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function deleteMany()
    {
        $client = new CodemashClient('{YOUR_SECRET_KEY}', '{YOUR_PROJECT_ID}');
        $codemashDb = new CodemashDb($client);
        
        $responseData = $this->codemashDb->deleteMany([
        	'collectionName' => 'employees',
        	'filter' => [
        		'address' => 'New York',
        	],
        ]);
    }
}