Dataframes
Rerun, at its core, is a database. As such, you can always get your data back in the form of tables (also known as dataframes, or records, or batches...).
This can be achieved in three different ways, depending on your needs:
- using the dataframe API, currently available in Python and Rust,
- using the blueprint API to configure a dataframe view from code,
- or simply by setting up dataframe view manually in the UI.
This page is meant as a reference to get you up and running with these different solutions as quickly as possible. For an in-depth introduction to the dataframe API and the possible workflows it enables, check out our Getting Started guide or one of the accompanying How-Tos.
We'll need an RRD file to query. Either use one of yours, or grab some of the example ones, e.g.:
curl 'https://app.rerun.io/version/latest/examples/dna.rrd' -o - > /tmp/dna.rrd
Using the dataframe API using-the-dataframe-api
The following snippet demonstrates how to query the first 10 rows in a Rerun recording:
"""Query and display the first 10 rows of a recording."""
import sys
import rerun as rr
path_to_rrd = sys.argv[1]
recording = rr.dataframe.load_recording(path_to_rrd)
view = recording.view(index="log_time", contents="/**")
batches = view.select()
for _ in range(10):
row = batches.read_next_batch()
if row is None:
break
# Each row is a `RecordBatch`, which can be easily passed around across different data ecosystems.
print(row)
Check out the API reference to learn more about all the ways that data can be searched and filtered:
Using the blueprint API to configure a dataframe view using-the-blueprint-api-to-configure-a-dataframe-view
TODO(cmc): incoming.
Check out the blueprint API reference to learn more about all the ways that data can be searched and filtered:
Setting up dataframe view manually in the UI setting-up-dataframe-view-manually-in-the-ui
TODO(cmc): incoming.