mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-16 21:10:38 +00:00
161 lines
18 KiB
HTML
161 lines
18 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/common/function/src/function.rs`."><title>function.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-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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[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"><div class="main-heading"><h1><div class="sub-heading">common_function/</div>function.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><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="kw">use </span>std::any::Any;
|
|
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::fmt;
|
|
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::fmt::{Debug, Formatter};
|
|
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::sync::Arc;
|
|
<a href=#19 id=19 data-nosnippet>19</a>
|
|
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>datafusion::arrow::datatypes::{DataType, Field};
|
|
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>datafusion::logical_expr::{ColumnarValue, ReturnFieldArgs};
|
|
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>datafusion_common::DataFusionError;
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>datafusion_common::arrow::array::ArrayRef;
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>datafusion_common::config::{ConfigEntry, ConfigExtension, ExtensionOptions};
|
|
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>datafusion_expr::{ScalarFunctionArgs, Signature};
|
|
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>session::context::{QueryContextBuilder, QueryContextRef};
|
|
<a href=#27 id=27 data-nosnippet>27</a>
|
|
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span><span class="kw">crate</span>::state::FunctionState;
|
|
<a href=#29 id=29 data-nosnippet>29</a>
|
|
<a href=#30 id=30 data-nosnippet>30</a><span class="doccomment">/// The function execution context
|
|
<a href=#31 id=31 data-nosnippet>31</a></span><span class="attr">#[derive(Clone)]
|
|
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">pub struct </span>FunctionContext {
|
|
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">pub </span>query_ctx: QueryContextRef,
|
|
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub </span>state: Arc<FunctionState>,
|
|
<a href=#35 id=35 data-nosnippet>35</a>}
|
|
<a href=#36 id=36 data-nosnippet>36</a>
|
|
<a href=#37 id=37 data-nosnippet>37</a><span class="kw">impl </span>FunctionContext {
|
|
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// Create a mock [`FunctionContext`] for test.
|
|
<a href=#39 id=39 data-nosnippet>39</a> </span><span class="attr">#[cfg(any(test, feature = <span class="string">"testing"</span>))]
|
|
<a href=#40 id=40 data-nosnippet>40</a> </span><span class="kw">pub fn </span>mock() -> <span class="self">Self </span>{
|
|
<a href=#41 id=41 data-nosnippet>41</a> <span class="self">Self </span>{
|
|
<a href=#42 id=42 data-nosnippet>42</a> query_ctx: QueryContextBuilder::default().build().into(),
|
|
<a href=#43 id=43 data-nosnippet>43</a> state: Arc::new(FunctionState::mock()),
|
|
<a href=#44 id=44 data-nosnippet>44</a> }
|
|
<a href=#45 id=45 data-nosnippet>45</a> }
|
|
<a href=#46 id=46 data-nosnippet>46</a>}
|
|
<a href=#47 id=47 data-nosnippet>47</a>
|
|
<a href=#48 id=48 data-nosnippet>48</a><span class="kw">impl </span>std::fmt::Display <span class="kw">for </span>FunctionContext {
|
|
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#50 id=50 data-nosnippet>50</a> <span class="macro">write!</span>(f, <span class="string">"FunctionContext {{ query_ctx: {} }}"</span>, <span class="self">self</span>.query_ctx)
|
|
<a href=#51 id=51 data-nosnippet>51</a> }
|
|
<a href=#52 id=52 data-nosnippet>52</a>}
|
|
<a href=#53 id=53 data-nosnippet>53</a>
|
|
<a href=#54 id=54 data-nosnippet>54</a><span class="kw">impl </span>Default <span class="kw">for </span>FunctionContext {
|
|
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#56 id=56 data-nosnippet>56</a> <span class="self">Self </span>{
|
|
<a href=#57 id=57 data-nosnippet>57</a> query_ctx: QueryContextBuilder::default().build().into(),
|
|
<a href=#58 id=58 data-nosnippet>58</a> state: Arc::new(FunctionState::default()),
|
|
<a href=#59 id=59 data-nosnippet>59</a> }
|
|
<a href=#60 id=60 data-nosnippet>60</a> }
|
|
<a href=#61 id=61 data-nosnippet>61</a>}
|
|
<a href=#62 id=62 data-nosnippet>62</a>
|
|
<a href=#63 id=63 data-nosnippet>63</a><span class="kw">impl </span>ExtensionOptions <span class="kw">for </span>FunctionContext {
|
|
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">fn </span>as_any(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="kw">dyn </span>Any {
|
|
<a href=#65 id=65 data-nosnippet>65</a> <span class="self">self
|
|
<a href=#66 id=66 data-nosnippet>66</a> </span>}
|
|
<a href=#67 id=67 data-nosnippet>67</a>
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">fn </span>as_any_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span><span class="kw">dyn </span>Any {
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self
|
|
<a href=#70 id=70 data-nosnippet>70</a> </span>}
|
|
<a href=#71 id=71 data-nosnippet>71</a>
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">fn </span>cloned(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>ExtensionOptions> {
|
|
<a href=#73 id=73 data-nosnippet>73</a> Box::new(<span class="self">self</span>.clone())
|
|
<a href=#74 id=74 data-nosnippet>74</a> }
|
|
<a href=#75 id=75 data-nosnippet>75</a>
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">fn </span>set(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>str, <span class="kw">_</span>: <span class="kw-2">&</span>str) -> datafusion_common::Result<()> {
|
|
<a href=#77 id=77 data-nosnippet>77</a> <span class="prelude-val">Err</span>(DataFusionError::NotImplemented(
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="string">"set options for `FunctionContext`"</span>.to_string(),
|
|
<a href=#79 id=79 data-nosnippet>79</a> ))
|
|
<a href=#80 id=80 data-nosnippet>80</a> }
|
|
<a href=#81 id=81 data-nosnippet>81</a>
|
|
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">fn </span>entries(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<ConfigEntry> {
|
|
<a href=#83 id=83 data-nosnippet>83</a> <span class="macro">vec!</span>[]
|
|
<a href=#84 id=84 data-nosnippet>84</a> }
|
|
<a href=#85 id=85 data-nosnippet>85</a>}
|
|
<a href=#86 id=86 data-nosnippet>86</a>
|
|
<a href=#87 id=87 data-nosnippet>87</a><span class="kw">impl </span>Debug <span class="kw">for </span>FunctionContext {
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#89 id=89 data-nosnippet>89</a> f.debug_struct(<span class="string">"FunctionContext"</span>)
|
|
<a href=#90 id=90 data-nosnippet>90</a> .field(<span class="string">"query_ctx"</span>, <span class="kw-2">&</span><span class="self">self</span>.query_ctx)
|
|
<a href=#91 id=91 data-nosnippet>91</a> .finish()
|
|
<a href=#92 id=92 data-nosnippet>92</a> }
|
|
<a href=#93 id=93 data-nosnippet>93</a>}
|
|
<a href=#94 id=94 data-nosnippet>94</a>
|
|
<a href=#95 id=95 data-nosnippet>95</a><span class="kw">impl </span>ConfigExtension <span class="kw">for </span>FunctionContext {
|
|
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">const </span>PREFIX: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">"FunctionContext"</span>;
|
|
<a href=#97 id=97 data-nosnippet>97</a>}
|
|
<a href=#98 id=98 data-nosnippet>98</a>
|
|
<a href=#99 id=99 data-nosnippet>99</a><span class="doccomment">/// Scalar function trait, modified from databend to adapt datafusion
|
|
<a href=#100 id=100 data-nosnippet>100</a>/// TODO(dennis): optimize function by it's features such as monotonicity etc.
|
|
<a href=#101 id=101 data-nosnippet>101</a></span><span class="kw">pub trait </span>Function: fmt::Display + Sync + Send {
|
|
<a href=#102 id=102 data-nosnippet>102</a> <span class="doccomment">/// Returns the name of the function, should be unique.
|
|
<a href=#103 id=103 data-nosnippet>103</a> </span><span class="kw">fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str;
|
|
<a href=#104 id=104 data-nosnippet>104</a>
|
|
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// The returned data type of function execution.
|
|
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">fn </span>return_type(<span class="kw-2">&</span><span class="self">self</span>, input_types: <span class="kw-2">&</span>[DataType]) -> datafusion_common::Result<DataType>;
|
|
<a href=#107 id=107 data-nosnippet>107</a>
|
|
<a href=#108 id=108 data-nosnippet>108</a> <span class="doccomment">/// The signature of function.
|
|
<a href=#109 id=109 data-nosnippet>109</a> </span><span class="kw">fn </span>signature(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Signature;
|
|
<a href=#110 id=110 data-nosnippet>110</a>
|
|
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">fn </span>invoke_with_args(
|
|
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#113 id=113 data-nosnippet>113</a> args: ScalarFunctionArgs,
|
|
<a href=#114 id=114 data-nosnippet>114</a> ) -> datafusion_common::Result<ColumnarValue>;
|
|
<a href=#115 id=115 data-nosnippet>115</a>
|
|
<a href=#116 id=116 data-nosnippet>116</a> <span class="kw">fn </span>aliases(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[String] {
|
|
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw-2">&</span>[]
|
|
<a href=#118 id=118 data-nosnippet>118</a> }
|
|
<a href=#119 id=119 data-nosnippet>119</a>
|
|
<a href=#120 id=120 data-nosnippet>120</a> <span class="doccomment">/// Returns the return field for this function given the input fields.
|
|
<a href=#121 id=121 data-nosnippet>121</a> ///
|
|
<a href=#122 id=122 data-nosnippet>122</a> /// Default implementation extracts data types from input fields and calls
|
|
<a href=#123 id=123 data-nosnippet>123</a> /// [`Function::return_type`], creating a generic field with the returned type.
|
|
<a href=#124 id=124 data-nosnippet>124</a> </span><span class="kw">fn </span>return_field_from_args(
|
|
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#126 id=126 data-nosnippet>126</a> args: ReturnFieldArgs<<span class="lifetime">'_</span>>,
|
|
<a href=#127 id=127 data-nosnippet>127</a> ) -> datafusion_common::Result<Arc<Field>> {
|
|
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">let </span>input_types = args
|
|
<a href=#129 id=129 data-nosnippet>129</a> .arg_fields
|
|
<a href=#130 id=130 data-nosnippet>130</a> .iter()
|
|
<a href=#131 id=131 data-nosnippet>131</a> .map(|f| f.data_type().clone())
|
|
<a href=#132 id=132 data-nosnippet>132</a> .collect::<Vec<<span class="kw">_</span>>>();
|
|
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span>return_type = <span class="self">self</span>.return_type(<span class="kw-2">&</span>input_types)<span class="question-mark">?</span>;
|
|
<a href=#134 id=134 data-nosnippet>134</a> <span class="prelude-val">Ok</span>(Arc::new(Field::new(<span class="self">self</span>.name(), return_type, <span class="bool-val">true</span>)))
|
|
<a href=#135 id=135 data-nosnippet>135</a> }
|
|
<a href=#136 id=136 data-nosnippet>136</a>}
|
|
<a href=#137 id=137 data-nosnippet>137</a>
|
|
<a href=#138 id=138 data-nosnippet>138</a><span class="kw">pub type </span>FunctionRef = Arc<<span class="kw">dyn </span>Function>;
|
|
<a href=#139 id=139 data-nosnippet>139</a>
|
|
<a href=#140 id=140 data-nosnippet>140</a><span class="doccomment">/// Find the [FunctionContext] in the [ScalarFunctionArgs]. The [FunctionContext] was set
|
|
<a href=#141 id=141 data-nosnippet>141</a>/// previously in the DataFusion session context creation, and is passed all the way down to the
|
|
<a href=#142 id=142 data-nosnippet>142</a>/// args by DataFusion.
|
|
<a href=#143 id=143 data-nosnippet>143</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>find_function_context(
|
|
<a href=#144 id=144 data-nosnippet>144</a> args: <span class="kw-2">&</span>ScalarFunctionArgs,
|
|
<a href=#145 id=145 data-nosnippet>145</a>) -> datafusion_common::Result<<span class="kw-2">&</span>FunctionContext> {
|
|
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span><span class="prelude-val">Some</span>(x) = args.config_options.extensions.get::<FunctionContext>() <span class="kw">else </span>{
|
|
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">return </span><span class="prelude-val">Err</span>(DataFusionError::Execution(
|
|
<a href=#148 id=148 data-nosnippet>148</a> <span class="string">"function context is not set"</span>.to_string(),
|
|
<a href=#149 id=149 data-nosnippet>149</a> ));
|
|
<a href=#150 id=150 data-nosnippet>150</a> };
|
|
<a href=#151 id=151 data-nosnippet>151</a> <span class="prelude-val">Ok</span>(x)
|
|
<a href=#152 id=152 data-nosnippet>152</a>}
|
|
<a href=#153 id=153 data-nosnippet>153</a>
|
|
<a href=#154 id=154 data-nosnippet>154</a><span class="doccomment">/// Extract UDF arguments (as Arrow's [ArrayRef]) from [ScalarFunctionArgs] directly.
|
|
<a href=#155 id=155 data-nosnippet>155</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>extract_args<<span class="kw">const </span>N: usize>(
|
|
<a href=#156 id=156 data-nosnippet>156</a> name: <span class="kw-2">&</span>str,
|
|
<a href=#157 id=157 data-nosnippet>157</a> args: <span class="kw-2">&</span>ScalarFunctionArgs,
|
|
<a href=#158 id=158 data-nosnippet>158</a>) -> datafusion_common::Result<[ArrayRef; N]> {
|
|
<a href=#159 id=159 data-nosnippet>159</a> ColumnarValue::values_to_arrays(<span class="kw-2">&</span>args.args)
|
|
<a href=#160 id=160 data-nosnippet>160</a> .and_then(|x| datafusion_common::utils::take_function_args(name, x))
|
|
<a href=#161 id=161 data-nosnippet>161</a>}</code></pre></div></section></main></body></html> |