Databases - IBM Cloud

Help

Choose your CLI environment

Local terminal

IBM Cloud shell

Get started with CLI on your local terminal

You will need some installations so you can access all the features of IBM Cloud Databases

Prerequisite

IBM Cloud CLI installed and initialized

Make sure that you downloaded, installed, and initialized the IBM Cloud CLI.

Install the IBM Cloud Databases plug-in

The Cloud Databases CLI plug-in offers extra methods of accessing the capabilities of the Cloud Databases services. The plug-in enables you to manage your deployment from the command line, but does not allow you to interact with the underlying database.

$ ibmcloud plugin install cloud-databases

Optional

Verify the plug-in is installed and see available commands

Verify the plug-in is installed:

$ ibmcloud plugin list

This is an example output you should expect for successful installation:

Plugin Name
cloud-databases/cdb
Version
1.36.0
Status

Check out the complete list of CLI commands:

$ ibmcloud cdb help

Need help?Learn more in docs

Install external database management plug-in

To enable full management and use of your underlying database via the CLI, you need to install an external database management plug-in. If the external plugin is needed for connection via the Cloud Databases CLI plugin then it will be labelled as required.

External plug-in:psql(required)

Provision a database in just a few simple steps

Make sure you have the IBM Cloud CLI installed on your local terminal

Log in to IBM Cloud

$ ibmcloud login

Use single sign-on for a quicker experience or

Choose resource group

Target which resource group you would like to deploy to:

$ ibmcloud target -g <RESOURCE_GROUP>

Example:

$ ibmcloud target -g default

Provision the Databases instance

Create a Databases service instance within IBM Cloud:

$ ibmcloud resource service-instance-create <INSTANCE_NAME> databases-for-postgresql <SERVICE_PLAN_NAME> <LOCATION> <PARAMETERS> <SERVICE_ENDPOINTS>

Detailed explanation of parameters

Example:

$ ibmcloud resource service-instance-create MyDatabase databases-for-postgresql standard us-south -p '{"members_host_flavor":"multitenant", "members_memory_allocation_mb": "8192"}' --service-endpoints="public"

Note

Instance Name will be used while establishing database connection, so make sure you remember it.

Optional

Check provisioning status

It might take some time to provision your instance, you can check its status meanwhile:

$ ibmcloud resource service-instance <INSTANCE_NAME>

Example:

$ ibmcloud resource service-instance MyDatabase

Need help?Learn more in docs

Connect to your instance easily

Make sure you have an active instance in your account

Set the admin password

Set the admin password for your database instance:

$ ibmcloud cdb deployment-user-password <INSTANCE_NAME> admin <PASSWORD>

An admin user is created automatically for your instance. The password must be at least 15 characters long and include a number (allowed characters A-Z, a-z, 0-9, -, _).

Example:

$ ibmcloud cdb deployment-user-password MyDatabase admin abcd12345678

Note

Make sure you remember the password, you'll need it for connection

Connect to the database instance

After running this command you may be prompted for your Database Password:

$ ibmcloud cdb cxn <INSTANCE_NAME> --s

Example:

$ ibmcloud cdb cxn MyDatabase --s

Need help?Learn more in docs

IBM Cloud

Help

IBM Cloud Databases CLI

Get started with CLI on your local terminal

IBM Cloud CLI installed and initialized

Install the IBM Cloud Databases plug-in

Verify the plug-in is installed and see available commands

Verify the plug-in is installed:

This is an example output you should expect for successful installation:

Check out the complete list of CLI commands:

Install external database management plug-in

Provision a database in just a few simple steps

Log in to IBM Cloud

Choose resource group

Provision the Databases instance

Check provisioning status

Connect to your instance easily

Set the admin password

Connect to the database instance

What do you want to do next?

Explore the CLI reference

Database specific CLI commands