logo
  • Getting Started
  • User Guide
  • API reference
  • Release Notes
  • Support
  • 4Insight.io
  • Manage series
  • Manage metadata
  • Browse and search
  • Do’s and don’ts
  • Advanced Configuration
  • Cookbook
On this page
  • Browse metadata
  • Search for metadata
  • Search for series

Browse and search¶

Browse metadata¶

You can browse metadata, and search for metadata and series data through datareservoirio. Lets see how you can browse metadata entries:

# List all available namespaces
namespaces = client.metadata_browse(namespace=None, key=None)

# List all keys under a give namespace
keys = client.metadata_browse(namespace='foo.bar')

# List all namespaces that contains a given namespace
key_namspaces = client.metadata_browse(key='baz')

# Get a specific entry (dict)
keys = client.metadata_browse(namespace='foo.bar', key='baz')

Search for metadata¶

You can also search for metadata:

# Search for *namespace* OR *key*
metadata_list = client.metadata_search('foo.bar', 'baz', conjunctive=False)

# Search for *namespace* AND *key*
metadata_list = client.metadata_search('foo.bar', 'baz', conjunctive=True)

Note

The search is “fuzzy” as it looks for matches with “wildcard + search term + wildcard”. It is recommended to be as specific as possible for best performance.

Search for series¶

In addition, you can search directly for series based on metadata associated with it:

# Get all series that have metadata that satisfies a search:
# namespace + key* + name + value (optional)

series_ids_list = client.search('foo.bar', 'baz', 'sensor_vendor')

series_ids_dict = client.search('foo.bar', 'baz', 'sensor_vendor',
                                value='Sensor Corp')

previous

Manage metadata

next

Do’s and don’ts

© Copyright 2021, 4Subsea.

Created using Sphinx 4.2.0.