Files
greptimedb/common_function/admin/flush_compact_table/fn.parse_compact_request.html
2025-12-26 03:00:34 +00:00

15 lines
4.6 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="Parses `compact_table` UDF parameters. This function accepts following combinations:"><title>parse_compact_request in common_function::admin::flush_compact_table - 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_function" 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 fn"><!--[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="#">parse_compact_request</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_function/index.html">common_<wbr>function</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>function::<wbr>admin::<wbr>flush_<wbr>compact_<wbr>table</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_function</a>::<wbr><a href="../index.html">admin</a>::<wbr><a href="index.html">flush_compact_table</a></div><h1>Function <span class="fn">parse_<wbr>compact_<wbr>request</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/common_function/admin/flush_compact_table.rs.html#124-183">Source</a> </span></div><pre class="rust item-decl"><code>fn parse_compact_request(
params: &amp;[<a class="enum" href="../../../datatypes/value/enum.ValueRef.html" title="enum datatypes::value::ValueRef">ValueRef</a>&lt;'_&gt;],
query_ctx: &amp;<a class="type" href="../../../session/context/type.QueryContextRef.html" title="type session::context::QueryContextRef">QueryContextRef</a>,
) -&gt; <a class="type" href="../../../common_query/error/type.Result.html" title="type common_query::error::Result">Result</a>&lt;<a class="struct" href="../../../table/requests/struct.CompactTableRequest.html" title="struct table::requests::CompactTableRequest">CompactTableRequest</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parses <code>compact_table</code> UDF parameters. This function accepts following combinations:</p>
<ul>
<li><code>[&lt;table_name&gt;]</code>: only tables name provided, using default compaction type: regular</li>
<li><code>[&lt;table_name&gt;, &lt;type&gt;]</code>: specify table name and compaction type. The compaction options will be default.</li>
<li><code>[&lt;table_name&gt;, &lt;type&gt;, &lt;options&gt;]</code>: provides both type and type-specific options.
<ul>
<li>For <code>twcs</code>, it accepts <code>parallelism=[N]</code> where N is an unsigned 32 bits number</li>
<li>For <code>swcs</code>, it accepts two numeric parameter: <code>parallelism</code> and <code>window</code>.</li>
</ul>
</li>
</ul>
</div></details></section></div></main></body></html>