genai-toolbox/docs/en/resources/tools/cloudsql/cloudsqlrestorebackup.md at caa33d41b23e2a01c883ffd37e95f3ddcbff6bc0

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-29 01:08:01 -05:00

Files

Eric Wang 00c3e6d8cb feat(prebuilt/cloud-sql): Add restore backup tool for cloud sql (#2171 )

## Description

This pull request adds a new tool, cloud-sql-restore-backup, which
enables restoring a backup onto a Cloud SQL instance from the toolbox
using the Cloud SQL Admin API. The tool supports restoring standard,
project level, and BackupDR backups.

Tested:
<img width="3758" height="532" alt="image"
src="https://github.com/user-attachments/assets/d1d61af7-d96e-417c-898c-65b876de4c5e"
/>


## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #2170

Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-16 00:16:46 +00:00

2.5 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
cloud-sql-restore-backup	docs	10	Restores a backup of a Cloud SQL instance.

The cloud-sql-restore-backup tool restores a backup on a Cloud SQL instance using the Cloud SQL Admin API.

{{< notice info dd>}} This tool uses a source of kind cloud-sql-admin. {{< /notice >}}

Examples

Basic backup restore

tools:
  backup-restore-basic:
    kind: cloud-sql-restore-backup
    source: cloud-sql-admin-source
    description: "Restores a backup onto the given Cloud SQL instance."

Reference

Tool Configuration

field	type	required	description
kind	string	true	Must be "cloud-sql-restore-backup".
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

Tool Inputs

parameter	type	required	description
target_project	string	true	The project ID of the instance to restore the backup onto.
target_instance	string	true	The instance to restore the backup onto. Does not include the project ID.
backup_id	string	true	The identifier of the backup being restored.
source_project	string	false	(Optional) The project ID of the instance that the backup belongs to.
source_instance	string	false	(Optional) Cloud SQL instance ID of the instance that the backup belongs to.

Usage Notes

The backup_id field can be a BackupRun ID (which will be an int64), backup name, or BackupDR backup name.
If the backup_id field contains a BackupRun ID (i.e. an int64), the optional fields source_project and source_instance must also be provided.

2.5 KiB Raw Blame History