code | type | title | description |
---|---|---|---|
true |
page |
truncate |
Remove all documents from collection |
Remove all documents from a collection while keeping the associated mapping.
It is faster than deleting all documents from a collection.
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 | Type | Description | Required |
---|---|---|---|
index |
String | Index name | yes |
collection |
String | Collection name | yes |
options |
io.kuzzle.sdk.QueryOptions | Query options | no |
Additional query options
Property | Type | Description | Default |
---|---|---|---|
queuable |
boolean | Make this request queuable or not | true |
Throws a io.kuzzle.sdk.KuzzleException
if there is an error. See how to handle error.
<<< ./snippets/truncate.java