Files

3 lines
8.4 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `json_expr_planner` mod in crate `query`."><title>query::datafusion::json_expr_planner - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="query" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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 json_expr_planner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../query/index.html">query</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module json_<wbr>expr_<wbr>planner</a></h2><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In query::<wbr>datafusion</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">query</a>::<wbr><a href="../index.html">datafusion</a></div><h1>Module <span>json_<wbr>expr_<wbr>planner</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/query/datafusion/json_expr_planner.rs.html#15-1001">Source</a> </span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.is_typed_json_get_func.html" title="macro query::datafusion::json_expr_planner::is_typed_json_get_func">is_<wbr>typed_<wbr>json_<wbr>get_<wbr>func</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="macro" href="macro.is_untyped_json_get_func.html" title="macro query::datafusion::json_expr_planner::is_untyped_json_get_func">is_<wbr>untyped_<wbr>json_<wbr>get_<wbr>func</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.JsonExprPlanner.html" title="struct query::datafusion::json_expr_planner::JsonExprPlanner">Json<wbr>Expr<wbr>Planner</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Rewrites JSON-aware SQL expressions into DataFusion expressions.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.JsonGetTypeResolution.html" title="enum query::datafusion::json_expr_planner::JsonGetTypeResolution">Json<wbr>GetType<wbr>Resolution</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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_json_type_hint.html" title="fn query::datafusion::json_expr_planner::apply_json_type_hint">apply_<wbr>json_<wbr>type_<wbr>hint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Sets the native read type for an exact hinted object path. Both SQL syntaxes use this before
an enclosing expression can infer a type or push down a cast.</dd><dt><a class="fn" href="fn.extract_json_get_type.html" title="fn query::datafusion::json_expr_planner::extract_json_get_type">extract_<wbr>json_<wbr>get_<wbr>type</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.extract_untyped_json_get.html" title="fn query::datafusion::json_expr_planner::extract_untyped_json_get">extract_<wbr>untyped_<wbr>json_<wbr>get</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.fallback_json_get_type.html" title="fn query::datafusion::json_expr_planner::fallback_json_get_type">fallback_<wbr>json_<wbr>get_<wbr>type</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.function_arg_field.html" title="fn query::datafusion::json_expr_planner::function_arg_field">function_<wbr>arg_<wbr>field</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.infer_json_get_types.html" title="fn query::datafusion::json_expr_planner::infer_json_get_types">infer_<wbr>json_<wbr>get_<wbr>types</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.is_untyped_json_get.html" title="fn query::datafusion::json_expr_planner::is_untyped_json_get">is_<wbr>untyped_<wbr>json_<wbr>get</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.json_get_object_path.html" title="fn query::datafusion::json_expr_planner::json_get_object_path">json_<wbr>get_<wbr>object_<wbr>path</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Resolves <code>json_get</code>’s second argument expression (the path) to object field names for type hint
lookup. For example, the string literal <code>'$.user.age'</code> resolves to <code>["user", "age"]</code>.</dd><dt><a class="fn" href="fn.json_get_output_type.html" title="fn query::datafusion::json_expr_planner::json_get_output_type">json_<wbr>get_<wbr>output_<wbr>type</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.json_path_field.html" title="fn query::datafusion::json_expr_planner::json_path_field">json_<wbr>path_<wbr>field</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Quotes field names containing JSONPath punctuation, preserving literal keys.</dd><dt><a class="fn" href="fn.json_type_hint.html" title="fn query::datafusion::json_expr_planner::json_type_hint">json_<wbr>type_<wbr>hint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns the configured native type for an exact JSON2 object path.</dd><dt><a class="fn" href="fn.parse_sql_op.html" title="fn query::datafusion::json_expr_planner::parse_sql_op">parse_<wbr>sql_<wbr>op</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.push_function_arg_types.html" title="fn query::datafusion::json_expr_planner::push_function_arg_types">push_<wbr>function_<wbr>arg_<wbr>types</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Infers static output types for untyped <code>json_get</code> arguments from a function signature.</dd><dt><a class="fn" href="fn.push_json_get_type_arg.html" title="fn query::datafusion::json_expr_planner::push_json_get_type_arg">push_<wbr>json_<wbr>get_<wbr>type_<wbr>arg</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>