Skip to content

Commit

Permalink
document that enable_functions is support on update for MySQL databas…
Browse files Browse the repository at this point in the history
…es (#2420)

* update RDS broker to document that enable_functions is support on update for MySQL databases

* update lycheeignore
  • Loading branch information
markdboyd authored Oct 2, 2023
1 parent eaf9b0d commit e84f4a5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
1 change: 1 addition & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ https://www.congress.gov/bill/.*
https://www.pivotaltracker.com/story/show/.*
otherapp.hostname.gov
anotherapp.hostname.com
https://github.com/cloud-gov/internal-docs/.*

# URLs with no known replacements
https://fugacious.18f.gov/
Expand Down
12 changes: 10 additions & 2 deletions _docs/services/relational-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ There are several optional parameters that you can specify when creating a new i
Name | Description | Default Value |
--- | --- | --- |
`storage` | Number of GB available to the database instance | 10 |
`enable_functions` | Boolean to enable functions on supported databases | false |
`enable_functions` | Boolean to enable functions, procedures, and triggers on MySQL databases | false |
`version` | Specifies a supported major version in RDS (must be in quotes) | PostgreSQL: `15`, MySQL `8.0` |
`backup_retention_period` | Specifies a number of days to retain daily snapshots. | 14 |
`binary_log_format` | Specifies the format for [MySQL binary logging](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQL.BinaryFormat.html). **Only supported for MySQL database plans**. Valid options: `ROW`, `STATEMENT`, `MIXED`. | --- |
Expand Down Expand Up @@ -145,7 +145,7 @@ cf create-service aws-rds \
-c '{"storage": 50}'
```

To enable functions in MySQL instances:
To enable functions, triggers, and procedures in MySQL instances:

```sh
cf create-service aws-rds \
Expand Down Expand Up @@ -251,6 +251,7 @@ Name | Description |
`backup_retention_period` | Specifies a number of days to retain daily snapshots. |
`binary_log_format` | Specifies the format for [MySQL binary logging](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQL.BinaryFormat.html). **Only supported for MySQL database plans**. Valid options: `ROW`, `STATEMENT`, `MIXED`. |
`enable_pg_cron` | Boolean to enable [`pg_cron` extension on PostgreSQL databases](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html) (requires PostgreSQL 12.5 and above) | false |
`enable_functions` | Boolean to enable functions, procedures, and triggers on MySQL databases | false |

#### Examples of optional parameters

Expand All @@ -262,6 +263,13 @@ cf update-service ${SERVICE_NAME} -c '{"storage": 50}'

Note that you can only update to a larger size. If you want to downgrade to a lesser size, please email [support][support] for assistance.

To enable functions, triggers, and procedures for a MySQL instance:

```sh
cf update-service ${SERVICE_NAME} \
-c '{"enable_functions": true}'
```

To update the binary log format for a MySQL instance:

```sh
Expand Down

0 comments on commit e84f4a5

Please sign in to comment.