Skip to main content

Upload a SQL Dump File

Follow this guide to upload a SQL dump file you created or received into KIOPS and keep it in the Data Package storage. It is the first step of the flow for registering a partner's pg_dump output or a mysqldump from another environment in KIOPS so you can apply it to a target DB later.

The upload itself does not apply the dump to a target DB. Picking a file stores it immediately, and applying it is done with the procedure in the Using the Data Package Storage guide.

Before You Start: Terms to Know​

  • SQL dump: A file that captures schema and data as SQL statements. KIOPS accepts .sql (plain text) and .sql.gz (gzip-compressed) formats.
  • Data package: A SQL dump kept inside KIOPS. It stores the upload time, DB type, and apply history together.
  • Target DB: The destination DB where the dump will be applied. During the apply step you pick one of the connections registered on the DB Connections tab.
  • append mode: Applies the dump's CREATE/INSERT statements as-is. Can fail if existing PK/UK rows collide.
  • replace mode: Wipes the target schema/data and refills with the dump's content (be careful about data loss).

Prerequisites​

Permissions and file readiness
  • Database Management permission: The [Database Management] page and the Data Package tab must be visible. If not, ask your organization admin for permission.
  • A SQL dump file: The .sql or .sql.gz file to upload must be on your local PC.
  • Storage headroom: Your organization's storage must be within the 5GB quota for the upload to be allowed.

Obtaining the dump file​

If you are not a developer, ask the source-DB owner to produce the dump in one of these forms.

  • MySQL/MariaDB source: mysqldump --single-transaction --routines [DB_NAME] > backup.sql
  • PostgreSQL source: pg_dump --no-owner --no-privileges [DB_NAME] > backup.sql
  • Compressed transfer: For large files, ask them to add gzip backup.sql to deliver backup.sql.gz. Upload time drops noticeably.

The upload limit is 1GB. If the dump exceeds that, split it by table into several files and upload each one.

Step 1. Open the Data Package Tab​

  1. From the left menu, select [Database Management].
  2. Switch to the Data Package tab at the top.
  3. The upper right of the tab shows two buttons: Upload SQL File and Refresh.

Step 2. Click the Upload SQL File Button​

  1. Click the Upload SQL File button in the upper right.
  2. The operating system's file picker opens. Choose a .sql or .sql.gz file.
  3. Once you select a file, the upload starts immediately with no separate modal. There is no step at this point for choosing an import mode or a target DB.
Uploading is not the same as applying

Upload SQL File only keeps the file in the data package storage. It is not applied to any target DB. Applying is a separate step done after the upload completes.

Step 3. Confirm the Upload Completed​

  1. When the upload finishes, a new row appears at the top of the package list.
  2. The new package is registered as follows.
    • Status: ready (ready to be applied)
    • Type: import
    • Name: the uploaded file name (display name)
  3. If you uploaded a .sql.gz, KIOPS automatically decompresses it and keeps it as .sql.

Step 4. Apply to a Target DB​

To actually load the uploaded package into a DB, use one of these two paths.

  • Apply from the Data Package tab: Click the Apply button (lightning icon) in the package row's action column to open the PackageApplyModal. There you pick the target DB and the append/replace mode.
  • Apply from the Migration tab: In the Migration tab, set "Source type" to "Stored data package (one-time apply)" to apply a stored package to a target.

For the detailed apply procedure, see the Using the Data Package Storage guide.

Replace mode is irreversible

The replace mode in the apply step deletes all data in the target DB before overwriting it with the dump. Before touching production, take a backup from the [Database Management] > Backup Management tab, or rehearse the same dump on staging in append mode first.

Common Mistakes​

Common mistake: thinking the apply is done after uploading

Upload SQL File only keeps the file in storage. A ready status means "ready to apply", not "applied". To actually reflect it in a target DB, you must separately follow the apply step in the Using the Data Package Storage guide.

Common mistake: trying to upload a dump larger than 1GB

The upload cap is 1GB. For larger dumps, split the file table-by-table into several files and upload each one.

Common mistake: looking for the upload button in the Migration tab

The Migration tab has no SQL file upload button. File upload is only available on the Data Package tab. The Migration tab is for "schema comparison between registered DB connections" or "one-time apply of a stored data package".

Worked Examples​

Example A. Keeping a partner's PostgreSQL dump in KIOPS​

  1. Right after receiving the .sql.gz, open the Data Package tab > Upload SQL File.
  2. Selecting the received file uploads it immediately and registers it in the package list with ready status.
  3. When you later apply it to a production PostgreSQL, use the Apply button on the package row to open the PackageApplyModal.

Example B. Pre-storing a dump for rollout to multiple environments​

  1. Upload a SQL dump file on the Data Package tab.
  2. Once stored, you can reuse the Apply button on that package for dev → staging → prod in turn.
  3. No need to re-upload the file each time.

What to Do Next​