Skip to content

Commit

Permalink
Update databases.go (#1617)
Browse files Browse the repository at this point in the history
Adds example for database configuration and adds link to API docs for fields.

Co-authored-by: Andrew Starr-Bochicchio <[email protected]>
  • Loading branch information
dbrian57 and andrewsomething authored Nov 21, 2024
1 parent fdec25b commit 8f46e97
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions commands/databases.go
Original file line number Diff line number Diff line change
Expand Up @@ -2483,6 +2483,8 @@ func databaseConfiguration() *Command {
updateConfigurationLongDesc := `Updates the specified database cluster's advanced configuration. Using this command, you can update various settings like backup times, temporary file limits, and session timeouts. Available settings vary by database engine.
This command functions as a PATCH request, meaning that only the specified fields are updated. If a field is not specified, it will not be changed. The settings are passed using the ` + "`" + `--config-json` + "`" + ` flag, which takes a JSON object as its value.
For a full list of available fields, see the API documentation: https://docs.digitalocean.com/reference/api/api-reference/#operation/databases_patch_config
`

getDatabaseCfgCommand := CmdBuilder(
Expand Down Expand Up @@ -2535,6 +2537,7 @@ This command functions as a PATCH request, meaning that only the specified field
"the desired configuration of the database cluster you want to update",
requiredOpt(),
)
updateDatabaseCfgCommand.Example = `The following command updates a MySQL database's time zone: doctl databases configuration update f81d4fae-7dec-11d0-a765-00a0c91e6bf6 --engine mysql --config-json '{"default_time_zone":"Africa/Maputo"}'`

return cmd
}
Expand Down

0 comments on commit 8f46e97

Please sign in to comment.