Categorygithub.com/alessiosavi/GoCloudant
modulepackage
0.0.2
Repository: https://github.com/alessiosavi/gocloudant.git
Documentation: pkg.go.dev

# README

GoCloudant

Codacy Badge An HTTP client for manage Cloudant DB among IBM Cloud

# Functions

DeleteDocument is delegated to retrieve a specific document by the related `_id` https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-documents#delete-a-document token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance databaseName: DB that we want to retrieve the information _id: Key for retrieve the document.
GetAllDBs is delegated to fetch and retrieve all DB(s) name from the Cloudant instance https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-databases#get-a-list-of-all-databases-in-the-account token: bearer auth header retrieved from RetrieveToken() host: URL related to the DB instance.
GetAllDocuments is delegated to retrieve all documents associated to the given DB https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-databases#get-documents token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance dbName: DB that we want to retrieve the information.
GetDBDetails is delegated to retrieve the information related to the given DB https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-databases#getting-database-details token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance dbName: DB that we want to retrieve the information.
GetDocument is delegated to retrieve a specific document by the related mandatory `_id` https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-documents#read-document token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance databaseName: DB that we want to retrieve the information _id: Key for retrieve the document.
InsertBulkDocument is delegated to insert a list of document.
InsertDocument is delegated to insert a new document into the given DB https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-documents#create-document token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance databaseName: DB that we want to retrieve the information json: document to insert.
RemoveDB is delegated to delete the given DB https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-databases#deleting-a-database token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance dbName: DB that we want to retrieve the information.
UpdateDocument is delegated to update a specific document by the related mandatory '_id' parameter https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-documents#update token: bearer auth header retrieved from RetrieveToken() url: URL related to the DB instance databaseName: DB that we want to retrieve the information _id: Key for retrieve the document.

# Structs

Auth is delegated to store the necessary token for authenticate to the service Cloudant HTTP call can be made using one of authentication credential.
Conf is delegated to save the information related to the Cloudant account.