Struct mz_adapter::coord::dataflows::DataflowBuilder
source · pub struct DataflowBuilder<'a> {
pub catalog: &'a CatalogState,
pub compute: ComputeInstanceSnapshot,
pub ignored_indexes: BTreeSet<GlobalId>,
recursion_guard: RecursionGuard,
}
Expand description
Borrows of catalog and indexes sufficient to build dataflow descriptions.
Fields§
§catalog: &'a CatalogState
§compute: ComputeInstanceSnapshot
A handle to the compute abstraction, which describes indexes by identifier.
This can also be used to grab a handle to the storage abstraction, through
its storage_mut()
method.
ignored_indexes: BTreeSet<GlobalId>
Indexes to be ignored even if they are present in the catalog.
recursion_guard: RecursionGuard
A guard for recursive operations in this DataflowBuilder
instance.
Implementations§
source§impl<'a> DataflowBuilder<'a>
impl<'a> DataflowBuilder<'a>
pub fn new(catalog: &'a CatalogState, compute: ComputeInstanceSnapshot) -> Self
pub fn ignore_indexes(&mut self, indexes: impl Iterator<Item = GlobalId>)
sourcepub fn import_into_dataflow(
&mut self,
id: &GlobalId,
dataflow: &mut DataflowDesc
) -> Result<(), AdapterError>
pub fn import_into_dataflow( &mut self, id: &GlobalId, dataflow: &mut DataflowDesc ) -> Result<(), AdapterError>
Imports the view, source, or table with id
into the provided
dataflow description.
sourcepub fn import_view_into_dataflow(
&mut self,
view_id: &GlobalId,
view: &OptimizedMirRelationExpr,
dataflow: &mut DataflowDesc
) -> Result<(), AdapterError>
pub fn import_view_into_dataflow( &mut self, view_id: &GlobalId, view: &OptimizedMirRelationExpr, dataflow: &mut DataflowDesc ) -> Result<(), AdapterError>
Imports the view with the specified ID and expression into the provided dataflow description.
You should generally prefer calling
DataflowBuilder::import_into_dataflow
, which can handle objects of
any type as long as they exist in the catalog. This method exists for
when the view does not exist in the catalog, e.g., because it is
identified by a GlobalId::Transient
.
sourcepub fn build_sink_dataflow(
&mut self,
name: String,
id: GlobalId,
sink_description: ComputeSinkDesc
) -> Result<(DataflowDesc, DataflowMetainfo), AdapterError>
pub fn build_sink_dataflow( &mut self, name: String, id: GlobalId, sink_description: ComputeSinkDesc ) -> Result<(DataflowDesc, DataflowMetainfo), AdapterError>
Builds a dataflow description for the sink with the specified name, ID, source, and output connection.
For as long as this dataflow is active, id
can be used to reference
the sink (primarily to drop it, at the moment).
sourcepub fn build_sink_dataflow_into(
&mut self,
dataflow: &mut DataflowDesc,
id: GlobalId,
sink_description: ComputeSinkDesc
) -> Result<DataflowMetainfo, AdapterError>
pub fn build_sink_dataflow_into( &mut self, dataflow: &mut DataflowDesc, id: GlobalId, sink_description: ComputeSinkDesc ) -> Result<DataflowMetainfo, AdapterError>
Like build_sink_dataflow
, but builds the sink dataflow into the
existing dataflow description instead of creating one from scratch.
sourcefn monotonic_source(&self, source: &Source) -> bool
fn monotonic_source(&self, source: &Source) -> bool
Determine the given source’s monotonicity.
sourcefn monotonic_view(&self, id: GlobalId) -> bool
fn monotonic_view(&self, id: GlobalId) -> bool
Determine the given view’s monotonicity.
This recursively traverses the expressions of all (materialized) views involved in the given view’s query expression. If this becomes a performance problem, we could add the monotonicity information of views into the catalog instead.
fn monotonic_view_inner( &self, id: GlobalId, memo: &mut BTreeMap<GlobalId, bool> ) -> Result<bool, RecursionLimitError>
source§impl DataflowBuilder<'_>
impl DataflowBuilder<'_>
sourcepub fn sufficient_collections<'a, I>(&self, ids: I) -> CollectionIdBundlewhere
I: IntoIterator<Item = &'a GlobalId>,
pub fn sufficient_collections<'a, I>(&self, ids: I) -> CollectionIdBundlewhere I: IntoIterator<Item = &'a GlobalId>,
Identifies a bundle of storage and compute collection ids sufficient for
building a dataflow for the identifiers in ids
out of the indexes
available in this compute instance.
pub fn indexes_on( &self, id: GlobalId ) -> impl Iterator<Item = (GlobalId, &Index)>
source§impl<'a> DataflowBuilder<'a>
impl<'a> DataflowBuilder<'a>
pub fn reoptimize_imported_views( &self, df_desc: &mut DataflowDescription<OptimizedMirRelationExpr>, config: &OptimizerConfig ) -> Result<(), OptimizerError>
Trait Implementations§
source§impl<'a> CheckedRecursion for DataflowBuilder<'a>
impl<'a> CheckedRecursion for DataflowBuilder<'a>
source§fn recursion_guard(&self) -> &RecursionGuard
fn recursion_guard(&self) -> &RecursionGuard
source§fn checked_recur<F, T, E>(&self, f: F) -> Result<T, E>where
F: FnOnce(&Self) -> Result<T, E>,
E: From<RecursionLimitError>,
fn checked_recur<F, T, E>(&self, f: F) -> Result<T, E>where F: FnOnce(&Self) -> Result<T, E>, E: From<RecursionLimitError>,
f
if so. Read moresource§fn checked_recur_mut<F, T, E>(&mut self, f: F) -> Result<T, E>where
F: FnOnce(&mut Self) -> Result<T, E>,
E: From<RecursionLimitError>,
fn checked_recur_mut<F, T, E>(&mut self, f: F) -> Result<T, E>where F: FnOnce(&mut Self) -> Result<T, E>, E: From<RecursionLimitError>,
CheckedRecursion::checked_recur
, but operates on a mutable
reference to Self
.source§impl<'a> Debug for DataflowBuilder<'a>
impl<'a> Debug for DataflowBuilder<'a>
source§impl IndexOracle for DataflowBuilder<'_>
impl IndexOracle for DataflowBuilder<'_>
source§fn indexes_on(
&self,
id: GlobalId
) -> Box<dyn Iterator<Item = (GlobalId, &[MirScalarExpr])> + '_>
fn indexes_on( &self, id: GlobalId ) -> Box<dyn Iterator<Item = (GlobalId, &[MirScalarExpr])> + '_>
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for DataflowBuilder<'a>
impl<'a> Send for DataflowBuilder<'a>
impl<'a> !Sync for DataflowBuilder<'a>
impl<'a> Unpin for DataflowBuilder<'a>
impl<'a> !UnwindSafe for DataflowBuilder<'a>
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
source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere R: RustType<P>,
source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.