Misc documentation

This commit is contained in:
Jim Paris 2013-07-25 16:08:35 -04:00
parent 6cd28b67b1
commit a1850c9c2c

View File

@ -58,6 +58,10 @@ class Client(object):
return self.http.get("dbinfo")
def stream_list(self, path = None, layout = None, extended = False):
"""Return a sorted list of [path,layout] lists. If 'path' or
'layout' are specified, only return streams that match those
exact values. If 'extended' is True, the returned lists are
is [path,layout,extent_min,extent_max,total_rows,total_seconds]."""
params = {}
if path is not None:
params["path"] = path
@ -69,6 +73,7 @@ class Client(object):
return nilmdb.utils.sort.sort_human(streams, key = lambda s: s[0])
def stream_get_metadata(self, path, keys = None):
"""Get stream metadata"""
params = { "path": path }
if keys is not None:
params["key"] = keys