Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Latest commit

 

History

History
42 lines (29 loc) · 1.65 KB

File metadata and controls

42 lines (29 loc) · 1.65 KB
code type title description
true
page
truncate
Remove all documents from collection

truncate

Remove all documents from a collection while keeping the associated mapping.
It is faster than deleting all documents from a collection.

Signature

public void truncate(String index, String collection) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;
public void truncate(String index, String collection, io.kuzzle.sdk.QueryOptions) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;

Arguments

Arguments Type Description Required
index String Index name yes
collection String Collection name yes
options io.kuzzle.sdk.QueryOptions Query options no

options

Additional query options

Property Type Description Default
queuable boolean Make this request queuable or not true

Exceptions

Throws a io.kuzzle.sdk.KuzzleException if there is an error. See how to handle error.

Usage

<<< ./snippets/truncate.java