diff --git a/api-reference/go/datasets/Collections.Delete.mdx b/api-reference/go/datasets/Collections.Delete.mdx new file mode 100644 index 0000000..213563a --- /dev/null +++ b/api-reference/go/datasets/Collections.Delete.mdx @@ -0,0 +1,46 @@ +--- +title: Client.Collections.Delete +sidebarTitle: Collections.Delete +icon: layer-group +--- + +```go +func (collectionClient) Delete( + ctx context.Context, + datasetID uuid.UUID, + name string, +) error +``` + +Delete a collection by its name. + +## Parameters + + + The id of the dataset + + + The name of the collection + + +## Returns + +An error if the collection could not be deleted. + + +```go Go +err := client.Collections.Delete(ctx, + datasetID, + "My-collection", +) +``` + + +## Errors + + + The specified dataset does not exist. + + + The specified collection does not exist. + diff --git a/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx b/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx new file mode 100644 index 0000000..18ddb25 --- /dev/null +++ b/api-reference/python/tilebox.datasets/Dataset.delete_collection.mdx @@ -0,0 +1,22 @@ +--- +title: Dataset.delete_collection +icon: database +--- + +```python +def Dataset.delete_collection(name: str) -> None +``` + +Delete a collection in the dataset. + +## Parameters + + + The name of the collection + + + +```python Python +dataset.delete_collection("My-collection") +``` + diff --git a/datasets/concepts/collections.mdx b/datasets/concepts/collections.mdx index a69a25e..2a6bafe 100644 --- a/datasets/concepts/collections.mdx +++ b/datasets/concepts/collections.mdx @@ -149,6 +149,21 @@ log.Println(collection.String()) L1GT: [2013-03-25T12:08:43.699 UTC, 2024-08-19T12:57:32.456 UTC] (154288 data points) ``` +## Deleting collections + +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. + + +```python Python +dataset.delete_collection("My-collection") +``` +```go Go +err := client.Collections.Delete(ctx, dataset.ID, "My-collection") +``` + + ## Errors you may encounter ### NotFoundError diff --git a/docs.json b/docs.json index fa0dd5e..145d840 100644 --- a/docs.json +++ b/docs.json @@ -155,6 +155,7 @@ "api-reference/python/tilebox.datasets/Dataset.collections", "api-reference/python/tilebox.datasets/Dataset.collection", "api-reference/python/tilebox.datasets/Dataset.create_collection", + "api-reference/python/tilebox.datasets/Dataset.delete_collection", "api-reference/python/tilebox.datasets/Dataset.get_or_create_collection", "api-reference/python/tilebox.datasets/Collection.delete", "api-reference/python/tilebox.datasets/Collection.find", @@ -200,6 +201,7 @@ "api-reference/go/datasets/Collections.Create", "api-reference/go/datasets/Collections.Get", "api-reference/go/datasets/Collections.GetOrCreate", + "api-reference/go/datasets/Collections.Delete", "api-reference/go/datasets/Collections.List", "api-reference/go/datasets/Datapoints.GetInto", "api-reference/go/datasets/Datapoints.Query",