Skip to content
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.

Sign up for GitHub

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

Adds example for database configuration #1617

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Adds example for database configuration #1617

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
567edea
Update databases.go
dbrian57 Nov 21, 2024
e5e4f59
Merge branch 'main' into docs-dbaas-config-example
andrewsomething Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions commands/databases.go
View file
Open in desktop
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
Loading