Struct spacetimedb::execution_context::ExecutionContext

pub struct ExecutionContext {
    pub metrics: Arc<RwLock<Metrics>>,
    pub slow_query_config: SlowQueryConfig,
    /* private fields */
}

Represents the context under which a database runtime method is executed. In particular it provides details about the currently executing txn to runtime operations. More generally it acts as a container for information that database operations may require to function correctly.

Fields

metrics: Arc<RwLock<Metrics>>

The Metrics to be reported for this transaction.

slow_query_config: SlowQueryConfig

Configuration threshold for detecting slow queries.

Implementations

impl ExecutionContext

pub fn reducer(database: Address, ctx: ReducerContext) -> Self

Returns an ExecutionContext for a reducer transaction.

pub fn sql(database: Address, slow_query_config: SlowQueryConfig) -> Self

Returns an ExecutionContext for a one-off sql query.

pub fn subscribe(database: Address, slow_query_config: SlowQueryConfig) -> Self

Returns an ExecutionContext for an initial subscribe call.

pub fn incremental_update( database: Address, slow_query_config: SlowQueryConfig ) -> Self

Returns an ExecutionContext for a subscription update.

pub fn internal(database: Address) -> Self

Returns an ExecutionContext for an internal database operation.

pub fn database(&self) -> Address

Returns the address of the database on which we are operating.

pub fn reducer_name(&self) -> &str

If this is a reducer context, returns the name of the reducer.

pub fn reducer_context(&self) -> Option<&ReducerContext>

If this is a reducer context, returns the full reducer metadata.

pub fn workload(&self) -> WorkloadType

Returns the type of workload that is being executed.

Trait Implementations

impl Clone for ExecutionContext

fn clone(&self) -> ExecutionContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ExecutionContext

fn default() -> ExecutionContext

Returns the “default value” for a type.

impl Drop for ExecutionContext

fn drop(&mut self)

Executes the destructor for this type.