Struct JoinOperatorMetrics 

pub struct JoinOperatorMetrics {

    pub query_id: Option<QueryId>,
    pub join_type: String,
    pub execution_strategy: String,
    pub key_count: usize,
    pub residual_predicate: bool,
    pub null_equality: String,
    pub build_side: String,
    pub probe_side: String,
    pub build_rows: u64,
    pub build_bytes: u64,
    pub probe_rows: u64,
    pub probe_bytes: u64,
    pub hash_table_bytes: u64,
    pub filtered_probe_state_bytes: u64,
    pub mixed_size_data_bytes: u64,
    pub gather_map_bytes: u64,
    pub output_reservation_bytes: Option<u64>,
    pub output_rows: u64,
    pub output_bytes: u64,
}

Join-specific operator metrics.

Fields

query_id: Option<QueryId>

Query-wide diagnostic correlation id, when assigned.

join_type: String

Join type label.

execution_strategy: String

Execution strategy label.

key_count: usize

Number of equality key pairs.

residual_predicate: bool

Whether a residual predicate was present.

null_equality: String

Null-equality policy label.

build_side: String

Planner orientation used to execute or describe this join.

For reusable hash joins this is the side that owns the hash table. For keyless conditional and cross joins no hash table is built. For those joins the value is an orientation label for comparable metrics, and no physical build artifact backs it.

probe_side: String

The side opposite build_side in the planner orientation.

build_rows: u64

Build-side input row count.

build_bytes: u64

Build-side input bytes.

probe_rows: u64

Probe-side input row count.

probe_bytes: u64

Probe-side input bytes.

hash_table_bytes: u64

Device bytes retained by the reusable cuDF join build artifact.

This is a direct cudf observation. For hash joins it is the retained hash table; for filtered joins it is the retained filtered-join build artifact. It remains 0 for join paths without a reusable build artifact.

filtered_probe_state_bytes: u64

Device bytes retained by a filtered-join probe state.

mixed_size_data_bytes: u64

Device bytes retained by a mixed join retained size-data state.

gather_map_bytes: u64

Device bytes retained by join gather maps produced for this join.

This is a direct cudf observation over the returned device index columns; no row-count estimate is involved.

output_reservation_bytes: Option<u64>

Upper bound of the join output’s materialized bytes, None when the byte model cannot bound one of its columns.

output_rows: u64

Join output row count.

output_bytes: u64

Join output bytes.

Implementations

impl JoinOperatorMetrics

pub fn to_json(&self) -> Value

Serializes this join-specific operator payload as named JSON.

Trait Implementations

impl Clone for JoinOperatorMetrics

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JoinOperatorMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JoinOperatorMetrics

fn default() -> Self

Returns the “default value” for a type.

impl Eq for JoinOperatorMetrics

impl PartialEq for JoinOperatorMetrics

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for JoinOperatorMetrics