> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AdminRebalanceRequest.Options

> AdminRebalanceRequest.Options — Kinetica Java API

<div className="kinetica-javadoc">
  <div className="header">
    <div className="sub-title"><span className="package-label-in-type">Package</span> <a href="/content/api/java/com/gpudb/protocol/package-summary">com.gpudb.protocol</a></div>
    <h1 title="Class AdminRebalanceRequest.Options" className="title">Class AdminRebalanceRequest.Options</h1>
  </div>

  <div className="inheritance" title="Inheritance Tree">
    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">java.lang.Object</a>
    <div className="inheritance">com.gpudb.protocol.AdminRebalanceRequest.Options</div>
  </div>

  <div className="section class-description" id="class-description">
    <div className="dl notes">
      <div className="dt">Enclosing class:</div>
      <div className="dd"><code><a href="/content/api/java/com/gpudb/protocol/AdminRebalanceRequest" title="class in com.gpudb.protocol">AdminRebalanceRequest</a></code></div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">AdminRebalanceRequest.Options</span> <span className="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></span></div>

    <div className="block">
      A set of string constants for the <a href="/content/api/java/com/gpudb/protocol/AdminRebalanceRequest" title="class in com.gpudb.protocol"><code>AdminRebalanceRequest</code></a> parameter <a href="/content/api/java/com/gpudb/protocol/AdminRebalanceRequest#getOptions()"><code>options</code></a>.
      <p> Optional parameters.</p>
    </div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section field-summary" id="field-summary">
          <h2>Field Summary</h2>
          <div className="caption"><span>Fields</span></div>

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Field</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#AGGRESSIVENESS" className="member-name-link">AGGRESSIVENESS</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Influences how much data is moved at a time during rebalance.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#COMPACT_AFTER_REBALANCE" className="member-name-link">COMPACT\_AFTER\_REBALANCE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Perform compaction of deleted records once the rebalance completes to reclaim memory and disk space.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#COMPACT_ONLY" className="member-name-link">COMPACT\_ONLY</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">If set to <a href="#TRUE"><code>TRUE</code></a>, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#FALSE" className="member-name-link">FALSE</a></code></div>
            <div className="col-last odd-row-color"> </div>
            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#REBALANCE_SHARDED_DATA" className="member-name-link">REBALANCE\_SHARDED\_DATA</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">If <a href="#TRUE"><code>TRUE</code></a>, <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> will be rebalanced approximately equally across the cluster.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#REBALANCE_UNSHARDED_DATA" className="member-name-link">REBALANCE\_UNSHARDED\_DATA</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">If <a href="#TRUE"><code>TRUE</code></a>, unsharded data (a.k.a.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#REPAIR_INCORRECTLY_SHARDED_DATA" className="member-name-link">REPAIR\_INCORRECTLY\_SHARDED\_DATA</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Scans for any data sharded incorrectly and re-routes the data to the correct location.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#TABLE_EXCLUDES" className="member-name-link">TABLE\_EXCLUDES</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Comma-separated list of unsharded table names to not rebalance.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#TABLE_INCLUDES" className="member-name-link">TABLE\_INCLUDES</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Comma-separated list of unsharded table names to rebalance.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#TRUE" className="member-name-link">TRUE</a></code></div>
            <div className="col-last odd-row-color"> </div>
          </div>
        </div>
      </li>

      <li>
        <div className="section method-summary" id="method-summary">
          <h2>Method Summary</h2>

          <div className="inherited-list">
            <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></h3>
            <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" className="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" className="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" className="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" className="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" className="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" className="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" className="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" className="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" className="external-link">wait</a></code>
          </div>
        </div>
      </li>
    </ul>
  </div>

  <div className="section details">
    <ul className="details-list">
      <li>
        <div className="section field-details" id="field-detail">
          <h2>Field Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="REBALANCE_SHARDED_DATA">
                <h3>REBALANCE\_SHARDED\_DATA</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">REBALANCE\_SHARDED\_DATA</span></div>

                <div className="block">
                  If <a href="#TRUE"><code>TRUE</code></a>, <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#TRUE"><code>TRUE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.REBALANCE_SHARDED_DATA">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="TRUE">
                <h3>TRUE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">TRUE</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.TRUE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="FALSE">
                <h3>FALSE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">FALSE</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.FALSE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="REBALANCE_UNSHARDED_DATA">
                <h3>REBALANCE\_UNSHARDED\_DATA</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">REBALANCE\_UNSHARDED\_DATA</span></div>

                <div className="block">
                  If <a href="#TRUE"><code>TRUE</code></a>, unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#TRUE"><code>TRUE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.REBALANCE_UNSHARDED_DATA">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="TABLE_INCLUDES">
                <h3>TABLE\_INCLUDES</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">TABLE\_INCLUDES</span></div>
                <div className="block">Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with <a href="#TABLE_EXCLUDES"><code>TABLE\_EXCLUDES</code></a>. This parameter is ignored if <a href="#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a> is <a href="#FALSE"><code>FALSE</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.TABLE_INCLUDES">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="TABLE_EXCLUDES">
                <h3>TABLE\_EXCLUDES</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">TABLE\_EXCLUDES</span></div>
                <div className="block">Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with <a href="#TABLE_INCLUDES"><code>TABLE\_INCLUDES</code></a>. This parameter is ignored if <a href="#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a> is <a href="#FALSE"><code>FALSE</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.TABLE_EXCLUDES">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="AGGRESSIVENESS">
                <h3>AGGRESSIVENESS</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">AGGRESSIVENESS</span></div>
                <div className="block">Influences how much data is moved at a time during rebalance. A higher <a href="#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will complete the rebalance faster. A lower <a href="#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.AGGRESSIVENESS">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="COMPACT_AFTER_REBALANCE">
                <h3>COMPACT\_AFTER\_REBALANCE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">COMPACT\_AFTER\_REBALANCE</span></div>

                <div className="block">
                  Perform compaction of deleted records once the rebalance completes to reclaim memory and disk space. Default is <a href="#TRUE"><code>TRUE</code></a>, unless <a href="#REPAIR_INCORRECTLY_SHARDED_DATA"><code>REPAIR\_INCORRECTLY\_SHARDED\_DATA</code></a> is set to <a href="#TRUE"><code>TRUE</code></a>. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#TRUE"><code>TRUE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.COMPACT_AFTER_REBALANCE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="COMPACT_ONLY">
                <h3>COMPACT\_ONLY</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">COMPACT\_ONLY</span></div>

                <div className="block">
                  If set to <a href="#TRUE"><code>TRUE</code></a>, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#FALSE"><code>FALSE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.COMPACT_ONLY">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="REPAIR_INCORRECTLY_SHARDED_DATA">
                <h3>REPAIR\_INCORRECTLY\_SHARDED\_DATA</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">REPAIR\_INCORRECTLY\_SHARDED\_DATA</span></div>

                <div className="block">
                  Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if <a href="/content/api/java/com/gpudb/GPUdb#adminVerifyDb(com.gpudb.protocol.AdminVerifyDbRequest)"><code>GPUdb.adminVerifyDb</code></a> reports an error in sharding alignment. This can be done as part of a typical rebalance after expanding the cluster or in a standalone fashion when it is believed that data is sharded incorrectly somewhere in the cluster. Compaction will not be performed by default when this is enabled. If this option is set to <a href="#TRUE"><code>TRUE</code></a>, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#FALSE"><code>FALSE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.AdminRebalanceRequest.Options.REPAIR_INCORRECTLY_SHARDED_DATA">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>