mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-22 22:20:02 +00:00
18 lines
4.9 KiB
HTML
18 lines
4.9 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="Attribute macro to convert a normal function to SQL administration function. The annotated function should accept:"><title>admin_fn in common_macro - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="common_macro" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.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 attr"><!--[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="#">admin_fn</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_macro/index.html">common_<wbr>macro</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">admin_<wbr>fn</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example-see-commonfunctionsrcsystemprocedure_staters" title="Example see `common/function/src/system/procedure_state.rs`.">Example see <code>common/function/src/system/procedure_state.rs</code>.</a></li><li><a href="#arguments" title="Arguments">Arguments</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate common_<wbr>macro</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">common_macro</a></div><h1>Attribute Macro <span class="attr">admin_<wbr>fn</span> <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/common_macro/lib.rs.html#101-103">Source</a> </span></div><pre class="rust item-decl"><code>#[admin_fn]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Attribute macro to convert a normal function to SQL administration function. The annotated function
|
|
should accept:</p>
|
|
<ul>
|
|
<li><code>&ProcedureServiceHandlerRef</code> or <code>&TableMutationHandlerRef</code> or <code>FlowServiceHandlerRef</code> as the first argument,</li>
|
|
<li><code>&QueryContextRef</code> as the second argument, and</li>
|
|
<li><code>&[ValueRef<'_>]</code> as the third argument which is SQL function input values in each row.</li>
|
|
</ul>
|
|
<p>Return type must be <code>common_query::error::Result<Value></code>.</p>
|
|
<h2 id="example-see-commonfunctionsrcsystemprocedure_staters"><a class="doc-anchor" href="#example-see-commonfunctionsrcsystemprocedure_staters">§</a>Example see <code>common/function/src/system/procedure_state.rs</code>.</h2><h2 id="arguments"><a class="doc-anchor" href="#arguments">§</a>Arguments</h2>
|
|
<ul>
|
|
<li><code>name</code>: The name of the generated <code>Function</code> implementation.</li>
|
|
<li><code>ret</code>: The return type of the generated SQL function, it will be transformed into <code>ConcreteDataType::{ret}_datatype()</code> result.</li>
|
|
<li><code>display_name</code>: The display name of the generated SQL function.</li>
|
|
<li><code>sig_fn</code>: the function to returns <code>Signature</code> of generated <code>Function</code>.</li>
|
|
<li><code>user_path</code>: Optional path to the trait and context (e.g., <code>crate</code>);
|
|
defaults to <code>crate</code> if not provided.</li>
|
|
</ul>
|
|
</div></details></section></div></main></body></html> |