Skip to content

Commit 6b28b25

Browse files
authored
Document "m" For Deleting Groups (#1828)
* Document That `Group.delete()` Should Be Opened in 'm' Mode
1 parent 498b2b1 commit 6b28b25

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

tiledb/group.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class Group(CtxMixin, lt.Group):
2222
2323
:param uri: The URI to the Group
2424
:type uri: str
25-
:param mode: Read mode ('r') or write mode ('w')
25+
:param mode: Read mode ('r'), write mode ('w'), or modify exclusive ('m')
2626
:type mode: str
2727
:param config: A TileDB config
2828
:type config: Config or dict
@@ -67,6 +67,11 @@ class Group(CtxMixin, lt.Group):
6767
>>> grp.open("w")
6868
>>> grp.remove(subgrp_path)
6969
>>> grp.close()
70+
>>>
71+
>>> # Delete the subgroup
72+
>>> grp.open("m")
73+
>>> grp.delete(subgrp_path)
74+
>>> grp.close()
7075
"""
7176

7277
_NP_DATA_PREFIX = "__np_flat_"
@@ -320,7 +325,7 @@ def add(self, uri: str, name: str = None, relative: bool = False):
320325

321326
def delete(self, recursive: bool = False):
322327
"""
323-
Delete a Group.
328+
Delete a Group. The group needs to be opened in 'm' mode.
324329
325330
:param uri: The URI of the group to delete
326331
"""
@@ -431,7 +436,7 @@ def uri(self) -> str:
431436
@property
432437
def mode(self) -> str:
433438
"""
434-
:return: Read mode ('r') or write mode ('w')
439+
:return: Read mode ('r'), write mode ('w'), or modify exclusive ('m')
435440
:rtype: str
436441
"""
437442
return self._query_type_to_mode[self._query_type]

0 commit comments

Comments
 (0)