Skip to content

Commit dc261a0

Browse files
authored
adds collection lookup explanation to docs (#78)
1 parent 98125ff commit dc261a0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/source/working/stream-query-manage.rst

+14
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ supplied UUID cannot be found then :code:`None` will be returned.
4444
stream = conn.stream_from_uuid("71466a91-dcfe-42ea-9e88-87c51f847942")
4545
4646
47+
Look up collections
48+
--------------------------
49+
You can look up collections found in the server by using the :code:`list_collections`
50+
method, which returns a list of string collection names. Additionally,
51+
you can use the :code:`starts_with` parameter to filter the results to include only collections
52+
that begin with the provided prefix. Omitting the :code:`starts_with` parameter will return
53+
all available collections from the server.
54+
55+
.. code-block:: python
56+
57+
conn = btrdb.connect()
58+
collections = conn.list_collections(starts_with="NORTHWEST")
59+
60+
4761
Finding by collection
4862
--------------------------
4963
You can also search for multiple streams by collection using the server object's

0 commit comments

Comments
 (0)