Cmdlets for IBM Cloud SQL Query

Build 20.0.7654

Connecting to IBM Cloud

To connect with IBM Cloud, you will need the ApiKey. You may also optionally set the Region if all your buckets belong to the same region.

When you connect, the cmdlet completes the OAuth process.

After you have created an account in IBM Cloud you should follow the procedure below to retrieve the connection properties:

API Key

To obtain the ApiKey, take the following steps:

  1. Log in to your IBM Cloud account.
  2. Navigate to Platform API Keys page.
  3. On the middle right corner click "Create an IBM Cloud API Key" in order to create a new API Key.
  4. In the pop-up window, specify the API Key name and click "Create". Save the ApiKey somewhere as you can never access it again from the dashboard.

Cloud Object Storage CRN and SQL Query CRN

In order to connect, an CloudObjectStorageCRN and a SqlQueryCRN are required. These values will attempt to be determined automatically. If this fails or you have multiple SQL Query services, available, it is recommended to set these connection properties. To find the appropriate values, you can:

  • Use the Services view. This will list your IBM Cloud services along with the CRN for each.
  • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, under Services, find your SQL Query service and select it. The CRN will be displayed. Under Storage, select your Cloud Object Storage resource to get its CRN.
  • Navigate to SQL Query page, choose a name for your instance and click Create. You will be redirected to the instance of SQL Query you just created.

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, you can follow the procedure below to install an instance of SQL Query in your account:

  1. Log in to your IBM Cloud account.
  2. Navigate to the Cloud Object Storage page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

Register a New Instance of SQL Query

If you do not already have SQL Query in your IBM Cloud account, you can follow the procedure below to install an instance of SQL Query in your account:

  1. Log in to your IBM Cloud account.
  2. Navigate to SQL Query page, choose a name for your instance and click Create. You will be redirected to the instance of SQL Query you just created.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654