Skip to content

Commit

Permalink
Dataframe view update and blueprint API (part 6): cleanup (#7573)
Browse files Browse the repository at this point in the history
### What

- Closes #6896 
- Closes #7498

Final PR in the series. Pure cleanup.
- removes dead fbs
- rename stuff
- mark stuff as unreleased
- rename `schema` to `view_columns` or `selected_columns`, depending on
context (see [this
comment](#7527 (comment)))

<hr>

Part of a series to address #6896 and #7498.

All PRs:
- #7515
- #7516
- #7527 
- #7545
- #7551
- #7572
- #7573


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7573?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7573?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/7573)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
  • Loading branch information
abey79 authored Oct 3, 2024
1 parent 5d0c7ff commit 60ce5dc
Showing 77 changed files with 261 additions and 3,867 deletions.
Original file line number Diff line number Diff line change
@@ -1,63 +1,12 @@
namespace rerun.blueprint.archetypes;


// Rationale behind the present data modelling:
// - Avoid using `union` at all cost.
// - An explicit "mode" enum maps well with a UI toggle and API parameter, and enabled a hard disambiguation when
// settings are present for both the latest-at and range modes.
// - Timestamps are hard-invalidated by a change of timeline. So we keep them on a per-timeline basis.

// TODO(#7067): add visible components (maybe in another archetype?)
// TODO(#7072): add (optional) PoV components
// Note: component list should be modelled as:
// component PovComponents {
// datatype ComponentNames {
// value: [string];
// }
// }
//
// Motivation:
// - Chances are high that the user prefers to have their pov components _not_ invalidated by a changeof timeline.
// - That is even though a component might _technically_ be soft-invalidated by a change of timeline (e.g. if it was
// not logged on that particular timeline). But we have to deal regardless with potentially invalid component, so this
// doesn't change the story much.

// --

/// The query for the dataframe view.
//TODO(ab): replace by DataframeQueryV2 when ready
table DataframeQuery (
"attr.rerun.scope": "blueprint"
) {
// --- Optional ---

/// The timeline for this query.
///
/// If unset, use the time panel's timeline and a latest-at query, ignoring all other components of this archetype.
timeline: rerun.blueprint.components.TimelineName ("attr.rerun.component_optional", nullable, order: 100);

/// Kind of query: latest-at or range.
kind: rerun.blueprint.components.QueryKind ("attr.rerun.component_optional", nullable,order: 200);

/// Configuration for latest-at queries.
///
/// Note: configuration as saved on a per-timeline basis.
latest_at_queries: rerun.blueprint.components.LatestAtQueries ("attr.rerun.component_optional", nullable,order: 400);

/// Configuration for the time range queries.
///
/// Note: configuration as saved on a per-timeline basis.
time_range_queries: rerun.blueprint.components.TimeRangeQueries ("attr.rerun.component_optional", nullable,order: 500);
}



/// The query for the dataframe view.
table DataframeQueryV2 (
"attr.rerun.scope": "blueprint"
) {
// --- Optional ---

/// The timeline for this query.
///
/// If unset, the timeline currently active on the time panel is used.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

This file was deleted.

This file was deleted.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -7,8 +7,9 @@ namespace rerun.blueprint.views;
/// \example views/dataframe title="Use a blueprint to customize a DataframeView."
//TODO(#6896): add a thumbnail when the example becomes interesting
table DataframeView (
"attr.rerun.view_identifier": "Dataframe"
"attr.rerun.view_identifier": "Dataframe",
"attr.docs.unreleased"
) {
/// Query of the dataframe.
query: rerun.blueprint.archetypes.DataframeQueryV2 (order: 1000);
query: rerun.blueprint.archetypes.DataframeQuery (order: 1000);
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 60ce5dc

Please sign in to comment.