-
Notifications
You must be signed in to change notification settings - Fork 11
docs(cloud): add Cloud Operations section with Export and Import guide #511
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| --- | ||
| title: "Export and Import" | ||
| parent: "Cloud Operations" | ||
| nav_order: 1 | ||
| description: "Export and import a FalkorDB Cloud instance using RDB. Export to a download link, Google Cloud Storage, or Amazon S3. Import from a file, URL, cloud storage, or another instance. Schedule recurring exports on Pro and Enterprise." | ||
| --- | ||
|
|
||
| # Export and Import | ||
|
|
||
| FalkorDB Cloud lets you export and import an instance from the **Import/Export RDB** tab on the instance page. An export writes an RDB file of your data. An import loads an RDB into your instance. RDB is the binary snapshot format used by FalkorDB. | ||
|
|
||
|  | ||
|
|
||
| ## Before you begin | ||
|
|
||
| - The instance must be in the **Running** state. | ||
| - Your access depends on your subscription role. Export needs the **root**, **editor**, or **reader** role. Import needs the **root** or **editor** role. | ||
| - One export or import task runs at a time per instance. A new request while another task is in progress is rejected. | ||
| - When you use your own cloud storage, the access credentials are used only to reach your bucket for that task. They are not stored on the task record. | ||
|
|
||
| ## Export | ||
|
|
||
| An export writes a copy of your instance data to a destination you choose. | ||
|
|
||
| 1. Open the **Import/Export RDB** tab on your instance. | ||
| 2. Select **Export RDB**. | ||
| 3. Choose a destination and fill in the details. | ||
| 4. Select **Export**. | ||
|
|
||
| The task appears in the list. When it completes you can track it under **Output**. | ||
|
|
||
| ### Temporary link | ||
|
|
||
| FalkorDB writes the export to managed storage and generates a download link. The link is valid for **one hour**. | ||
|
|
||
|  | ||
|
|
||
| When the task completes, select **Download** in the **Output** column to retrieve the file. | ||
|
|
||
|  | ||
|
|
||
| ### Google Cloud Storage | ||
|
|
||
| FalkorDB writes the export to your own Google Cloud Storage bucket. Provide the bucket name and a GCP service account key with permission to create objects in that bucket. | ||
|
|
||
|  | ||
|
|
||
| ### Amazon S3 | ||
|
|
||
| FalkorDB writes the export to your own Amazon S3 bucket. Provide the bucket name, region, and AWS access credentials with permission to create objects in that bucket. A session token is optional. | ||
|
|
||
|  | ||
|
|
||
| ## Import | ||
|
|
||
| An import loads an RDB into your instance. | ||
|
|
||
| > **Caution.** The instance is erased before the import takes place. FalkorDB takes a safety copy of the current data before clearing it, and verifies the imported key count after the load. | ||
|
|
||
| 1. Open the **Import/Export RDB** tab on your instance. | ||
| 2. Select **Import RDB**. | ||
| 3. Choose a source and fill in the details. | ||
| 4. Select **Import**. | ||
|
|
||
| ### Upload a file | ||
|
|
||
| Upload an RDB file from your local machine. | ||
|
|
||
|  | ||
|
|
||
| ### URL | ||
|
|
||
| Provide a public HTTPS URL to the RDB file. The URL must use HTTPS and must not point to a private or internal address. FalkorDB checks that the file is reachable before it starts. | ||
|
|
||
| ### Google Cloud Storage | ||
|
|
||
| Read the RDB from your own Google Cloud Storage bucket. Provide the bucket name, the RDB file path, and a GCP service account key with permission to read objects from that bucket. | ||
|
|
||
|  | ||
|
|
||
| ### Amazon S3 | ||
|
|
||
| Read the RDB from your own Amazon S3 bucket. Provide the bucket name, the RDB file path, the region, and AWS access credentials with permission to read objects from that bucket. A session token is optional. | ||
|
|
||
|  | ||
|
|
||
| ### Another instance | ||
|
|
||
| Clone the data from another running FalkorDB Cloud instance. FalkorDB checks that the source data fits the destination before it starts. | ||
|
|
||
| ## Scheduled exports | ||
|
|
||
| Scheduled exports are available on the **Pro** and **Enterprise** tiers. On lower tiers the **Schedules** button is disabled. | ||
|
|
||
| Open **Schedules** from the **Import/Export RDB** tab to create and manage them. | ||
|
|
||
| - Set how often the export runs. The period is at least **60 minutes** and a multiple of 15. | ||
| - Set the minute of the hour the export starts. The choices are **0, 15, 30, or 45**. | ||
| - You can keep up to **2 schedules** per instance. | ||
| - A schedule is disabled automatically after **3 consecutive failures**. | ||
|
|
||
| A scheduled export supports the same destinations as a one off export. A scheduled import clones from another instance. | ||
|
|
||
| ## Task history | ||
|
|
||
| The task list on the **Import/Export RDB** tab shows your past exports and imports. Each row shows the task type, the source or destination, the status, the timestamps, and the output. Statuses move from **created** to **pending**, **in_progress**, and then **completed** or **failed**. | ||
|
|
||
| ## Limits | ||
|
|
||
| | Item | Value | | ||
| | :--- | :--- | | ||
| | Concurrent tasks per instance | 1 | | ||
| | Instance state required | Running | | ||
| | Scheduled exports | Pro and Enterprise only | | ||
| | Schedules per instance | Up to 2 | | ||
| | Schedule period | 60 minutes or more, multiple of 15 | | ||
| | Schedule start minute | 0, 15, 30, or 45 | | ||
| | Temporary download link validity | 1 hour | | ||
| | Upload link validity | 1 hour | | ||
| | Import size | Must fit the destination capacity | | ||
|
|
||
| ## Getting Support | ||
|
|
||
| Questions about an export or import? Email **[support@falkordb.com](mailto:support@falkordb.com)**. See the [Support page](/support/) for what to include in your request. | ||
|
|
||
| {% include faq_accordion.html | ||
| title="Frequently Asked Questions" | ||
| q1="How is an export different from a snapshot or an automatic backup?" | ||
| a1="An export is an **RDB file you create or schedule**, sent to a download link or your own cloud storage. Automatic backups and snapshots are taken by the platform and are managed separately. See your tier page for those policies." | ||
| q2="Does an import overwrite my current data?" | ||
| a2="Yes. The instance is **erased before the import**. FalkorDB takes a safety copy of the current data before clearing it, then verifies the imported key count after the load." | ||
| q3="Which destinations and sources are supported?" | ||
| a3="Export goes to a **temporary download link**, **Google Cloud Storage**, or **Amazon S3**. Import reads from an **uploaded file**, a **URL**, **Google Cloud Storage**, **Amazon S3**, or **another instance**." | ||
| q4="Can I schedule exports on any tier?" | ||
| a4="Scheduled exports are available on the **Pro** and **Enterprise** tiers. On lower tiers the Schedules button is disabled." | ||
| q5="Are my cloud storage credentials stored?" | ||
| a5="No. Credentials you enter for your own bucket are used only to reach that bucket for the task. They are not kept on the task record." | ||
| %} | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,15 @@ | ||||||
| --- | ||||||
| title: "Cloud Operations" | ||||||
| parent: "Cloud DBaaS" | ||||||
| nav_order: 7 | ||||||
| has_children: true | ||||||
| description: "Operational guides for FalkorDB Cloud, including RDB export and import for your managed graph database." | ||||||
| --- | ||||||
|
|
||||||
| # Cloud Operations | ||||||
|
|
||||||
| Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Use “day-to-day” here. The current wording is awkward in user-facing docs. Suggested edit-Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console.
+Operational guides for running your FalkorDB Cloud deployment. These guides cover day-to-day tasks you perform from the FalkorDB Cloud console.📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~11-~11: Use a hyphen to join words. (QB_NEW_EN_HYPHEN) 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||||||
|
|
||||||
| ## [Export and Import](/cloud/operations/export-import) | ||||||
|
|
||||||
| Export your instance to a download link or your own cloud storage. Import from a file, a URL, your cloud storage, or another instance. Schedule recurring exports on Pro and Enterprise. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Hyphenate "one-off" for correct grammar.
User-facing docs should use the standard hyphenated form: "one-off" rather than "one off."
📝 Suggested fix
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~102-~102: Use a hyphen to join words.
Context: ... supports the same destinations as a one off export. A scheduled import clones fr...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents