From 7e3e0bdc1da229babd0d9f4090245cdbad4693d4 Mon Sep 17 00:00:00 2001 From: Kicka5h <35403561+kicka5h@users.noreply.github.com> Date: Thu, 12 Oct 2023 04:32:49 -0700 Subject: [PATCH] doctl-databases-*: add page (#10882) * doctl-databases-*: add page --------- Co-authored-by: Reinhart Previano Koentjoro Co-authored-by: Juri Dispan Co-authored-by: K.B.Dharun Krishna --- pages/common/doctl-databases-db.md | 24 ++++++++++++++ pages/common/doctl-databases-firewalls.md | 20 ++++++++++++ .../doctl-databases-maintenance-window.md | 16 ++++++++++ pages/common/doctl-databases-options.md | 24 ++++++++++++++ pages/common/doctl-databases-pool.md | 24 ++++++++++++++ pages/common/doctl-databases-replica.md | 24 ++++++++++++++ pages/common/doctl-databases-sql-mode.md | 16 ++++++++++ pages/common/doctl-databases-user.md | 32 +++++++++++++++++++ pages/common/doctl-databases.md | 24 ++++++++++++++ 9 files changed, 204 insertions(+) create mode 100644 pages/common/doctl-databases-db.md create mode 100644 pages/common/doctl-databases-firewalls.md create mode 100644 pages/common/doctl-databases-maintenance-window.md create mode 100644 pages/common/doctl-databases-options.md create mode 100644 pages/common/doctl-databases-pool.md create mode 100644 pages/common/doctl-databases-replica.md create mode 100644 pages/common/doctl-databases-sql-mode.md create mode 100644 pages/common/doctl-databases-user.md create mode 100644 pages/common/doctl-databases.md diff --git a/pages/common/doctl-databases-db.md b/pages/common/doctl-databases-db.md new file mode 100644 index 000000000..c0332654e --- /dev/null +++ b/pages/common/doctl-databases-db.md @@ -0,0 +1,24 @@ +# doctl databases db + +> Manage specific databases that are served by a database cluster. +> More information: . + +- Run a `doctl databases db` command with an access token: + +`doctl databases db {{command}} --access-token {{access_token}}` + +- Retrieve the name of the given database hosted in the given database cluster: + +`doctl databases db get {{database_id}} {{database_name}}` + +- List existing databases hosted within a given database cluster: + +`doctl databases db list {{database_id}}` + +- Create a database with the given name in the given database cluster: + +`doctl databases db create {{database_id}} {{database_name}}` + +- Delete the database with the given name in the given database cluster: + +`doctl databases db delete {{database_id}} {{database_name}}` diff --git a/pages/common/doctl-databases-firewalls.md b/pages/common/doctl-databases-firewalls.md new file mode 100644 index 000000000..f13aef783 --- /dev/null +++ b/pages/common/doctl-databases-firewalls.md @@ -0,0 +1,20 @@ +# doctl databases firewalls + +> Manage firewalls for database clusters. +> More information: . + +- Run a `doctl databases firewalls` command with an access token: + +`doctl databases firewalls {{command}} --access-token {{access_token}}` + +- Retrieve a list of firewall rules for a given database: + +`doctl databases firewalls list` + +- Add a database firewall rule to a given database: + +`doctl databases firewalls append {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}` + +- Remove a firewall rule for a given database: + +`doctl databases firewalls remove {{database_id}} {{rule_uuid}}` diff --git a/pages/common/doctl-databases-maintenance-window.md b/pages/common/doctl-databases-maintenance-window.md new file mode 100644 index 000000000..1fd1d9829 --- /dev/null +++ b/pages/common/doctl-databases-maintenance-window.md @@ -0,0 +1,16 @@ +# doctl databases maintenance-window + +> Schedule, and check the schedule of, maintenance windows for your databases. +> More information: . + +- Run a `doctl databases maintenance-window` command with an access token: + +`doctl databases maintenance-window {{command}} --access-token {{access_token}}` + +- Retrieve details about a database cluster's maintenance windows: + +`doctl databases maintenance-window get {{database_id}}` + +- Update the maintenance window for a database cluster: + +`doctl databases maintenance-window update {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}` diff --git a/pages/common/doctl-databases-options.md b/pages/common/doctl-databases-options.md new file mode 100644 index 000000000..4873f4f99 --- /dev/null +++ b/pages/common/doctl-databases-options.md @@ -0,0 +1,24 @@ +# doctl databases options + +> Enable the navigation of available options under each database engine. +> More information: . + +- Run a `doctl databases options` command with an access token: + +`doctl databases options {{command}} --access-token {{access_token}}` + +- Retrieve a list of the available database engines: + +`doctl databases options engines` + +- Retrieve a list of the available regions for a given database engine: + +`doctl databases options regions --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available slugs for a given database engine: + +`doctl databases options slugs --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available versions for a given database engine: + +`doctl databases options versions --engine {{pg|mysql|redis|mongodb}}` diff --git a/pages/common/doctl-databases-pool.md b/pages/common/doctl-databases-pool.md new file mode 100644 index 000000000..232b8eb9d --- /dev/null +++ b/pages/common/doctl-databases-pool.md @@ -0,0 +1,24 @@ +# doctl databases pool + +> Manage connection pools for your database cluster. +> More information: . + +- Run a `doctl databases pool` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a database connection pool: + +`doctl databases pool get {{database_id}} {{pool_name}}` + +- List connection pools for a database cluster: + +`doctl databases pool list {{database_id}}` + +- Create a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}} --db {{new_pool_name}} --size {{pool_size}}` + +- Delete a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}}` diff --git a/pages/common/doctl-databases-replica.md b/pages/common/doctl-databases-replica.md new file mode 100644 index 000000000..b5e927f6e --- /dev/null +++ b/pages/common/doctl-databases-replica.md @@ -0,0 +1,24 @@ +# doctl databases replica + +> Manage read-only replicas associated with a database cluster. +> More information: . + +- Run a `doctl databases replica` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a read-only database replica: + +`doctl databases replica get {{database_id}} {{replica_name}}` + +- Retrieve list of read-only database replicas: + +`doctl databases replica list {{database_id}}` + +- Create a read-only database replica: + +`doctl databases replica create {{database_id}} {{replica_name}}` + +- Delete a read-only database replica: + +`doctl databases replica delete {{database_id}} {{replica_name}}` diff --git a/pages/common/doctl-databases-sql-mode.md b/pages/common/doctl-databases-sql-mode.md new file mode 100644 index 000000000..1a81ecedf --- /dev/null +++ b/pages/common/doctl-databases-sql-mode.md @@ -0,0 +1,16 @@ +# doctl databases sql-mode + +> View and configure a MySQL database cluster’s global SQL modes. +> More information: . + +- Run a `doctl databases sql-mode` command with an access token: + +`doctl databases sql-mode {{command}} --access-token {{access_token}}` + +- Get a MySQL database cluster's SQL modes: + +`doctl databases sql-mode get {{database_id}}` + +- Overwrite a MySQL database cluster's SQL modes to the specified modes: + +`doctl databases sql-mode set {{database_id}} {{sql_mode_1 sql_mode_2 ...}}` diff --git a/pages/common/doctl-databases-user.md b/pages/common/doctl-databases-user.md new file mode 100644 index 000000000..ce6531ab0 --- /dev/null +++ b/pages/common/doctl-databases-user.md @@ -0,0 +1,32 @@ +# doctl databases user + +> View details for, and create, database users. +> More information: . + +- Run a `doctl databases user` command with an access token: + +`doctl databases user {{command}} --access-token {{access_token}}` + +- Retrieve details about a database user: + +`doctl databases user get {{database_id}} {{user_name}}` + +- Retrieve a list of database users for a given database: + +`doctl databases user list {{database_id}}` + +- Reset the auth password for a given user: + +`doctl databases user reset {{database id}} {{user_name}}` + +- Reset the MySQL auth plugn for a given user: + +`doctl databases user reset {{database_id}} {{user_name}} {{caching_sha2_password|mysql_native_password}}` + +- Create a user in the given database with a given username: + +`doctl databases user create {{database_id}} {{user_name}}` + +- Delete a user from the given database with the given username: + +`doctl databases user delete {{database_id}} {{user_name}}` diff --git a/pages/common/doctl-databases.md b/pages/common/doctl-databases.md new file mode 100644 index 000000000..5f7d5ef6a --- /dev/null +++ b/pages/common/doctl-databases.md @@ -0,0 +1,24 @@ +# doctl databases + +> Manage your MySQL, Redis, PostgreSQL, and MongoDB database services. +> More information: . + +- Run a `doctl databases` command with an access token: + +`doctl databases {{command}} --access-token {{access_token}}` + +- Get details for a database cluster: + +`doctl databases get` + +- List your database clusters: + +`doctl databases list` + +- Create a database cluster: + +`doctl databases create {{database_name}}` + +- Delete a cluster: + +`doctl databases delete {{database_id}}`