pub struct FrontendEnv {Show 23 fields
meta_client: Arc<dyn FrontendMetaClient>,
catalog_writer: Arc<dyn CatalogWriter>,
catalog_reader: CatalogReader,
user_info_writer: Arc<dyn UserInfoWriter>,
user_info_reader: UserInfoReader,
worker_node_manager: WorkerNodeManagerRef,
query_manager: QueryManager,
hummock_snapshot_manager: Arc<HummockSnapshotManager>,
system_params_manager: LocalSystemParamsManagerRef,
session_params: Arc<RwLock<SessionConfig>>,
server_addr: HostAddr,
client_pool: ComputeClientPoolRef,
sessions_map: SessionMapRef,
pub frontend_metrics: Arc<FrontendMetrics>,
pub cursor_metrics: Arc<CursorMetrics>,
source_metrics: Arc<SourceMetrics>,
spill_metrics: Arc<BatchSpillMetrics>,
batch_config: BatchConfig,
meta_config: MetaConfig,
streaming_config: StreamingConfig,
creating_streaming_job_tracker: Arc<StreamingJobTracker>,
compute_runtime: Arc<BackgroundShutdownRuntime>,
mem_context: MemoryContext,
}Expand description
The global environment for the frontend server.
Fields§
§meta_client: Arc<dyn FrontendMetaClient>§catalog_writer: Arc<dyn CatalogWriter>§catalog_reader: CatalogReader§user_info_writer: Arc<dyn UserInfoWriter>§user_info_reader: UserInfoReader§worker_node_manager: WorkerNodeManagerRef§query_manager: QueryManager§hummock_snapshot_manager: Arc<HummockSnapshotManager>§system_params_manager: LocalSystemParamsManagerRef§session_params: Arc<RwLock<SessionConfig>>§server_addr: HostAddr§client_pool: ComputeClientPoolRef§sessions_map: SessionMapRefEach session is identified by (process_id,
secret_key). When Cancel Request received, find corresponding session and cancel all
running queries.
frontend_metrics: Arc<FrontendMetrics>§cursor_metrics: Arc<CursorMetrics>§source_metrics: Arc<SourceMetrics>§spill_metrics: Arc<BatchSpillMetrics>Batch spill metrics
batch_config: BatchConfig§meta_config: MetaConfig§streaming_config: StreamingConfig§creating_streaming_job_tracker: Arc<StreamingJobTracker>Track creating streaming jobs, used to cancel creating streaming job when cancel request received.
compute_runtime: Arc<BackgroundShutdownRuntime>Runtime for compute intensive tasks in frontend, e.g. executors in local mode, root stage in mpp mode.
mem_context: MemoryContextMemory context used for batch executors in frontend.
Implementations§
source§impl FrontendEnv
impl FrontendEnv
pub fn mock() -> Self
pub async fn init( opts: FrontendOpts, ) -> Result<(Self, Vec<JoinHandle<()>>, Vec<Sender<()>>), RwError>
sourcefn catalog_writer(&self, _guard: WriteGuard) -> &dyn CatalogWriter
fn catalog_writer(&self, _guard: WriteGuard) -> &dyn CatalogWriter
Get a reference to the frontend env’s catalog writer.
This method is intentionally private, and a write guard is required for the caller to prove that the write operations are permitted in the current transaction.
sourcepub fn catalog_reader(&self) -> &CatalogReader
pub fn catalog_reader(&self) -> &CatalogReader
Get a reference to the frontend env’s catalog reader.
sourcefn user_info_writer(&self, _guard: WriteGuard) -> &dyn UserInfoWriter
fn user_info_writer(&self, _guard: WriteGuard) -> &dyn UserInfoWriter
Get a reference to the frontend env’s user info writer.
This method is intentionally private, and a write guard is required for the caller to prove that the write operations are permitted in the current transaction.
sourcepub fn user_info_reader(&self) -> &UserInfoReader
pub fn user_info_reader(&self) -> &UserInfoReader
Get a reference to the frontend env’s user info reader.
pub fn worker_node_manager(&self) -> &WorkerNodeManager
pub fn worker_node_manager_ref(&self) -> WorkerNodeManagerRef
pub fn meta_client(&self) -> &dyn FrontendMetaClient
pub fn meta_client_ref(&self) -> Arc<dyn FrontendMetaClient>
pub fn query_manager(&self) -> &QueryManager
pub fn hummock_snapshot_manager(&self) -> &Arc<HummockSnapshotManager>
pub fn system_params_manager(&self) -> &LocalSystemParamsManagerRef
pub fn session_params_snapshot(&self) -> SessionConfig
pub fn server_address(&self) -> &HostAddr
pub fn client_pool(&self) -> ComputeClientPoolRef
pub fn batch_config(&self) -> &BatchConfig
pub fn meta_config(&self) -> &MetaConfig
pub fn streaming_config(&self) -> &StreamingConfig
pub fn source_metrics(&self) -> Arc<SourceMetrics>
pub fn spill_metrics(&self) -> Arc<BatchSpillMetrics>
pub fn creating_streaming_job_tracker(&self) -> &Arc<StreamingJobTracker>
pub fn sessions_map(&self) -> &SessionMapRef
pub fn compute_runtime(&self) -> Arc<BackgroundShutdownRuntime>
sourcepub fn cancel_queries_in_session(&self, session_id: SessionId) -> bool
pub fn cancel_queries_in_session(&self, session_id: SessionId) -> bool
Cancel queries (i.e. batch queries) in session. If the session exists return true, otherwise, return false.
sourcepub fn cancel_creating_jobs_in_session(&self, session_id: SessionId) -> bool
pub fn cancel_creating_jobs_in_session(&self, session_id: SessionId) -> bool
Cancel creating jobs (i.e. streaming queries) in session. If the session exists return true, otherwise, return false.
pub fn mem_context(&self) -> MemoryContext
Trait Implementations§
source§impl Clone for FrontendEnv
impl Clone for FrontendEnv
source§fn clone(&self) -> FrontendEnv
fn clone(&self) -> FrontendEnv
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for FrontendEnv
impl !RefUnwindSafe for FrontendEnv
impl Send for FrontendEnv
impl Sync for FrontendEnv
impl Unpin for FrontendEnv
impl !UnwindSafe for FrontendEnv
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
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)§impl<T> Conv for T
impl<T> Conv for T
§impl<Choices> CoproductSubsetter<CNil, HNil> for Choices
impl<Choices> CoproductSubsetter<CNil, HNil> for Choices
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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>
Converts
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>
Converts
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 moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
Creates a shared type from an unshared type.
§impl<T, U, I> LiftInto<U, I> for Twhere
U: LiftFrom<T, I>,
impl<T, U, I> LiftInto<U, I> for Twhere
U: LiftFrom<T, I>,
source§impl<M> MetricVecRelabelExt for M
impl<M> MetricVecRelabelExt for M
source§fn relabel(
self,
metric_level: MetricLevel,
relabel_threshold: MetricLevel,
) -> RelabeledMetricVec<M>
fn relabel( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>
Equivalent to
RelabeledMetricVec::with_metric_level.source§fn relabel_n(
self,
metric_level: MetricLevel,
relabel_threshold: MetricLevel,
relabel_num: usize,
) -> RelabeledMetricVec<M>
fn relabel_n( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, relabel_num: usize, ) -> RelabeledMetricVec<M>
Equivalent to
RelabeledMetricVec::with_metric_level_relabel_n.source§fn relabel_debug_1(
self,
relabel_threshold: MetricLevel,
) -> RelabeledMetricVec<M>
fn relabel_debug_1( self, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>
Equivalent to
RelabeledMetricVec::with_metric_level_relabel_n with metric_level set to
MetricLevel::Debug and relabel_num set to 1.§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<Source> Sculptor<HNil, HNil> for Source
impl<Source> Sculptor<HNil, HNil> for Source
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.