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

# admin_backup_begin

### admin\_backup\_begin

<ul>
  <li>
    admin\_backup\_begin(\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginResponse.md)>

    Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. 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 `admin_backup_end`.

    #### Parameters

    <ul>
      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginResponse.md)>

    Promise\<Types.AdminBackupBeginResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:2173](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L2173)</li>
    </ul>
  </li>
</ul>

### admin\_backup\_begin\_request

<ul>
  <li>
    admin\_backup\_begin\_request(\
    &#x20;request: [AdminBackupBeginRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginResponse.md)>

    Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. 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 `admin_backup_end`.

    #### Parameters

    <ul>
      <li>
        request: [AdminBackupBeginRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminBackupBeginResponse.md)>

    Promise\<Types.AdminBackupBeginResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:2149](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L2149)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.