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

# adminBackupBegin

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

  <h2 className="memtitle"><span className="permalink"><a href="#a4092aceb8e29ca9f38b123929c3c776f">◆ </a></span>adminBackupBegin() <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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> gpudb::GPUdb::adminBackupBegin </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminBackupBeginRequest">AdminBackupBeginRequest</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>Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. </p>
      <p>When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using <a className="el" href="#ad1118f4fdb299a57ee85740f7ee35665">adminBackupEnd</a>.</p>

      <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_1AdminBackupBeginRequest">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_1AdminBackupBeginResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="aac26b7f613238faffeaac9d8e051b432" />

  <h2 className="memtitle"><span className="permalink"><a href="#aac26b7f613238faffeaac9d8e051b432">◆ </a></span>adminBackupBegin() <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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> & gpudb::GPUdb::adminBackupBegin </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminBackupBeginRequest">AdminBackupBeginRequest</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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. </p>
      <p>When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using <a className="el" href="#ad1118f4fdb299a57ee85740f7ee35665">adminBackupEnd</a>.</p>

      <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_1AdminBackupBeginRequest">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_1AdminBackupBeginResponse">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_1AdminBackupBeginResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a16e7e1682f6d135480d1ca3f56338cf9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a16e7e1682f6d135480d1ca3f56338cf9">◆ </a></span>adminBackupBegin() <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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> gpudb::GPUdb::adminBackupBegin </td>
          <td>(</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>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. </p>
      <p>When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using <a className="el" href="#a775ff2f501c87d680d6b70b7f995b7e4">adminBackupEnd</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. 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_1AdminBackupBeginResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a076206de88a2924e531a5b275f9336e9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a076206de88a2924e531a5b275f9336e9">◆ </a></span>adminBackupBegin() <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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> & gpudb::GPUdb::adminBackupBegin </td>
          <td>(</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_1AdminBackupBeginResponse">AdminBackupBeginResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. </p>
      <p>When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using <a className="el" href="#a775ff2f501c87d680d6b70b7f995b7e4">adminBackupEnd</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. 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_1AdminBackupBeginResponse">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_1AdminBackupBeginResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>