> ## 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.

# adminRemoveRanks

<div className="kinetica-doxygen">
  <div id="af47d6fbc166de5aa113aacbd9cad9ca7" />

  <h2 className="memtitle"><span className="permalink"><a href="#af47d6fbc166de5aa113aacbd9cad9ca7">◆ </a></span>adminRemoveRanks() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> gpudb::GPUdb::adminRemoveRanks </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest">AdminRemoveRanksRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Remove one or more ranks from an existing Kinetica cluster. </p>
      <p>All data will be rebalanced to other ranks before the rank(s) is removed unless the <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">rebalance\_sharded\_data</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">rebalance\_unsharded\_data</a> parameters are set to <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">false</a> in the <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest#a11f8dcac1d2fd5d158e5b4c9ce8add19">options</a>, in which case the corresponding <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> and/or unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be deleted.</p>
      <p>The database must be offline for this operation, see <a className="el" href="#a9458238afaafde877e568a92d45abb75">adminOffline</a></p>
      <p>This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a className="el" href="#a02ef4c58e395bbf2c83325cf592397af">createJob</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a96f6705e2aa15bb8a9276b900dfb75af" />

  <h2 className="memtitle"><span className="permalink"><a href="#a96f6705e2aa15bb8a9276b900dfb75af">◆ </a></span>adminRemoveRanks() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> & gpudb::GPUdb::adminRemoveRanks </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest">AdminRemoveRanksRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Remove one or more ranks from an existing Kinetica cluster. </p>
      <p>All data will be rebalanced to other ranks before the rank(s) is removed unless the <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">rebalance\_sharded\_data</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">rebalance\_unsharded\_data</a> parameters are set to <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">false</a> in the <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest#a11f8dcac1d2fd5d158e5b4c9ce8add19">options</a>, in which case the corresponding <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> and/or unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be deleted.</p>
      <p>The database must be offline for this operation, see <a className="el" href="#a9458238afaafde877e568a92d45abb75">adminOffline</a></p>
      <p>This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a className="el" href="#a02ef4c58e395bbf2c83325cf592397af">createJob</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a25fe31989868ca19f1e69c67dd67e3c0" />

  <h2 className="memtitle"><span className="permalink"><a href="#a25fe31989868ca19f1e69c67dd67e3c0">◆ </a></span>adminRemoveRanks() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> gpudb::GPUdb::adminRemoveRanks </td>
          <td>(</td>
          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">ranks</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Remove one or more ranks from an existing Kinetica cluster. </p>
      <p>All data will be rebalanced to other ranks before the rank(s) is removed unless the <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">rebalance\_sharded\_data</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">rebalance\_unsharded\_data</a> parameters are set to <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">false</a> in the <span className="em arg">options</span>, in which case the corresponding <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> and/or unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be deleted.</p>
      <p>The database must be offline for this operation, see <a className="el" href="#a4d36ee318372b12d061552af95a2910c">adminOffline</a></p>
      <p>This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a className="el" href="#a2807b0831529b2f2e6fb554339670763">createJob</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">ranks</td>
              <td>Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a>). At least one worker rank must be left in the cluster after the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">admin\_remove\_ranks\_rebalance\_sharded\_data</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">true</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 className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">admin\_remove\_ranks\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">admin\_remove\_ranks\_rebalance\_unsharded\_data</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">true</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 className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">admin\_remove\_ranks\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">admin\_remove\_ranks\_aggressiveness</a>: Influences how much data is moved at a time during rebalance. A higher <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">aggressiveness</a> will complete the rebalance faster. A lower <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">aggressiveness</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'. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="add72201686c919180950f7b44d144631" />

  <h2 className="memtitle"><span className="permalink"><a href="#add72201686c919180950f7b44d144631">◆ </a></span>adminRemoveRanks() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> & gpudb::GPUdb::adminRemoveRanks </td>
          <td>(</td>
          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">ranks</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">AdminRemoveRanksResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Remove one or more ranks from an existing Kinetica cluster. </p>
      <p>All data will be rebalanced to other ranks before the rank(s) is removed unless the <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">rebalance\_sharded\_data</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">rebalance\_unsharded\_data</a> parameters are set to <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">false</a> in the <span className="em arg">options</span>, in which case the corresponding <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> and/or unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be deleted.</p>
      <p>The database must be offline for this operation, see <a className="el" href="#a4d36ee318372b12d061552af95a2910c">adminOffline</a></p>
      <p>This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a className="el" href="#a2807b0831529b2f2e6fb554339670763">createJob</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">ranks</td>
              <td>Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a>). At least one worker rank must be left in the cluster after the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a0546b285a079b4c847ef24789b7466df">admin\_remove\_ranks\_rebalance\_sharded\_data</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">true</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 className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">admin\_remove\_ranks\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a314220f1f065de6daae02c1a756ee98f">admin\_remove\_ranks\_rebalance\_unsharded\_data</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">true</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 className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#abd6ae1c29538868f683c3682ca3f197b">admin\_remove\_ranks\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa3848331c75e8f304de305fda7bfe584">admin\_remove\_ranks\_true</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">admin\_remove\_ranks\_aggressiveness</a>: Influences how much data is moved at a time during rebalance. A higher <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">aggressiveness</a> will complete the rebalance faster. A lower <a className="el" href="/content/api/cpp/namespacegpudb#ae195a601cd7c0a760fe753d9b53d463f">aggressiveness</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'. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveRanksResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>