Struct QueryContext 

pub struct QueryContext {
    current_catalog: String,
    snapshot_seqs: Arc<RwLock<HashMap<u64, u64>>>,
    sst_min_sequences: Arc<RwLock<HashMap<u64, u64>>>,
    mutable_session_data: Arc<RwLock<MutableInner>>,
    mutable_query_context_data: Arc<RwLock<QueryContextMutableFields>>,
    sql_dialect: Arc<dyn Dialect + Send + Sync>,
    extensions: HashMap<String, String>,
    configuration_parameter: Arc<ConfigurationVariables>,
    channel: Channel,
    process_id: u32,
    conn_info: ConnInfo,
    protocol_ctx: ProtocolCtx,
}

Fields

current_catalog: String

snapshot_seqs: Arc<RwLock<HashMap<u64, u64>>>

mapping of RegionId to SequenceNumber, for snapshot read, meaning that the read should only container data that was committed before(and include) the given sequence number this field will only be filled if extensions contains a pair of “snapshot_read” and “true”

sst_min_sequences: Arc<RwLock<HashMap<u64, u64>>>

Mappings of the RegionId to the minimal sequence of SST file to scan.

mutable_session_data: Arc<RwLock<MutableInner>>

mutable_query_context_data: Arc<RwLock<QueryContextMutableFields>>

sql_dialect: Arc<dyn Dialect + Send + Sync>

extensions: HashMap<String, String>

configuration_parameter: Arc<ConfigurationVariables>

The configuration parameter are used to store the parameters that are set by the user

channel: Channel

Track which protocol the query comes from.

process_id: u32

Process id for managing on-going queries

conn_info: ConnInfo

Connection information

protocol_ctx: ProtocolCtx

Protocol specific context

Implementations

impl QueryContext

pub fn arc() -> QueryContextRef

pub fn create_config_options(&self) -> ConfigOptions

Create a new datafusion’s ConfigOptions instance based on the current QueryContext.

pub fn with(catalog: &str, schema: &str) -> QueryContext

pub fn with_channel( catalog: &str, schema: &str, channel: Channel, ) -> QueryContext

pub fn with_db_name(db_name: Option<&str>) -> QueryContext

pub fn current_schema(&self) -> String

pub fn set_current_schema(&self, new_schema: &str)

pub fn current_catalog(&self) -> &str

pub fn set_current_catalog(&mut self, new_catalog: &str)

pub fn sql_dialect(&self) -> &(dyn Dialect + Send + Sync)

pub fn get_db_string(&self) -> String

pub fn timezone(&self) -> Timezone

pub fn set_timezone(&self, timezone: Timezone)

pub fn read_preference(&self) -> ReadPreference

pub fn set_read_preference(&self, read_preference: ReadPreference)

pub fn current_user(&self) -> UserInfoRef

pub fn set_current_user(&self, user: UserInfoRef)

pub fn set_extension<S1: Into<String>, S2: Into<String>>( &mut self, key: S1, value: S2, )

pub fn extension<S: AsRef<str>>(&self, key: S) -> Option<&str>

pub fn extensions(&self) -> HashMap<String, String>

pub fn quote_style(&self) -> char

Default to double quote and fallback to back quote

pub fn configuration_parameter(&self) -> &ConfigurationVariables

pub fn channel(&self) -> Channel

pub fn set_channel(&mut self, channel: Channel)

pub fn warning(&self) -> Option<String>

pub fn set_warning(&self, msg: String)

pub fn explain_format(&self) -> Option<String>

pub fn set_explain_format(&self, format: String)

pub fn explain_verbose(&self) -> bool

pub fn set_explain_verbose(&self, verbose: bool)

pub fn query_timeout(&self) -> Option<Duration>

pub fn query_timeout_as_millis(&self) -> u128

pub fn set_query_timeout(&self, timeout: Duration)

pub fn insert_cursor(&self, name: String, rb: RecordBatchStreamCursor)

pub fn remove_cursor(&self, name: &str)

pub fn get_cursor(&self, name: &str) -> Option<Arc<RecordBatchStreamCursor>>

pub fn snapshots(&self) -> HashMap<u64, u64>

pub fn get_snapshot(&self, region_id: u64) -> Option<u64>

pub fn auto_string_to_numeric(&self) -> bool

Returns true if the session can cast strings to numbers in MySQL style.

pub fn sst_min_sequence(&self, region_id: u64) -> Option<u64>

Finds the minimal sequence of SST files to scan of a Region.

pub fn process_id(&self) -> u32

pub fn conn_info(&self) -> &ConnInfo

Get client information

pub fn protocol_ctx(&self) -> &ProtocolCtx

pub fn set_protocol_ctx(&mut self, protocol_ctx: ProtocolCtx)

Trait Implementations

impl Clone for QueryContext

fn clone(&self) -> QueryContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryContext

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

Formats the value using the given formatter.

impl Display for QueryContext

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

Formats the value using the given formatter.

impl From<&QueryContext> for QueryContext

fn from(ctx: &QueryContext) -> Self

Converts to this type from the input type.

impl From<&RegionRequestHeader> for QueryContext

fn from(value: &RegionRequestHeader) -> Self

Converts to this type from the input type.

impl From<QueryContext> for QueryContext

fn from(ctx: QueryContext) -> Self

Converts to this type from the input type.

impl From<QueryContext> for QueryContext

fn from(_: QueryContext) -> Self

Converts to this type from the input type.