| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.1.0/javadoc/org/apache/ignite/cache/query/SqlFieldsQuery.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jul 20 19:37:41 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SqlFieldsQuery (Ignite 2.1.0)</title> |
| <meta name="date" content="2017-07-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SqlFieldsQuery (Ignite 2.1.0)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SqlFieldsQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/ignite/cache/query/SpiQuery.html" title="class in org.apache.ignite.cache.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/cache/query/SqlFieldsQuery.html" target="_top">Frames</a></li> |
| <li><a href="SqlFieldsQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.apache.ignite.cache.query.Query">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.ignite.cache.query</div> |
| <h2 title="Class SqlFieldsQuery" class="title">Class SqlFieldsQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">org.apache.ignite.cache.query.Query</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><?>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.ignite.cache.query.SqlFieldsQuery</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SqlFieldsQuery</span> |
| extends <a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><?>></pre> |
| <div class="block">SQL Fields query. This query can return specific fields of data based |
| on SQL <code>'select'</code> clause, as opposed to <a href="../../../../../org/apache/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlQuery</code></a>, which always returns |
| the whole key and value objects back. |
| <h1 class="header">Collocated Flag</h1> |
| Collocation flag is used for optimization purposes. Whenever Ignite executes |
| a distributed query, it sends sub-queries to individual cluster members. |
| If you know in advance that the elements of your query selection are collocated |
| together on the same node, usually based on some <b>affinity-key</b>, Ignite |
| can make significant performance and network optimizations. |
| <p> |
| For example, in case of Word-Count example, we know that all identical words |
| are processed on the same cluster member, because we use the <code>word</code> itself |
| as affinity key. This allows Ignite to execute the <code>'limit'</code> clause on |
| the remote nodes and bring back only the small data set specified within the 'limit' clause, |
| instead of the whole query result as would happen in a non-collocated execution.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/ignite/IgniteCache.html#query(org.apache.ignite.cache.query.Query)"><code>IgniteCache.query(Query)</code></a>, |
| <a href="../../../../../serialized-form.html#org.apache.ignite.cache.query.SqlFieldsQuery">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.ignite.cache.query.Query"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.ignite.cache.query.<a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a></h3> |
| <code><a href="../../../../../org/apache/ignite/cache/query/Query.html#DFLT_PAGE_SIZE">DFLT_PAGE_SIZE</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#SqlFieldsQuery(java.lang.String)">SqlFieldsQuery</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql)</code> |
| <div class="block">Constructs SQL fields query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#SqlFieldsQuery(java.lang.String,%20boolean)">SqlFieldsQuery</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql, |
| boolean collocated)</code> |
| <div class="block">Constructs SQL fields query.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#getArgs()">getArgs</a></strong>()</code> |
| <div class="block">Gets SQL arguments.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#getPartitions()">getPartitions</a></strong>()</code> |
| <div class="block">Gets partitions for query, in ascending order.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#getSchema()">getSchema</a></strong>()</code> |
| <div class="block">Get schema for the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#getSql()">getSql</a></strong>()</code> |
| <div class="block">Gets SQL clause.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#getTimeout()">getTimeout</a></strong>()</code> |
| <div class="block">Gets the query execution timeout in milliseconds.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#isCollocated()">isCollocated</a></strong>()</code> |
| <div class="block">Checks if this query is collocated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#isDistributedJoins()">isDistributedJoins</a></strong>()</code> |
| <div class="block">Check if distributed joins are enabled for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#isEnforceJoinOrder()">isEnforceJoinOrder</a></strong>()</code> |
| <div class="block">Checks if join order of tables if enforced.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#isReplicatedOnly()">isReplicatedOnly</a></strong>()</code> |
| <div class="block">Check is the query contains only replicated tables.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setArgs(java.lang.Object...)">setArgs</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> |
| <div class="block">Sets SQL arguments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setCollocated(boolean)">setCollocated</a></strong>(boolean collocated)</code> |
| <div class="block">Sets flag defining if this query is collocated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setDistributedJoins(boolean)">setDistributedJoins</a></strong>(boolean distributedJoins)</code> |
| <div class="block">Specify if distributed joins are enabled for this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setEnforceJoinOrder(boolean)">setEnforceJoinOrder</a></strong>(boolean enforceJoinOrder)</code> |
| <div class="block">Sets flag to enforce join order of tables in the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setLocal(boolean)">setLocal</a></strong>(boolean loc)</code> |
| <div class="block">Sets whether this query should be executed on local node only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setPageSize(int)">setPageSize</a></strong>(int pageSize)</code> |
| <div class="block">Sets optional page size, if <code>0</code>, then default is used.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setPartitions(int...)">setPartitions</a></strong>(int... parts)</code> |
| <div class="block">Sets partitions for a query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setReplicatedOnly(boolean)">setReplicatedOnly</a></strong>(boolean replicatedOnly)</code> |
| <div class="block">Specify if the query contains only replicated tables.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setSchema(java.lang.String)">setSchema</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schema)</code> |
| <div class="block">Set schema for the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setSql(java.lang.String)">setSql</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql)</code> |
| <div class="block">Sets SQL clause.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#setTimeout(int,%20java.util.concurrent.TimeUnit)">setTimeout</a></strong>(int timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">Sets the query execution timeout.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html#toString()">toString</a></strong>()</code></td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.ignite.cache.query.Query"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.ignite.cache.query.<a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a></h3> |
| <code><a href="../../../../../org/apache/ignite/cache/query/Query.html#getPageSize()">getPageSize</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#isLocal()">isLocal</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#prepare(int[])">prepare</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SqlFieldsQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SqlFieldsQuery</h4> |
| <pre>public SqlFieldsQuery(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql)</pre> |
| <div class="block">Constructs SQL fields query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sql</code> - SQL query.</dd></dl> |
| </li> |
| </ul> |
| <a name="SqlFieldsQuery(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SqlFieldsQuery</h4> |
| <pre>public SqlFieldsQuery(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql, |
| boolean collocated)</pre> |
| <div class="block">Constructs SQL fields query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sql</code> - SQL query.</dd><dd><code>collocated</code> - Collocated flag.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSql()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSql</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSql()</pre> |
| <div class="block">Gets SQL clause.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>SQL clause.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSql(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSql</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setSql(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sql)</pre> |
| <div class="block">Sets SQL clause.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sql</code> - SQL clause.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="getArgs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgs</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] getArgs()</pre> |
| <div class="block">Gets SQL arguments.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>SQL arguments.</dd></dl> |
| </li> |
| </ul> |
| <a name="setArgs(java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArgs</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setArgs(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</pre> |
| <div class="block">Sets SQL arguments.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - SQL arguments.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="getTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre>public int getTimeout()</pre> |
| <div class="block">Gets the query execution timeout in milliseconds.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Timeout value.</dd></dl> |
| </li> |
| </ul> |
| <a name="setTimeout(int, java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setTimeout(int timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">Sets the query execution timeout. Query will be automatically cancelled if the execution timeout is exceeded.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Timeout value. Zero value disables timeout.</dd><dd><code>timeUnit</code> - Time unit.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="isCollocated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCollocated</h4> |
| <pre>public boolean isCollocated()</pre> |
| <div class="block">Checks if this query is collocated.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> If the query is collocated.</dd></dl> |
| </li> |
| </ul> |
| <a name="setCollocated(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCollocated</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setCollocated(boolean collocated)</pre> |
| <div class="block">Sets flag defining if this query is collocated. |
| |
| Collocation flag is used for optimization purposes of queries with GROUP BY statements. |
| Whenever Ignite executes a distributed query, it sends sub-queries to individual cluster members. |
| If you know in advance that the elements of your query selection are collocated together on the same node and |
| you group by collocated key (primary or affinity key), then Ignite can make significant performance and network |
| optimizations by grouping data on remote nodes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>collocated</code> - Flag value.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="isEnforceJoinOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnforceJoinOrder</h4> |
| <pre>public boolean isEnforceJoinOrder()</pre> |
| <div class="block">Checks if join order of tables if enforced.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Flag value.</dd></dl> |
| </li> |
| </ul> |
| <a name="setEnforceJoinOrder(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnforceJoinOrder</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setEnforceJoinOrder(boolean enforceJoinOrder)</pre> |
| <div class="block">Sets flag to enforce join order of tables in the query. If set to <code>true</code> |
| query optimizer will not reorder tables in join. By default is <code>false</code>. |
| <p> |
| It is not recommended to enable this property until you are sure that |
| your indexes and the query itself are correct and tuned as much as possible but |
| query optimizer still produces wrong join order.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>enforceJoinOrder</code> - Flag value.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="setDistributedJoins(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDistributedJoins</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setDistributedJoins(boolean distributedJoins)</pre> |
| <div class="block">Specify if distributed joins are enabled for this query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>distributedJoins</code> - Distributed joins enabled.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="isDistributedJoins()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistributedJoins</h4> |
| <pre>public boolean isDistributedJoins()</pre> |
| <div class="block">Check if distributed joins are enabled for this query.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> If distributed joind enabled.</dd></dl> |
| </li> |
| </ul> |
| <a name="setPageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setPageSize(int pageSize)</pre> |
| <div class="block">Sets optional page size, if <code>0</code>, then default is used.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#setPageSize(int)">setPageSize</a></code> in class <code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><?>></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>pageSize</code> - Optional page size.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> for chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="setLocal(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocal</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setLocal(boolean loc)</pre> |
| <div class="block">Sets whether this query should be executed on local node only.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#setLocal(boolean)">setLocal</a></code> in class <code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><?>></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>loc</code> - Local flag.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> for chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="setReplicatedOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReplicatedOnly</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setReplicatedOnly(boolean replicatedOnly)</pre> |
| <div class="block">Specify if the query contains only replicated tables. |
| This is a hint for potentially more effective execution.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>replicatedOnly</code> - The query contains only replicated tables.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> For chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="isReplicatedOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReplicatedOnly</h4> |
| <pre>public boolean isReplicatedOnly()</pre> |
| <div class="block">Check is the query contains only replicated tables.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> If the query contains only replicated tables.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPartitions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitions</h4> |
| <pre>@Nullable |
| public int[] getPartitions()</pre> |
| <div class="block">Gets partitions for query, in ascending order.</div> |
| </li> |
| </ul> |
| <a name="setPartitions(int...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitions</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setPartitions(@Nullable |
| int... parts)</pre> |
| <div class="block">Sets partitions for a query. |
| The query will be executed only on nodes which are primary for specified partitions. |
| <p> |
| Note what passed array'll be sorted in place for performance reasons, if it wasn't sorted yet.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</code> - Partitions.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> for chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>@Nullable |
| public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSchema()</pre> |
| <div class="block">Get schema for the query. |
| If not set, current cache name is used, which means you can |
| omit schema name for tables within the current cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Schema. Null if schema is not set.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSchema(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchema</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a> setSchema(@Nullable |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schema)</pre> |
| <div class="block">Set schema for the query. |
| If not set, current cache name is used, which means you can |
| omit schema name for tables within the current cache.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - Schema. Null to unset schema.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>this</code> for chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#toString()">toString</a></code> in class <code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><?>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SqlFieldsQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/ignite/cache/query/SpiQuery.html" title="class in org.apache.ignite.cache.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/cache/query/SqlFieldsQuery.html" target="_top">Frames</a></li> |
| <li><a href="SqlFieldsQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.apache.ignite.cache.query.Query">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2017 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>: ver. <strong>2.1.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: July 20 2017 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
