Available in VPC
Cloud DB for PostgreSQL is a fully managed cloud database service that allows you to easily build and manage PostgreSQL databases. Cloud DB for PostgreSQL provides CLIs for database management features with the vpostgresql command.
Common Cloud DB for PostgreSQL (VPC) settings
This section covers the command and option formats used across the Cloud DB for PostgreSQL (VPC) CLI.
Syntax
Run vpostgresql using the following syntax.
./ncloud vpostgresql <subcommand> [options]
Options
The following options are available across all vpostgresql subcommands:
| Options | Type | Required | Description |
|---|---|---|---|
--regionCode |
String | Optional | Region code
|
--output |
String | Optional | Format of the response result
|
Cloud DB for PostgreSQL (VPC) commands
The following subcommands are available under vpostgresql.
DB Server
The following describes the DB server-related commands:
| Commands | Description |
|---|---|
| createCloudPostgresqlInstance | Create a Cloud DB for PostgreSQL instance. |
| getCloudPostgresqlInstanceList | Get Cloud DB for PostgreSQL instance list. |
| getCloudPostgresqlInstanceDetail | Get Cloud DB for PostgreSQL instance details. |
| createCloudPostgresqlReadReplicaInstance | Add a read replica server instance to a Cloud DB for PostgreSQL instance. |
| rebootCloudPostgresqlServerInstance | Restart a Cloud DB for PostgreSQL server instance. |
| deleteCloudPostgresqlReadReplicaInstance | Delete a read replica server instance from a Cloud DB for PostgreSQL instance. |
| deleteCloudPostgresqlInstance | Delete a Cloud DB for PostgreSQL instance. |
Database
The following describes the database-related commands:
| Commands | Description |
|---|---|
| addCloudPostgresqlDatabaseList | Add a database in a Cloud DB for PostgreSQL instance. |
| getCloudPostgresqlDatabaseList | Get the database list for a Cloud DB for PostgreSQL instance. |
| deleteCloudPostgresqlDatabaseList | Delete a database from a Cloud DB for PostgreSQL instance. |
DB User
The following describes the DB user-related commands:
| Commands | Description |
|---|---|
| addCloudPostgresqlUserList | Add a user to a Cloud DB for PostgreSQL instance. |
| getCloudPostgresqlUserList | Get the user list for a Cloud DB for PostgreSQL instance. |
| changeCloudPostgresqlUserList | Edit user information for a Cloud DB for PostgreSQL instance. |
| deleteCloudPostgresqlUserList | Delete a user from a Cloud DB for PostgreSQL instance. |
Backup
The following describes the backup-related commands:
| Commands | Description |
|---|---|
| getCloudPostgresqlBackupList | Get the Cloud DB for PostgreSQL instance backup list. |
| getCloudPostgresqlBackupDetailList | Get the list of Cloud DB for PostgreSQL instance backup details. |
| exportBackupToObjectStorage | Send Cloud DB for PostgreSQL instance backup files to Object Storage. |
DB Server Log
The following describes the DB server logs-related commands:
| Commands | Description |
|---|---|
| getDbServerLogList | Get the DB server log list of a Cloud DB for PostgreSQL instance. |
| exportDbServerLogToObjectStorage | Send DB server log files in a Cloud DB for PostgreSQL instance to Object Storage. |
Common
Use the following common lookup commands when creating resources:
| Commands | Description |
|---|---|
| getCloudPostgresqlImageProductList | Get the Cloud DB for PostgreSQL image product list. |
| getCloudPostgresqlProductList | Get the Cloud DB for PostgreSQL server product list. |
| getCloudPostgresqlTargetVpcList | Get VPC list. |
| getCloudPostgresqlTargetSubnetList | Get subnet list. |
| getCloudPostgresqlBucketList | Get Object Storage bucket list. |
Cloud DB for PostgreSQL (VPC) related resources
These resources provide additional context and support for the Cloud DB for PostgreSQL (VPC) CLI.
- Cloud DB for PostgreSQL (VPC) CLI guides
- CLI download: Learn how to download and install the Ncloud CLI.
- Authenticate CLI: How to set an API authentication key and manage profiles
- CLI usage: Review the Ncloud CLI command structure, option syntax, and output formats.
- Cloud DB for PostgreSQL (VPC) CLI service guides
- Cloud DB for PostgreSQL user guide: How to use Cloud DB for PostgreSQL in the NAVER Cloud Platform console
- Cloud DB for PostgreSQL API guide: Learn how to call Cloud DB for PostgreSQL APIs.
- Cloud DB for PostgreSQL user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Contact Support: Get help if you can't find what you need in the CLI guide.