DROP COLLECTION
- reference
The DROP COLLECTION
statement enables you to delete a named collection from a scope.
Syntax
drop-collection ::= 'DROP' 'COLLECTION' ( ( namespace ':' )? bucket '.' scope '.' )?
collection ( 'IF' 'EXISTS' )?
namespace |
(Optional) An identifier that refers to the namespace of the bucket which contains the collection you want to delete.
Currently, only the |
bucket |
(Optional) An identifier that refers to the bucket which contains the collection you want to delete. |
scope |
(Optional) An identifier that refers to the scope which contains the collection you want to delete. |
collection |
(Required) An identifier that refers to the name of the collection that you want to delete. |
If there is a hyphen (-) inside the bucket name, the scope name, or the collection name, you must wrap that part of the path in backticks (` `).
For example, default:`travel-sample` indicates the travel-sample keyspace in the default namespace.
|
Specifying the Location
To specify the location of the collection, you may do one of the following:
-
Include its full path, containing the namespace, bucket, and scope, followed by the collection name;
-
Include a relative path, containing just the bucket and scope, followed by the connection name;
-
Specify just the collection name without a path.
When you specify a collection name without a path, you must set the query context to indicate the required namespace, bucket, and scope. If you specify a collection name by itself without setting a valid query context, an error is generated.
IF EXISTS Clause
The optional IF EXISTS
clause enables the statement to complete successfully when the specified collection doesn’t exist.
If the collection does not exist within the specified scope, then:
-
If this clause is not present, an error is generated.
-
If this clause is present, the statement does nothing and completes without error.
Examples
This statement deletes a collection called city
in the inventory
scope within the travel-sample
bucket.
DROP COLLECTION `travel-sample`.inventory.city
For this example, set the query context to the inventory
scope in the travel sample dataset.
For more information, see Query Context.
Assuming that the query context is set, this statement deletes a collection called country
in the inventory
scope within the travel-sample
bucket.
DROP COLLECTION country;
Related Links
-
An overview of scopes and collections is provided in Scopes and Collections.
-
Step-by-step procedures for management are provided in Manage Scopes and Collections.
-
Refer to Scopes and Collections API to manage scopes and collections with the REST API.
-
Refer to the reference page for the collection-manage command to manage scopes and collections with the CLI.