pub struct CubeSchema { /* private fields */ }Expand description
Schema metadata for an ElastiCube
Contains all metadata about dimensions, measures, and hierarchies, providing a semantic layer over the raw Arrow data.
Implementations§
Source§impl CubeSchema
impl CubeSchema
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
Get the description
Sourcepub fn set_description(&mut self, description: impl Into<String>)
pub fn set_description(&mut self, description: impl Into<String>)
Set the description
Sourcepub fn add_dimension(&mut self, dimension: Dimension) -> Result<()>
pub fn add_dimension(&mut self, dimension: Dimension) -> Result<()>
Add a dimension to the schema
Sourcepub fn add_measure(&mut self, measure: Measure) -> Result<()>
pub fn add_measure(&mut self, measure: Measure) -> Result<()>
Add a measure to the schema
Sourcepub fn add_hierarchy(&mut self, hierarchy: Hierarchy) -> Result<()>
pub fn add_hierarchy(&mut self, hierarchy: Hierarchy) -> Result<()>
Add a hierarchy to the schema
Sourcepub fn dimensions(&self) -> Vec<&Dimension>
pub fn dimensions(&self) -> Vec<&Dimension>
Get all dimensions
Sourcepub fn hierarchies(&self) -> Vec<&Hierarchy>
pub fn hierarchies(&self) -> Vec<&Hierarchy>
Get all hierarchies
Sourcepub fn get_dimension(&self, name: &str) -> Option<&Dimension>
pub fn get_dimension(&self, name: &str) -> Option<&Dimension>
Get a dimension by name
Sourcepub fn get_dimension_mut(&mut self, name: &str) -> Option<&mut Dimension>
pub fn get_dimension_mut(&mut self, name: &str) -> Option<&mut Dimension>
Get a mutable dimension by name
Sourcepub fn get_measure(&self, name: &str) -> Option<&Measure>
pub fn get_measure(&self, name: &str) -> Option<&Measure>
Get a measure by name
Sourcepub fn get_measure_mut(&mut self, name: &str) -> Option<&mut Measure>
pub fn get_measure_mut(&mut self, name: &str) -> Option<&mut Measure>
Get a mutable measure by name
Sourcepub fn get_hierarchy(&self, name: &str) -> Option<&Hierarchy>
pub fn get_hierarchy(&self, name: &str) -> Option<&Hierarchy>
Get a hierarchy by name
Sourcepub fn remove_dimension(&mut self, name: &str) -> Result<Dimension>
pub fn remove_dimension(&mut self, name: &str) -> Result<Dimension>
Remove a dimension
Sourcepub fn remove_measure(&mut self, name: &str) -> Result<Measure>
pub fn remove_measure(&mut self, name: &str) -> Result<Measure>
Remove a measure
Sourcepub fn remove_hierarchy(&mut self, name: &str) -> Result<Hierarchy>
pub fn remove_hierarchy(&mut self, name: &str) -> Result<Hierarchy>
Remove a hierarchy
Sourcepub fn dimension_count(&self) -> usize
pub fn dimension_count(&self) -> usize
Get the number of dimensions
Sourcepub fn measure_count(&self) -> usize
pub fn measure_count(&self) -> usize
Get the number of measures
Sourcepub fn hierarchy_count(&self) -> usize
pub fn hierarchy_count(&self) -> usize
Get the number of hierarchies
Sourcepub fn has_dimension(&self, name: &str) -> bool
pub fn has_dimension(&self, name: &str) -> bool
Check if a dimension exists
Sourcepub fn has_measure(&self, name: &str) -> bool
pub fn has_measure(&self, name: &str) -> bool
Check if a measure exists
Sourcepub fn has_hierarchy(&self, name: &str) -> bool
pub fn has_hierarchy(&self, name: &str) -> bool
Check if a hierarchy exists
Sourcepub fn dimension_names(&self) -> Vec<&str>
pub fn dimension_names(&self) -> Vec<&str>
Get all dimension names
Sourcepub fn measure_names(&self) -> Vec<&str>
pub fn measure_names(&self) -> Vec<&str>
Get all measure names
Sourcepub fn hierarchy_names(&self) -> Vec<&str>
pub fn hierarchy_names(&self) -> Vec<&str>
Get all hierarchy names
Sourcepub fn add_calculated_measure(
&mut self,
calc_measure: CalculatedMeasure,
) -> Result<()>
pub fn add_calculated_measure( &mut self, calc_measure: CalculatedMeasure, ) -> Result<()>
Add a calculated measure to the schema
Sourcepub fn add_virtual_dimension(
&mut self,
virtual_dim: VirtualDimension,
) -> Result<()>
pub fn add_virtual_dimension( &mut self, virtual_dim: VirtualDimension, ) -> Result<()>
Add a virtual dimension to the schema
Sourcepub fn calculated_measures(&self) -> Vec<&CalculatedMeasure>
pub fn calculated_measures(&self) -> Vec<&CalculatedMeasure>
Get all calculated measures
Sourcepub fn virtual_dimensions(&self) -> Vec<&VirtualDimension>
pub fn virtual_dimensions(&self) -> Vec<&VirtualDimension>
Get all virtual dimensions
Sourcepub fn get_calculated_measure(&self, name: &str) -> Option<&CalculatedMeasure>
pub fn get_calculated_measure(&self, name: &str) -> Option<&CalculatedMeasure>
Get a calculated measure by name
Sourcepub fn get_virtual_dimension(&self, name: &str) -> Option<&VirtualDimension>
pub fn get_virtual_dimension(&self, name: &str) -> Option<&VirtualDimension>
Get a virtual dimension by name
Sourcepub fn remove_calculated_measure(
&mut self,
name: &str,
) -> Result<CalculatedMeasure>
pub fn remove_calculated_measure( &mut self, name: &str, ) -> Result<CalculatedMeasure>
Remove a calculated measure
Sourcepub fn remove_virtual_dimension(
&mut self,
name: &str,
) -> Result<VirtualDimension>
pub fn remove_virtual_dimension( &mut self, name: &str, ) -> Result<VirtualDimension>
Remove a virtual dimension
Sourcepub fn has_calculated_measure(&self, name: &str) -> bool
pub fn has_calculated_measure(&self, name: &str) -> bool
Check if a calculated measure exists
Sourcepub fn has_virtual_dimension(&self, name: &str) -> bool
pub fn has_virtual_dimension(&self, name: &str) -> bool
Check if a virtual dimension exists
Sourcepub fn calculated_measure_count(&self) -> usize
pub fn calculated_measure_count(&self) -> usize
Get the number of calculated measures
Sourcepub fn virtual_dimension_count(&self) -> usize
pub fn virtual_dimension_count(&self) -> usize
Get the number of virtual dimensions
Sourcepub fn to_arrow_schema(&self) -> Schema
pub fn to_arrow_schema(&self) -> Schema
Convert CubeSchema to Arrow Schema
Creates an Arrow schema containing fields for all dimensions and measures. The order is: dimensions first (in insertion order), then measures.
Trait Implementations§
Source§impl Clone for CubeSchema
impl Clone for CubeSchema
Source§fn clone(&self) -> CubeSchema
fn clone(&self) -> CubeSchema
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CubeSchema
impl Debug for CubeSchema
Source§impl<'de> Deserialize<'de> for CubeSchema
impl<'de> Deserialize<'de> for CubeSchema
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for CubeSchema
impl RefUnwindSafe for CubeSchema
impl Send for CubeSchema
impl Sync for CubeSchema
impl Unpin for CubeSchema
impl UnwindSafe for CubeSchema
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more