1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
//! All the APIs used specifically for `re_dataframe`.
use std::collections::{BTreeMap, BTreeSet};
use arrow2::{
array::ListArray as ArrowListArray,
datatypes::{DataType as ArrowDatatype, Field as ArrowField},
};
use re_chunk::TimelineName;
use re_log_types::{ComponentPath, EntityPath, ResolvedTimeRange, TimeInt, Timeline};
use re_types_core::{ArchetypeName, ComponentName};
use crate::{ChunkStore, ColumnMetadata};
// --- Descriptors ---
// TODO(#6889): At some point all these descriptors needs to be interned and have handles or
// something. And of course they need to be codegen. But we'll get there once we're back to
// natively tagged components.
// Describes any kind of column.
//
// See:
// * [`TimeColumnDescriptor`]
// * [`ComponentColumnDescriptor`]
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ColumnDescriptor {
Time(TimeColumnDescriptor),
Component(ComponentColumnDescriptor),
}
impl ColumnDescriptor {
#[inline]
pub fn entity_path(&self) -> Option<&EntityPath> {
match self {
Self::Time(_) => None,
Self::Component(descr) => Some(&descr.entity_path),
}
}
#[inline]
pub fn datatype(&self) -> ArrowDatatype {
match self {
Self::Time(descr) => descr.datatype.clone(),
Self::Component(descr) => descr.returned_datatype(),
}
}
#[inline]
pub fn to_arrow_field(&self) -> ArrowField {
match self {
Self::Time(descr) => descr.to_arrow_field(),
Self::Component(descr) => descr.to_arrow_field(),
}
}
#[inline]
pub fn short_name(&self) -> String {
match self {
Self::Time(descr) => descr.timeline.name().to_string(),
Self::Component(descr) => descr.component_name.short_name().to_owned(),
}
}
#[inline]
pub fn is_static(&self) -> bool {
match self {
Self::Time(_) => false,
Self::Component(descr) => descr.is_static,
}
}
}
/// Describes a time column, such as `log_time`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TimeColumnDescriptor {
/// The timeline this column is associated with.
pub timeline: Timeline,
/// The Arrow datatype of the column.
pub datatype: ArrowDatatype,
}
impl PartialOrd for TimeColumnDescriptor {
#[inline]
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TimeColumnDescriptor {
#[inline]
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
let Self {
timeline,
datatype: _,
} = self;
timeline.cmp(&other.timeline)
}
}
impl TimeColumnDescriptor {
#[inline]
// Time column must be nullable since static data doesn't have a time.
pub fn to_arrow_field(&self) -> ArrowField {
let Self { timeline, datatype } = self;
ArrowField::new(
timeline.name().to_string(),
datatype.clone(),
true, /* nullable */
)
}
}
/// Describes a data/component column, such as `Position3D`.
//
// TODO(#6889): Fully sorbetize this thing? `ArchetypeName` and such don't make sense in that
// context. And whatever `archetype_field_name` ends up being, it needs interning.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ComponentColumnDescriptor {
/// The path of the entity.
pub entity_path: EntityPath,
/// Optional name of the `Archetype` associated with this data.
///
/// `None` if the data wasn't logged through an archetype.
///
/// Example: `rerun.archetypes.Points3D`.
pub archetype_name: Option<ArchetypeName>,
/// Optional name of the field within `Archetype` associated with this data.
///
/// `None` if the data wasn't logged through an archetype.
///
/// Example: `positions`.
pub archetype_field_name: Option<String>,
/// Semantic name associated with this data.
///
/// This is fully implied by `archetype_name` and `archetype_field`, but
/// included for semantic convenience.
///
/// Example: `rerun.components.Position3D`.
pub component_name: ComponentName,
/// The Arrow datatype of the stored column.
///
/// This is the log-time datatype corresponding to how this data is encoded
/// in a chunk. Currently this will always be an [`ArrowListArray`], but as
/// we introduce mono-type optimization, this might be a native type instead.
pub store_datatype: ArrowDatatype,
/// Whether this column represents static data.
pub is_static: bool,
/// Whether this column represents an indicator component.
pub is_indicator: bool,
/// Whether this column represents a [`Clear`]-related components.
///
/// [`Clear`]: re_types_core::archetypes::Clear
pub is_tombstone: bool,
/// Whether this column contains either no data or only contains null and/or empty values (`[]`).
pub is_semantically_empty: bool,
}
impl PartialOrd for ComponentColumnDescriptor {
#[inline]
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for ComponentColumnDescriptor {
#[inline]
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
let Self {
entity_path,
archetype_name,
archetype_field_name,
component_name,
store_datatype: _,
is_static: _,
is_indicator: _,
is_tombstone: _,
is_semantically_empty: _,
} = self;
entity_path
.cmp(&other.entity_path)
.then_with(|| component_name.cmp(&other.component_name))
.then_with(|| archetype_name.cmp(&other.archetype_name))
.then_with(|| archetype_field_name.cmp(&other.archetype_field_name))
}
}
impl std::fmt::Display for ComponentColumnDescriptor {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Self {
entity_path,
archetype_name,
archetype_field_name,
component_name,
store_datatype: _,
is_static,
is_indicator: _,
is_tombstone: _,
is_semantically_empty: _,
} = self;
let s = match (archetype_name, component_name, archetype_field_name) {
(None, component_name, None) => component_name.to_string(),
(Some(archetype_name), component_name, None) => format!(
"{entity_path}@{}::{}",
archetype_name.short_name(),
component_name.short_name(),
),
(None, component_name, Some(archetype_field_name)) => format!(
"{entity_path}@{}#{archetype_field_name}",
component_name.short_name(),
),
(Some(archetype_name), component_name, Some(archetype_field_name)) => format!(
"{entity_path}@{}::{}#{archetype_field_name}",
archetype_name.short_name(),
component_name.short_name(),
),
};
if *is_static {
f.write_fmt(format_args!("|{s}|"))
} else {
f.write_str(&s)
}
}
}
impl ComponentColumnDescriptor {
pub fn component_path(&self) -> ComponentPath {
ComponentPath {
entity_path: self.entity_path.clone(),
component_name: self.component_name,
}
}
#[inline]
pub fn matches(&self, entity_path: &EntityPath, component_name: &str) -> bool {
&self.entity_path == entity_path && self.component_name.matches(component_name)
}
fn metadata(&self) -> arrow2::datatypes::Metadata {
let Self {
entity_path,
archetype_name,
archetype_field_name,
component_name,
store_datatype: _,
is_static,
is_indicator,
is_tombstone,
is_semantically_empty,
} = self;
[
(*is_static).then_some(("sorbet.is_static".to_owned(), "yes".to_owned())),
(*is_indicator).then_some(("sorbet.is_indicator".to_owned(), "yes".to_owned())),
(*is_tombstone).then_some(("sorbet.is_tombstone".to_owned(), "yes".to_owned())),
(*is_semantically_empty)
.then_some(("sorbet.is_semantically_empty".to_owned(), "yes".to_owned())),
Some(("sorbet.path".to_owned(), entity_path.to_string())),
Some((
"sorbet.semantic_type".to_owned(),
component_name.short_name().to_owned(),
)),
archetype_name.map(|name| {
(
"sorbet.semantic_family".to_owned(),
name.short_name().to_owned(),
)
}),
archetype_field_name
.as_ref()
.map(|name| ("sorbet.logical_type".to_owned(), name.to_owned())),
]
.into_iter()
.flatten()
.collect()
}
#[inline]
pub fn returned_datatype(&self) -> ArrowDatatype {
self.store_datatype.clone()
}
#[inline]
pub fn to_arrow_field(&self) -> ArrowField {
ArrowField::new(
format!(
"{}:{}",
self.entity_path,
self.component_name.short_name().to_owned()
),
self.returned_datatype(),
true, /* nullable */
)
// TODO(#6889): This needs some proper sorbetization -- I just threw these names randomly.
.with_metadata(self.metadata())
}
}
// --- Selectors ---
/// Describes a column selection to return as part of a query.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ColumnSelector {
Time(TimeColumnSelector),
Component(ComponentColumnSelector),
//TODO(jleibs): Add support for archetype-based component selection.
//ArchetypeField(ArchetypeFieldColumnSelector),
}
impl From<ColumnDescriptor> for ColumnSelector {
#[inline]
fn from(desc: ColumnDescriptor) -> Self {
match desc {
ColumnDescriptor::Time(desc) => Self::Time(desc.into()),
ColumnDescriptor::Component(desc) => Self::Component(desc.into()),
}
}
}
impl From<TimeColumnSelector> for ColumnSelector {
#[inline]
fn from(desc: TimeColumnSelector) -> Self {
Self::Time(desc)
}
}
impl From<ComponentColumnSelector> for ColumnSelector {
#[inline]
fn from(desc: ComponentColumnSelector) -> Self {
Self::Component(desc)
}
}
/// Select a time column.
//
// TODO(cmc): This shouldn't be specific to time, this should be an `IndexColumnSelector` or smth.
// Particularly unfortunate that this one already leaks into the public API…
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TimeColumnSelector {
/// The name of the timeline.
pub timeline: TimelineName,
}
impl From<TimeColumnDescriptor> for TimeColumnSelector {
#[inline]
fn from(desc: TimeColumnDescriptor) -> Self {
Self {
timeline: *desc.timeline.name(),
}
}
}
/// Select a component based on its `EntityPath` and `ComponentName`.
///
/// Note, that in the future when Rerun supports duplicate tagged components
/// on the same entity, this selector may be ambiguous. In this case, the
/// query result will return an Error if it cannot determine a single selected
/// component.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ComponentColumnSelector {
/// The path of the entity.
pub entity_path: EntityPath,
/// Semantic name associated with this data.
///
/// This string will be flexibly matched against the available component names.
/// Valid matches are case invariant matches of either the full name or the short name.
pub component_name: String,
}
impl From<ComponentColumnDescriptor> for ComponentColumnSelector {
#[inline]
fn from(desc: ComponentColumnDescriptor) -> Self {
Self {
entity_path: desc.entity_path.clone(),
component_name: desc.component_name.to_string(),
}
}
}
impl ComponentColumnSelector {
/// Select a component of a given type, based on its [`EntityPath`]
#[inline]
pub fn new<C: re_types_core::Component>(entity_path: EntityPath) -> Self {
Self {
entity_path,
component_name: C::name().to_string(),
}
}
/// Select a component based on its [`EntityPath`] and [`ComponentName`].
#[inline]
pub fn new_for_component_name(entity_path: EntityPath, component_name: ComponentName) -> Self {
Self {
entity_path,
component_name: component_name.to_string(),
}
}
}
impl std::fmt::Display for ComponentColumnSelector {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Self {
entity_path,
component_name,
} = self;
f.write_fmt(format_args!("{entity_path}:{component_name}"))
}
}
// TODO(jleibs): Add support for archetype-based column selection.
/*
/// Select a component based on its `Archetype` and field.
pub struct ArchetypeFieldColumnSelector {
/// The path of the entity.
entity_path: EntityPath,
/// Name of the `Archetype` associated with this data.
archetype: ArchetypeName,
/// The field within the `Archetype` associated with this data.
field: String,
}
*/
// --- Queries v2 ---
/// Specifies how null values should be filled in the returned dataframe.
#[derive(Default, Debug, Clone, PartialEq, Eq, Hash)]
pub enum SparseFillStrategy {
/// No sparse filling. Nulls stay nulls.
#[default]
None,
/// Fill null values using global-scope latest-at semantics.
///
/// The latest-at semantics are applied on the entire dataset as opposed to just the current
/// view contents: it is possible to end up with values from outside the view!
LatestAtGlobal,
//
// TODO(cmc): `LatestAtView`?
}
impl std::fmt::Display for SparseFillStrategy {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::None => f.write_str("none"),
Self::LatestAtGlobal => f.write_str("latest-at (global)"),
}
}
}
/// The view contents specify which subset of the database (i.e., which columns) the query runs on,
/// expressed as a set of [`EntityPath`]s and their associated [`ComponentName`]s.
///
/// Setting an entity's components to `None` means: everything.
///
// TODO(cmc): we need to be able to build that easily in a command-line context, otherwise it's just
// very annoying. E.g. `--with /world/points:[rr.Position3D, rr.Radius] --with /cam:[rr.Pinhole]`.
pub type ViewContentsSelector = BTreeMap<EntityPath, Option<BTreeSet<ComponentName>>>;
// TODO(cmc): Ultimately, this shouldn't be hardcoded to `Timeline`, but to a generic `I: Index`.
// `Index` in this case should also be implemented on tuples (`(I1, I2, ...)`).
pub type Index = Timeline;
// TODO(cmc): Ultimately, this shouldn't be hardcoded to `TimeInt`, but to a generic `I: Index`.
// `Index` in this case should also be implemented on tuples (`(I1, I2, ...)`).
pub type IndexValue = TimeInt;
// TODO(cmc): Ultimately, this shouldn't be hardcoded to `ResolvedTimeRange`, but to a generic `I: Index`.
// `Index` in this case should also be implemented on tuples (`(I1, I2, ...)`).
pub type IndexRange = ResolvedTimeRange;
/// Describes a complete query for Rerun's dataframe API.
///
/// ## Terminology: view vs. selection vs. filtering vs. sampling
///
/// * The view contents specify which subset of the database (i.e., which columns) the query runs on,
/// expressed as a set of [`EntityPath`]s and their associated [`ComponentName`]s.
///
/// * The filters filter out _rows_ of data from the view contents.
/// A filter cannot possibly introduce new rows, it can only remove existing ones from the view contents.
///
/// * The samplers sample _rows_ of data from the view contents at user-specified values.
/// Samplers don't necessarily return existing rows: they might introduce new ones if the sampled value
/// isn't present in the view contents in the first place.
///
/// * The selection applies last and samples _columns_ of data from the filtered/sampled view contents.
/// Selecting a column that isn't present in the view contents results in an empty column in the
/// final dataframe (null array).
///
/// A very rough mental model, in SQL terms:
/// ```text
/// SELECT <Self::selection> FROM <Self::view_contents> WHERE <Self::filtered_*>
/// ```
//
// TODO(cmc): ideally we'd like this to be the same type as the one used in the blueprint, possibly?
#[derive(Default, Debug, Clone, PartialEq, Eq, Hash)]
pub struct QueryExpression {
/// The subset of the database that the query will run on: a set of [`EntityPath`]s and their
/// associated [`ComponentName`]s.
///
/// Defaults to `None`, which means: everything.
///
/// Example (pseudo-code):
/// ```text
/// view_contents = {
/// "world/points": [rr.Position3D, rr.Radius],
/// "metrics": [rr.Scalar]
/// }
/// ```
pub view_contents: Option<ViewContentsSelector>,
/// Whether the `view_contents` should ignore semantically empty columns.
///
/// A semantically empty column is a column that either contains no data at all, or where all
/// values are either nulls or empty arrays (`[]`).
///
/// `view_contents`: [`QueryExpression::view_contents`]
pub include_semantically_empty_columns: bool,
/// Whether the `view_contents` should ignore columns corresponding to indicator components.
///
/// Indicator components are marker components, generally automatically inserted by Rerun, that
/// helps keep track of the original context in which a piece of data was logged/sent.
///
/// `view_contents`: [`QueryExpression::view_contents`]
pub include_indicator_columns: bool,
/// Whether the `view_contents` should ignore columns corresponding to `Clear`-related components.
///
/// `view_contents`: [`QueryExpression::view_contents`]
/// `Clear`: [`re_types_core::archetypes::Clear`]
pub include_tombstone_columns: bool,
/// The index used to filter out _rows_ from the view contents.
///
/// Only rows where at least 1 column contains non-null data at that index will be kept in the
/// final dataset.
///
/// If left unspecified, the results will only contain static data.
///
/// Examples: `Some(Timeline("frame"))`, `None` (only static data).
//
// TODO(cmc): this has to be a selector otherwise this is a horrible UX.
pub filtered_index: Option<Index>,
/// The range of index values used to filter out _rows_ from the view contents.
///
/// Only rows where at least 1 of the view-contents contains non-null data within that range will be kept in
/// the final dataset.
///
/// * This has no effect if `filtered_index` isn't set.
/// * This has no effect if [`QueryExpression::using_index_values`] is set.
///
/// Example: `ResolvedTimeRange(10, 20)`.
pub filtered_index_range: Option<IndexRange>,
/// The specific index values used to filter out _rows_ from the view contents.
///
/// Only rows where at least 1 column contains non-null data at these specific values will be kept
/// in the final dataset.
///
/// * This has no effect if `filtered_index` isn't set.
/// * This has no effect if [`QueryExpression::using_index_values`] is set.
/// * Using [`TimeInt::STATIC`] as index value has no effect.
///
/// Example: `[TimeInt(12), TimeInt(14)]`.
pub filtered_index_values: Option<BTreeSet<IndexValue>>,
/// The specific index values used to sample _rows_ from the view contents.
///
/// The final dataset will contain one row per sampled index value, regardless of whether data
/// existed for that index value in the view contents.
/// The semantics of the query are consistent with all other settings: the results will be
/// sorted on the `filtered_index`, and only contain unique index values.
///
/// * This has no effect if `filtered_index` isn't set.
/// * If set, this overrides both [`QueryExpression::filtered_index_range`] and
/// [`QueryExpression::filtered_index_values`].
/// * Using [`TimeInt::STATIC`] as index value has no effect.
///
/// Example: `[TimeInt(12), TimeInt(14)]`.
pub using_index_values: Option<BTreeSet<IndexValue>>,
/// The component column used to filter out _rows_ from the view contents.
///
/// Only rows where this column contains non-null data be kept in the final dataset.
///
/// Example: `ComponentColumnSelector("rerun.components.Position3D")`.
//
// TODO(cmc): multi-pov support
pub filtered_is_not_null: Option<ComponentColumnSelector>,
/// Specifies how null values should be filled in the returned dataframe.
///
/// Defaults to [`SparseFillStrategy::None`].
pub sparse_fill_strategy: SparseFillStrategy,
/// The specific _columns_ to sample from the final view contents.
///
/// The order of the samples will be respected in the final result.
///
/// Defaults to `None`, which means: everything.
///
/// Example: `[ColumnSelector(Time("log_time")), ColumnSelector(Component("rerun.components.Position3D"))]`.
//
// TODO(cmc): the selection has to be on the QueryHandle, otherwise it's hell to use.
pub selection: Option<Vec<ColumnSelector>>,
}
// ---
impl ChunkStore {
/// Returns the full schema of the store.
///
/// This will include a column descriptor for every timeline and every component on every
/// entity that has been written to the store so far.
///
/// The order of the columns is guaranteed to be in a specific order:
/// * first, the time columns in lexical order (`frame_nr`, `log_time`, ...);
/// * second, the component columns in lexical order (`Color`, `Radius, ...`).
pub fn schema(&self) -> Vec<ColumnDescriptor> {
re_tracing::profile_function!();
let timelines = self.all_timelines().into_iter().map(|timeline| {
ColumnDescriptor::Time(TimeColumnDescriptor {
timeline,
datatype: timeline.datatype(),
})
});
let components = self
.per_column_metadata
.iter()
.flat_map(|(entity_path, per_component)| {
per_component
.keys()
.map(move |component_name| (entity_path, component_name))
})
.filter_map(|(entity_path, component_name)| {
let metadata = self.lookup_column_metadata(entity_path, component_name)?;
let datatype = self.lookup_datatype(component_name)?;
Some(((entity_path, component_name), (metadata, datatype)))
})
.map(|((entity_path, component_name), (metadata, datatype))| {
let ColumnMetadata {
is_static,
is_indicator,
is_tombstone,
is_semantically_empty,
} = metadata;
// TODO(#6889): Fill `archetype_name`/`archetype_field_name` (or whatever their
// final name ends up being) once we generate tags.
ColumnDescriptor::Component(ComponentColumnDescriptor {
entity_path: entity_path.clone(),
archetype_name: None,
archetype_field_name: None,
component_name: *component_name,
// NOTE: The data is always a at least a list, whether it's latest-at or range.
// It might be wrapped further in e.g. a dict, but at the very least
// it's a list.
store_datatype: ArrowListArray::<i32>::default_datatype(datatype.clone()),
is_static,
is_indicator,
is_tombstone,
is_semantically_empty,
})
});
timelines.chain(components).collect()
}
/// Given a [`TimeColumnSelector`], returns the corresponding [`TimeColumnDescriptor`].
pub fn resolve_time_selector(&self, selector: &TimeColumnSelector) -> TimeColumnDescriptor {
let timelines = self.all_timelines();
let timeline = timelines
.iter()
.find(|timeline| timeline.name() == &selector.timeline)
.copied()
.unwrap_or_else(|| Timeline::new_temporal(selector.timeline));
TimeColumnDescriptor {
timeline,
datatype: timeline.datatype(),
}
}
/// Given a [`ComponentColumnSelector`], returns the corresponding [`ComponentColumnDescriptor`].
///
/// If the component is not found in the store, a default descriptor is returned with a null datatype.
pub fn resolve_component_selector(
&self,
selector: &ComponentColumnSelector,
) -> ComponentColumnDescriptor {
// Happy path if this string is a valid component
// TODO(#7699) This currently interns every string ever queried which could be wasteful, especially
// in long-running servers. In practice this probably doesn't matter.
let direct_component = ComponentName::from(selector.component_name.clone());
let component_name = if self.all_components().contains(&direct_component) {
direct_component
} else {
self.all_components_for_entity(&selector.entity_path)
// First just check on the entity since this is the most likely place to find it.
.and_then(|components| {
components
.into_iter()
.find(|component_name| component_name.matches(&selector.component_name))
})
// Fall back on matching any component in the store
.or_else(|| {
self.all_components()
.into_iter()
.find(|component_name| component_name.matches(&selector.component_name))
})
// Finally fall back on the direct component name
.unwrap_or(direct_component)
};
let ColumnMetadata {
is_static,
is_indicator,
is_tombstone,
is_semantically_empty,
} = self
.lookup_column_metadata(&selector.entity_path, &component_name)
.unwrap_or(ColumnMetadata {
is_static: false,
is_indicator: false,
is_tombstone: false,
is_semantically_empty: false,
});
let datatype = self
.lookup_datatype(&component_name)
.cloned()
.unwrap_or_else(|| ArrowDatatype::Null);
ComponentColumnDescriptor {
entity_path: selector.entity_path.clone(),
archetype_name: None,
archetype_field_name: None,
component_name,
store_datatype: ArrowListArray::<i32>::default_datatype(datatype.clone()),
is_static,
is_indicator,
is_tombstone,
is_semantically_empty,
}
}
/// Given a set of [`ColumnSelector`]s, returns the corresponding [`ColumnDescriptor`]s.
pub fn resolve_selectors(
&self,
selectors: impl IntoIterator<Item = impl Into<ColumnSelector>>,
) -> Vec<ColumnDescriptor> {
// TODO(jleibs): When, if ever, should this return an error?
selectors
.into_iter()
.map(|selector| {
let selector = selector.into();
match selector {
ColumnSelector::Time(selector) => {
ColumnDescriptor::Time(self.resolve_time_selector(&selector))
}
ColumnSelector::Component(selector) => {
ColumnDescriptor::Component(self.resolve_component_selector(&selector))
}
}
})
.collect()
}
/// Returns the filtered schema for the given [`QueryExpression`].
///
/// The order of the columns is guaranteed to be in a specific order:
/// * first, the time columns in lexical order (`frame_nr`, `log_time`, ...);
/// * second, the component columns in lexical order (`Color`, `Radius, ...`).
pub fn schema_for_query(&self, query: &QueryExpression) -> Vec<ColumnDescriptor> {
re_tracing::profile_function!();
let QueryExpression {
view_contents,
include_semantically_empty_columns,
include_indicator_columns,
include_tombstone_columns,
filtered_index: _,
filtered_index_range: _,
filtered_index_values: _,
using_index_values: _,
filtered_is_not_null: _,
sparse_fill_strategy: _,
selection: _,
} = query;
let filter = |column: &ComponentColumnDescriptor| {
let is_part_of_view_contents = || {
view_contents.as_ref().map_or(true, |view_contents| {
view_contents
.get(&column.entity_path)
.map_or(false, |components| {
components.as_ref().map_or(true, |components| {
components.contains(&column.component_name)
})
})
})
};
let passes_semantically_empty_check =
|| *include_semantically_empty_columns || !column.is_semantically_empty;
let passes_indicator_check = || *include_indicator_columns || !column.is_indicator;
let passes_tombstone_check = || *include_tombstone_columns || !column.is_tombstone;
is_part_of_view_contents()
&& passes_semantically_empty_check()
&& passes_indicator_check()
&& passes_tombstone_check()
};
self.schema()
.into_iter()
.filter(|column| match column {
ColumnDescriptor::Time(_) => true,
ColumnDescriptor::Component(column) => filter(column),
})
.collect()
}
}