mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-24 00:40:40 +00:00
2 lines
11 KiB
HTML
2 lines
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `consumer` mod in crate `substrait`."><title>substrait::df_logical_plan::consumer - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="substrait" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module consumer</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../substrait/index.html">substrait</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module consumer</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In substrait::<wbr>df_<wbr>logical_<wbr>plan</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">substrait</a>::<wbr><a href="../index.html">df_logical_plan</a></div><h1>Module <span>consumer</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DefaultSubstraitConsumer.html" title="struct substrait::df_logical_plan::consumer::DefaultSubstraitConsumer">Default<wbr>Substrait<wbr>Consumer</a></dt><dd>Default SubstraitConsumer for converting standard Substrait without user-defined extensions.</dd><dt><a class="struct" href="struct.ExprContainer.html" title="struct substrait::df_logical_plan::consumer::ExprContainer">Expr<wbr>Container</a></dt><dd>An ExprContainer is a container for a collection of expressions with a common input schema</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.SubstraitConsumer.html" title="trait substrait::df_logical_plan::consumer::SubstraitConsumer">Substrait<wbr>Consumer</a></dt><dd>This trait is used to consume Substrait plans, converting them into DataFusion Logical Plans.
|
||
It can be implemented by users to allow for custom handling of relations, expressions, etc.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.apply_masking.html" title="fn substrait::df_logical_plan::consumer::apply_masking">apply_<wbr>masking</a></dt><dt><a class="fn" href="fn.from_aggregate_rel.html" title="fn substrait::df_logical_plan::consumer::from_aggregate_rel">from_<wbr>aggregate_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_cast.html" title="fn substrait::df_logical_plan::consumer::from_cast">from_<wbr>cast</a></dt><dt><a class="fn" href="fn.from_cross_rel.html" title="fn substrait::df_logical_plan::consumer::from_cross_rel">from_<wbr>cross_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_exchange_rel.html" title="fn substrait::df_logical_plan::consumer::from_exchange_rel">from_<wbr>exchange_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_fetch_rel.html" title="fn substrait::df_logical_plan::consumer::from_fetch_rel">from_<wbr>fetch_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_field_reference.html" title="fn substrait::df_logical_plan::consumer::from_field_reference">from_<wbr>field_<wbr>reference</a></dt><dt><a class="fn" href="fn.from_filter_rel.html" title="fn substrait::df_logical_plan::consumer::from_filter_rel">from_<wbr>filter_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_if_then.html" title="fn substrait::df_logical_plan::consumer::from_if_then">from_<wbr>if_<wbr>then</a></dt><dt><a class="fn" href="fn.from_join_rel.html" title="fn substrait::df_logical_plan::consumer::from_join_rel">from_<wbr>join_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_literal.html" title="fn substrait::df_logical_plan::consumer::from_literal">from_<wbr>literal</a></dt><dt><a class="fn" href="fn.from_project_rel.html" title="fn substrait::df_logical_plan::consumer::from_project_rel">from_<wbr>project_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_read_rel.html" title="fn substrait::df_logical_plan::consumer::from_read_rel">from_<wbr>read_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_scalar_function.html" title="fn substrait::df_logical_plan::consumer::from_scalar_function">from_<wbr>scalar_<wbr>function</a></dt><dt><a class="fn" href="fn.from_set_rel.html" title="fn substrait::df_logical_plan::consumer::from_set_rel">from_<wbr>set_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_singular_or_list.html" title="fn substrait::df_logical_plan::consumer::from_singular_or_list">from_<wbr>singular_<wbr>or_<wbr>list</a></dt><dt><a class="fn" href="fn.from_sort_rel.html" title="fn substrait::df_logical_plan::consumer::from_sort_rel">from_<wbr>sort_<wbr>rel</a></dt><dt><a class="fn" href="fn.from_subquery.html" title="fn substrait::df_logical_plan::consumer::from_subquery">from_<wbr>subquery</a></dt><dt><a class="fn" href="fn.from_substrait_agg_func.html" title="fn substrait::df_logical_plan::consumer::from_substrait_agg_func">from_<wbr>substrait_<wbr>agg_<wbr>func</a></dt><dd>Convert Substrait AggregateFunction to DataFusion Expr</dd><dt><a class="fn" href="fn.from_substrait_extended_expr.html" title="fn substrait::df_logical_plan::consumer::from_substrait_extended_expr">from_<wbr>substrait_<wbr>extended_<wbr>expr</a></dt><dd>Convert Substrait ExtendedExpression to ExprContainer</dd><dt><a class="fn" href="fn.from_substrait_func_args.html" title="fn substrait::df_logical_plan::consumer::from_substrait_func_args">from_<wbr>substrait_<wbr>func_<wbr>args</a></dt><dd>Convert Substrait FunctionArguments to DataFusion Exprs</dd><dt><a class="fn" href="fn.from_substrait_named_struct.html" title="fn substrait::df_logical_plan::consumer::from_substrait_named_struct">from_<wbr>substrait_<wbr>named_<wbr>struct</a></dt><dd>Convert Substrait NamedStruct to DataFusion DFSchemaRef</dd><dt><a class="fn" href="fn.from_substrait_plan.html" title="fn substrait::df_logical_plan::consumer::from_substrait_plan">from_<wbr>substrait_<wbr>plan</a></dt><dd>Convert Substrait Plan to DataFusion LogicalPlan</dd><dt><a class="fn" href="fn.from_substrait_plan_with_consumer.html" title="fn substrait::df_logical_plan::consumer::from_substrait_plan_with_consumer">from_<wbr>substrait_<wbr>plan_<wbr>with_<wbr>consumer</a></dt><dd>Convert Substrait Plan to DataFusion LogicalPlan using the given consumer</dd><dt><a class="fn" href="fn.from_substrait_rel.html" title="fn substrait::df_logical_plan::consumer::from_substrait_rel">from_<wbr>substrait_<wbr>rel</a></dt><dd>Convert Substrait Rel to DataFusion DataFrame</dd><dt><a class="fn" href="fn.from_substrait_rex.html" title="fn substrait::df_logical_plan::consumer::from_substrait_rex">from_<wbr>substrait_<wbr>rex</a></dt><dd>Convert Substrait Rex to DataFusion Expr</dd><dt><a class="fn" href="fn.from_substrait_rex_vec.html" title="fn substrait::df_logical_plan::consumer::from_substrait_rex_vec">from_<wbr>substrait_<wbr>rex_<wbr>vec</a></dt><dd>Convert Substrait Expressions to DataFusion Exprs</dd><dt><a class="fn" href="fn.from_substrait_sorts.html" title="fn substrait::df_logical_plan::consumer::from_substrait_sorts">from_<wbr>substrait_<wbr>sorts</a></dt><dd>Convert Substrait Sorts to DataFusion Exprs</dd><dt><a class="fn" href="fn.from_substrait_type.html" title="fn substrait::df_logical_plan::consumer::from_substrait_type">from_<wbr>substrait_<wbr>type</a></dt><dt><a class="fn" href="fn.from_window_function.html" title="fn substrait::df_logical_plan::consumer::from_window_function">from_<wbr>window_<wbr>function</a></dt><dt><a class="fn" href="fn.name_to_op.html" title="fn substrait::df_logical_plan::consumer::name_to_op">name_<wbr>to_<wbr>op</a></dt><dt><a class="fn" href="fn.rename_data_type.html" title="fn substrait::df_logical_plan::consumer::rename_data_type">rename_<wbr>data_<wbr>type</a></dt><dd>Traverse through the data type (incl. lists/maps/etc), renaming all inner struct fields.</dd><dt><a class="fn" href="fn.rename_field.html" title="fn substrait::df_logical_plan::consumer::rename_field">rename_<wbr>field</a></dt><dd>Traverse through the field, renaming the provided field itself and all its inner struct fields.</dd><dt><a class="fn" href="fn.rename_fields_data_type.html" title="fn substrait::df_logical_plan::consumer::rename_fields_data_type">rename_<wbr>fields_<wbr>data_<wbr>type</a></dt><dd>Rename the field’s data type but not the field itself.</dd><dt><a class="fn" href="fn.substrait_fun_name.html" title="fn substrait::df_logical_plan::consumer::substrait_fun_name">substrait_<wbr>fun_<wbr>name</a></dt><dt><a class="fn" href="fn.substrait_to_df_name.html" title="fn substrait::df_logical_plan::consumer::substrait_to_df_name">substrait_<wbr>to_<wbr>df_<wbr>name</a></dt></dl></section></div></main></body></html> |