blob: c842456d105e1241138120d49b3f89c8d1d7ee8c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>MergeEngine xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shardingsphere/infra/merge/MergeEngine.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.apache.shardingsphere.infra.merge;
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.binder.statement.SQLStatementContext;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.config.props.ConfigurationProperties;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.decorator.impl.TransparentResultDecorator;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.session.connection.ConnectionContext;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.executor.sql.execute.result.query.QueryResult;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.ResultProcessEngine;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.decorator.ResultDecorator;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.decorator.ResultDecoratorEngine;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.merger.ResultMerger;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.engine.merger.ResultMergerEngine;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.result.MergedResult;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.merge.result.impl.transparent.TransparentMergedResult;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.rule.ShardingSphereRule;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shardingsphere.infra.util.spi.type.ordered.OrderedSPILoader;
<a class="jxr_linenumber" name="L35" href="#L35">35</a>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.sql.SQLException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.util.Map.Entry;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.util.Optional;
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Merge engine.</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="MergeEngine" href="../../../../../org/apache/shardingsphere/infra/merge/MergeEngine.html#MergeEngine">MergeEngine</a> {
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ShardingSphereDatabase database;
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConfigurationProperties props;
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> @SuppressWarnings(<span class="jxr_string">"rawtypes"</span>)
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;ShardingSphereRule, ResultProcessEngine&gt; engines;
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConnectionContext connectionContext;
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <a name="MergeEngine" href="../../../../../org/apache/shardingsphere/infra/merge/MergeEngine.html#MergeEngine">MergeEngine</a>(<strong class="jxr_keyword">final</strong> ShardingSphereDatabase database, <strong class="jxr_keyword">final</strong> ConfigurationProperties props, <strong class="jxr_keyword">final</strong> ConnectionContext connectionContext) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">this</strong>.database = database;
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">this</strong>.props = props;
<a class="jxr_linenumber" name="L59" href="#L59">59</a> engines = OrderedSPILoader.getServices(ResultProcessEngine.<strong class="jxr_keyword">class</strong>, database.getRuleMetaData().getRules());
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">this</strong>.connectionContext = connectionContext;
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Merge.</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param queryResults query results</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @param sqlStatementContext SQL statement context</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @return merged result</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @throws SQLException SQL exception</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <a name="MergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/MergedResult.html#MergedResult">MergedResult</a> merge(<strong class="jxr_keyword">final</strong> List&lt;QueryResult&gt; queryResults, <strong class="jxr_keyword">final</strong> SQLStatementContext sqlStatementContext) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> Optional&lt;MergedResult&gt; mergedResult = executeMerge(queryResults, sqlStatementContext);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> Optional&lt;MergedResult&gt; result = mergedResult.isPresent() ? Optional.of(decorate(mergedResult.get(), sqlStatementContext)) : decorate(queryResults.get(0), sqlStatementContext);
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> result.orElseGet(() -&gt; <strong class="jxr_keyword">new</strong> <a name="TransparentMergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/impl/transparent/TransparentMergedResult.html#TransparentMergedResult">TransparentMergedResult</a>(queryResults.get(0)));
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>, <span class="jxr_string">"rawtypes"</span>})
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> Optional&lt;MergedResult&gt; executeMerge(<strong class="jxr_keyword">final</strong> List&lt;QueryResult&gt; queryResults, <strong class="jxr_keyword">final</strong> SQLStatementContext sqlStatementContext) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">for</strong> (Entry&lt;ShardingSphereRule, ResultProcessEngine&gt; entry : engines.entrySet()) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">if</strong> (entry.getValue() instanceof <a name="ResultMergerEngine" href="../../../../../org/apache/shardingsphere/infra/merge/engine/merger/ResultMergerEngine.html#ResultMergerEngine">ResultMergerEngine</a>) {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <a name="ResultMerger" href="../../../../../org/apache/shardingsphere/infra/merge/engine/merger/ResultMerger.html#ResultMerger">ResultMerger</a> resultMerger = ((<a name="ResultMergerEngine" href="../../../../../org/apache/shardingsphere/infra/merge/engine/merger/ResultMergerEngine.html#ResultMergerEngine">ResultMergerEngine</a>) entry.getValue()).newInstance(database.getName(), database.getProtocolType(), entry.getKey(), props, sqlStatementContext);
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> Optional.of(resultMerger.merge(queryResults, sqlStatementContext, database, connectionContext));
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> Optional.empty();
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>, <span class="jxr_string">"rawtypes"</span>})
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <a name="MergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/MergedResult.html#MergedResult">MergedResult</a> decorate(<strong class="jxr_keyword">final</strong> <a name="MergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/MergedResult.html#MergedResult">MergedResult</a> mergedResult, <strong class="jxr_keyword">final</strong> SQLStatementContext sqlStatementContext) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <a name="MergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/MergedResult.html#MergedResult">MergedResult</a> result = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">for</strong> (Entry&lt;ShardingSphereRule, ResultProcessEngine&gt; entry : engines.entrySet()) {
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">if</strong> (entry.getValue() instanceof <a name="ResultDecoratorEngine" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecoratorEngine.html#ResultDecoratorEngine">ResultDecoratorEngine</a>) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <a name="ResultDecorator" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecorator.html#ResultDecorator">ResultDecorator</a> resultDecorator = getResultDecorator(sqlStatementContext, entry);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> result = <strong class="jxr_keyword">null</strong> == result ? resultDecorator.decorate(mergedResult, sqlStatementContext, entry.getKey()) : resultDecorator.decorate(result, sqlStatementContext, entry.getKey());
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong> == result ? mergedResult : result;
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>, <span class="jxr_string">"rawtypes"</span>})
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> Optional&lt;MergedResult&gt; decorate(<strong class="jxr_keyword">final</strong> QueryResult queryResult, <strong class="jxr_keyword">final</strong> SQLStatementContext sqlStatementContext) <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <a name="MergedResult" href="../../../../../org/apache/shardingsphere/infra/merge/result/MergedResult.html#MergedResult">MergedResult</a> result = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">for</strong> (Entry&lt;ShardingSphereRule, ResultProcessEngine&gt; entry : engines.entrySet()) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">if</strong> (entry.getValue() instanceof <a name="ResultDecoratorEngine" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecoratorEngine.html#ResultDecoratorEngine">ResultDecoratorEngine</a>) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <a name="ResultDecorator" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecorator.html#ResultDecorator">ResultDecorator</a> resultDecorator = getResultDecorator(sqlStatementContext, entry);
<a class="jxr_linenumber" name="L106" href="#L106">106</a> result = <strong class="jxr_keyword">null</strong> == result ? resultDecorator.decorate(queryResult, sqlStatementContext, entry.getKey()) : resultDecorator.decorate(result, sqlStatementContext, entry.getKey());
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> Optional.ofNullable(result);
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>, <span class="jxr_string">"rawtypes"</span>})
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> <a name="ResultDecorator" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecorator.html#ResultDecorator">ResultDecorator</a> getResultDecorator(<strong class="jxr_keyword">final</strong> SQLStatementContext sqlStatementContext, <strong class="jxr_keyword">final</strong> Entry&lt;ShardingSphereRule, ResultProcessEngine&gt; entry) {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> (<a name="ResultDecorator" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecorator.html#ResultDecorator">ResultDecorator</a>) ((<a name="ResultDecoratorEngine" href="../../../../../org/apache/shardingsphere/infra/merge/engine/decorator/ResultDecoratorEngine.html#ResultDecoratorEngine">ResultDecoratorEngine</a>) entry.getValue()).newInstance(database, entry.getKey(), props, sqlStatementContext).orElseGet(TransparentResultDecorator::<strong class="jxr_keyword">new</strong>);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>