diff --git a/api-reference/go/datasets/Collections.Delete.mdx b/api-reference/go/datasets/Collections.Delete.mdx index 213563a..45bc274 100644 --- a/api-reference/go/datasets/Collections.Delete.mdx +++ b/api-reference/go/datasets/Collections.Delete.mdx @@ -8,19 +8,19 @@ icon: layer-group func (collectionClient) Delete( ctx context.Context, datasetID uuid.UUID, - name string, + collectionID uuid.UUID, ) error ``` -Delete a collection by its name. +Delete a collection by its id. ## Parameters The id of the dataset - - The name of the collection + + The id of the collection ## Returns @@ -31,7 +31,7 @@ An error if the collection could not be deleted. ```go Go err := client.Collections.Delete(ctx, datasetID, - "My-collection", + collectionID, ) ``` diff --git a/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx b/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx index 18ddb25..6dafa2b 100644 --- a/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx +++ b/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx @@ -4,15 +4,15 @@ icon: database --- ```python -def Dataset.delete_collection(name: str) -> None +def Dataset.delete_collection(collection: str | UUID | CollectionClient) -> None ``` Delete a collection in the dataset. ## Parameters - - The name of the collection + + The collection to delete. Can be specified by name, id, or as a collection object. diff --git a/datasets/concepts/collections.mdx b/datasets/concepts/collections.mdx index 2a6bafe..13d2d32 100644 --- a/datasets/concepts/collections.mdx +++ b/datasets/concepts/collections.mdx @@ -155,12 +155,16 @@ Collections can be deleted from a dataset using the `delete_collection` method. To delete a collection, you need to have write permission on the dataset. + + Deleting a collection will delete all data points in the collection. + + ```python Python -dataset.delete_collection("My-collection") +dataset.delete_collection(collection) ``` ```go Go -err := client.Collections.Delete(ctx, dataset.ID, "My-collection") +err := client.Collections.Delete(ctx, dataset.ID, collection.ID) ```