Files
greptimedb/src/flow/batching_mode.rs.html
2026-06-02 10:54:02 +00:00

84 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="Source of the Rust file `src/flow/src/batching_mode.rs`."><title>batching_mode.rs - source</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="flow" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><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]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">flow/</div>batching_mode.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="doccomment">//! Run flow as batching mode which is time-window-aware normal query triggered when new data arrives
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span>std::time::Duration;
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>common_grpc::channel_manager::ClientTlsOption;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>serde::{Deserialize, Serialize};
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>session::ReadPreference;
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">mod </span>checkpoint;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>engine;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>frontend_client;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">mod </span>state;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">mod </span>table_creator;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">mod </span>task;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">mod </span>time_window;
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>utils;
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="attr">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub struct </span>BatchingModeOptions {
<a href=#34 id=34 data-nosnippet>34</a> <span class="doccomment">/// The default batching engine query timeout is 10 minutes
<a href=#35 id=35 data-nosnippet>35</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">pub </span>query_timeout: Duration,
<a href=#37 id=37 data-nosnippet>37</a> <span class="doccomment">/// will output a warn log for any query that runs for more that this threshold
<a href=#38 id=38 data-nosnippet>38</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#39 id=39 data-nosnippet>39</a> </span><span class="kw">pub </span>slow_query_threshold: Duration,
<a href=#40 id=40 data-nosnippet>40</a> <span class="doccomment">/// The minimum duration between two queries execution by batching mode task
<a href=#41 id=41 data-nosnippet>41</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#42 id=42 data-nosnippet>42</a> </span><span class="kw">pub </span>experimental_min_refresh_duration: Duration,
<a href=#43 id=43 data-nosnippet>43</a> <span class="doccomment">/// The gRPC connection timeout
<a href=#44 id=44 data-nosnippet>44</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">pub </span>grpc_conn_timeout: Duration,
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// The gRPC max retry number
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="kw">pub </span>experimental_grpc_max_retries: u32,
<a href=#48 id=48 data-nosnippet>48</a> <span class="doccomment">/// Flow wait for available frontend timeout,
<a href=#49 id=49 data-nosnippet>49</a> /// if failed to find available frontend after frontend_scan_timeout elapsed, return error
<a href=#50 id=50 data-nosnippet>50</a> /// which prevent flownode from starting
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#52 id=52 data-nosnippet>52</a> </span><span class="kw">pub </span>experimental_frontend_scan_timeout: Duration,
<a href=#53 id=53 data-nosnippet>53</a> <span class="doccomment">/// Maximum number of filters allowed in a single query
<a href=#54 id=54 data-nosnippet>54</a> </span><span class="kw">pub </span>experimental_max_filter_num_per_query: usize,
<a href=#55 id=55 data-nosnippet>55</a> <span class="doccomment">/// Time window merge distance
<a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">pub </span>experimental_time_window_merge_threshold: usize,
<a href=#57 id=57 data-nosnippet>57</a> <span class="doccomment">/// Whether to enable experimental flow incremental source reads.
<a href=#58 id=58 data-nosnippet>58</a> ///
<a href=#59 id=59 data-nosnippet>59</a> /// When disabled, batching flows always execute full-snapshot queries.
<a href=#60 id=60 data-nosnippet>60</a> </span><span class="kw">pub </span>experimental_enable_incremental_read: bool,
<a href=#61 id=61 data-nosnippet>61</a> <span class="doccomment">/// Read preference of the Frontend client.
<a href=#62 id=62 data-nosnippet>62</a> </span><span class="kw">pub </span>read_preference: ReadPreference,
<a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// TLS option for client connections to frontends.
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">pub </span>frontend_tls: <span class="prelude-ty">Option</span>&lt;ClientTlsOption&gt;,
<a href=#65 id=65 data-nosnippet>65</a>}
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a><span class="kw">impl </span>Default <span class="kw">for </span>BatchingModeOptions {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">Self </span>{
<a href=#70 id=70 data-nosnippet>70</a> query_timeout: Duration::from_secs(<span class="number">10 </span>* <span class="number">60</span>),
<a href=#71 id=71 data-nosnippet>71</a> slow_query_threshold: Duration::from_secs(<span class="number">60</span>),
<a href=#72 id=72 data-nosnippet>72</a> experimental_min_refresh_duration: Duration::new(<span class="number">5</span>, <span class="number">0</span>),
<a href=#73 id=73 data-nosnippet>73</a> grpc_conn_timeout: Duration::from_secs(<span class="number">5</span>),
<a href=#74 id=74 data-nosnippet>74</a> experimental_grpc_max_retries: <span class="number">3</span>,
<a href=#75 id=75 data-nosnippet>75</a> experimental_frontend_scan_timeout: Duration::from_secs(<span class="number">30</span>),
<a href=#76 id=76 data-nosnippet>76</a> experimental_max_filter_num_per_query: <span class="number">20</span>,
<a href=#77 id=77 data-nosnippet>77</a> experimental_time_window_merge_threshold: <span class="number">3</span>,
<a href=#78 id=78 data-nosnippet>78</a> experimental_enable_incremental_read: <span class="bool-val">false</span>,
<a href=#79 id=79 data-nosnippet>79</a> read_preference: Default::default(),
<a href=#80 id=80 data-nosnippet>80</a> frontend_tls: <span class="prelude-val">None</span>,
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>}
</code></pre></div></section></main></body></html>