Usage
All scripts can be executed using Node.js. Replace <param_name> and
<param_value> with actual values.
Bash: node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'
PowerShell: node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\": \"<param_value>\"}'
Note: The scripts automatically load the environment variables from various .env files. Do not ask the user to set vars unless skill executions fails due to env var absence.
Scripts
create_database
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| instance | string | The ID of the | Yes | |
| : : : instance where : : : | ||||
| : : : the database : : : | ||||
| : : : will be : : : | ||||
| : : : created. : : : | ||||
| name | string | The name for | Yes | |
| : : : the new : : : | ||||
| : : : database. Must : : : | ||||
| : : : be unique : : : | ||||
| : : : within the : : : | ||||
| : : : instance. : : : |
create_instance
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| name | string | The name of the | Yes | |
| : : : instance : : : | ||||
| databaseVersion | string | The database | No | MYSQL_8_4 |
| : : : version for : : : | ||||
| : : : MySQL. If not : : : | ||||
| : : : specified, : : : | ||||
| : : : defaults to the : : : | ||||
| : : : latest : : : | ||||
| : : : available : : : | ||||
| : : : version (e.g., : : : | ||||
| : : : MYSQL_8_4). : : : | ||||
| rootPassword | string | The root | Yes | |
| : : : password for : : : | ||||
| : : : the instance : : : | ||||
| editionPreset | string | The edition of | No | Development |
| : : : the instance. : : : | ||||
| : : : Can be : : : | ||||
: : : Production or : : : |
||||
: : : Development. : : : |
||||
| : : : This determines : : : | ||||
| : : : the default : : : | ||||
| : : : machine type : : : | ||||
| : : : and : : : | ||||
| : : : availability. : : : | ||||
| : : : Defaults to : : : | ||||
: : : Development. : : : |
create_user
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| instance | string | The ID of the | Yes | |
| : : : instance where : : : | ||||
| : : : the user will : : : | ||||
| : : : be created. : : : | ||||
| name | string | The name for | Yes | |
| : : : the new user. : : : | ||||
| : : : Must be unique : : : | ||||
| : : : within the : : : | ||||
| : : : instance. : : : | ||||
| password | string | A secure | No | |
| : : : password for : : : | ||||
| : : : the new user. : : : | ||||
| : : : Not required : : : | ||||
| : : : for IAM users. : : : | ||||
| iamUser | boolean | Set to true to | Yes | |
| : : : create a Cloud : : : | ||||
| : : : IAM user. : : : |
get_instance
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| projectId | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| instanceId | string | The instance ID | Yes |
list_databases
Lists all databases for a Cloud SQL instance.
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| instance | string | The instance ID | Yes |
list_instances
Lists all type of Cloud SQL instances for a project.
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : |
wait_for_operation
Parameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project | string | The GCP project | No | |
| : : : ID. This is : : : | ||||
| : : : pre-configured; : : : | ||||
| : : : do not ask for : : : | ||||
| : : : it unless the : : : | ||||
| : : : user explicitly : : : | ||||
| : : : provides a : : : | ||||
| : : : different one. : : : | ||||
| operation | string | The operation | Yes | |
| : : : ID : : : |