docs/topics/impala_max_spilled_result_spooling_mem.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="MAX_SPILLED_RESULT_SPOOLING_MEM" rev="2.10.0 IMPALA-3200">
  <title>MAX_SPILLED_RESULT_SPOOLING_MEM Query Option</title>
  <titlealts audience="PDF">
    <navtitle>MAX_SPILLED_RESULT_SPOOLING_MEM</navtitle>
  </titlealts>
  <prolog>
    <metadata>
      <data name="Category" value="Impala"/>
      <data name="Category" value="Impala Query Options"/>
      <data name="Category" value="Querying"/>
      <data name="Category" value="Developers"/>
      <data name="Category" value="Data Analysts"/>
    </metadata>
  </prolog>
  <conbody>
    <p>Use the <codeph>MAX_SPILLED_RESULT_SPOOLING_MEM</codeph> query option to
      set the maximum amount of memory that can be spilled when spooling query
      results. </p>
    <p>If the amount of memory exceeds this value when spooling query results,
      the coordinator fragment will block until the client has consumed enough
      rows to free up more memory.</p>
    <p>The <codeph>MAX_SPILLED_RESULT_SPOOLING_MEM</codeph> query option is
      applicable only when query result spooling is enabled with the
        <codeph>SPOOL_QUERY_RESULTS</codeph> query option set to
        <codeph>TRUE</codeph>. </p>
    <p>The value must be greater than or equal to the value of
        <codeph>MAX_RESULT_SPOOLING_MEM</codeph>.</p>
    <p>Setting the option to <codeph>0</codeph> or <codeph>-1</codeph> means the
      memory is unbounded. </p>
    <p>Values below <codeph>-1</codeph> are not allowed for this query
      option.</p>
    <p><b>Type:</b>
      <codeph>INT</codeph></p>
    <p><b>Default:</b><codeph> 1024 * 1024 * 1024 (1 GB)</codeph></p>
    <p><b>Added in:</b>
      <keyword keyref="impala34"/></p>
    <p><b>Related information:</b>
      <xref href="impala_fetch_rows_timeout_ms.xml#FETCH_ROWS_TIMEOUT_MS"/>,
        <xref
        href="impala_max_spilled_result_spooling_mem.xml#MAX_SPILLED_RESULT_SPOOLING_MEM"
      />, <xref href="impala_spool_query_results.xml#SPOOL_QUERY_RESULTS"/></p>
  </conbody>
</concept>