Go client library to interact with the various IBM Cloud Cloud Databases APIs.
- Overview
- Prerequisites
- Installation
- Using the SDK
- Running the Integration Tests
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
The IBM Cloud Cloud Databases Go SDK allows developers to programmatically interact with the following IBM Cloud services:
Service Name | Package name |
---|---|
Cloud Databases | clouddatabasesv5 |
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- Go version 1.18 or above.
The current version of this SDK: 0.7.0
If your application uses Go modules for dependency management (recommended), just add an import for each service
that you will use in your application.
Here is an example:
import (
"github.com/IBM/cloud-databases-go-sdk/clouddatabasesv5"
)
Next, run go build
or go mod tidy
to download and install the new dependencies and update your application's
go.mod
file.
In the example above, the clouddatabasesv5
part of the import path is the package name
associated with the IBM Cloud Databases service.
See the service table above to find the approprate package name for the services used by your application.
Alternatively, you can use the go get
command to download and install the appropriate packages needed by your application:
go get -u github.com/IBM/cloud-databases-go-sdk/clouddatabasesv5
Be sure to use the appropriate package name from the service table above for the services used by your application.
For general SDK usage information, please see this link
To run the integration tests run the make test-int
command in the root directory. If you wish to run all the integration tests
you can configure your cloud_databases.env
file as seen below:
CLOUD_DATABASES_URL=<service base url> (e.g. https://api.eu-gb.databases.cloud.ibm.com/v5/ibm)
CLOUD_DATABASES_AUTH_TYPE=iam
CLOUD_DATABASES_APIKEY=<IAM apikey>
CLOUD_DATABASES_AUTH_URL=<IAM token service base URL - omit this if using the production environment>
CLOUD_DATABASES_DEPLOYMENT_ID=<ID of an example deployment>
CLOUD_DATABASES_REPLICA_ID=<ID of an example replica>
Make sure your env file is in the root directory.
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.
This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.