Skip to main content

FactTableDetector

Struct FactTableDetector 

Source
pub struct FactTableDetector;
Expand description

Detects and introspects fact tables

Implementations§

Source§

impl FactTableDetector

Source

pub fn is_fact_table(table_name: &str) -> bool

Detect if a table name follows the fact table pattern.

Fact tables must follow the naming convention: tf_<table_name> where the table name contains only lowercase letters, numbers, and underscores.

§Arguments
  • table_name - Table name to check
§Returns

true if the table name starts with tf_ and follows naming conventions, false otherwise.

§Notes
  • The check is strict: tf_ is required as a prefix
  • Table names like TF_sales (uppercase prefix) are NOT recognized as fact tables
  • Empty strings and tables named just tf_ without additional suffix are not valid
§Examples
use fraiseql_core::compiler::fact_table::FactTableDetector;

assert!(FactTableDetector::is_fact_table("tf_sales"));
assert!(FactTableDetector::is_fact_table("tf_events"));
assert!(FactTableDetector::is_fact_table("tf_page_views_daily"));
assert!(!FactTableDetector::is_fact_table("ta_sales_by_day"));
assert!(!FactTableDetector::is_fact_table("v_user"));
assert!(!FactTableDetector::is_fact_table("TF_sales")); // uppercase prefix not recognized
assert!(!FactTableDetector::is_fact_table("tf_")); // incomplete name
Source

pub async fn introspect( introspector: &impl DatabaseIntrospector, table_name: &str, ) -> Result<FactTableMetadata>

Introspect a fact table from the database

Queries the database schema to extract:

  • Measures (numeric columns)
  • Dimensions (JSONB/JSON columns)
  • Denormalized filters (indexed columns)
§Arguments
  • introspector - Database introspection implementation
  • table_name - Fact table name (must start with “tf_”)
§Errors

Returns error if:

  • Table is not a fact table (doesn’t start with “tf_”)
  • Database query fails
  • Table structure is invalid
§Example
use fraiseql_core::compiler::fact_table::{FactTableDetector, DatabaseIntrospector};

let metadata = FactTableDetector::introspect(&db, "tf_sales").await?;
println!("Found {} measures", metadata.measures.len());
Source

pub fn validate(metadata: &FactTableMetadata) -> Result<()>

Validate fact table structure

§Errors

Returns error if:

  • No measures found
  • No dimension column found
  • Measures are not numeric types
Source

pub fn extract_dimension_paths( sample: &Value, column_name: &str, db_type: DatabaseType, ) -> Vec<DimensionPath>

Extract dimension paths from a sample JSON value

Walks through the JSON structure and extracts top-level keys as dimension paths. Nested objects are represented with dot notation (e.g., “customer.region”).

§Arguments
  • sample - Sample JSON value from the dimension column
  • column_name - Name of the JSONB column (e.g., “dimensions”)
  • db_type - Database type for generating correct JSON path syntax
§Returns

Vec of DimensionPath extracted from the sample data

Source

pub fn from_columns( table_name: String, columns: Vec<(&str, SqlType, bool)>, ) -> Result<FactTableMetadata>

Create metadata from column definitions (for testing)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more