Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.87 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.87 KB
Raw

Java Cloudant API Example

Cloudant in BlueMix

This repository is an example Cloudant API enabled application that can be deployed into Bluemix with only a couple clicks. Try it out for yourself right now by clicking:

Deploy to Bluemix

How does this work?

When you click the button, you are taken to Bluemix where you get a pick a name for your application at which point the platform takes over, grabs the code from this repository and gets it deployed.

It will automatically create an instance of the Cloudant service, call it sample-cloudantNoSQLDB and bind it to your app. This is where your app will store its data. If you deploy multiple instances of app from this repository, they will share the same Cloudant instance.

Create, Read, Update, Delete (CRUD)

This repository includes examples on the CRUD operations as APIs. It support GET request. You should be able to create database, create documents, list all documents, read single document, update single document, delete single document, and delete using the APIs.

If you do clone this repository, make sure you update this README.md file to point the Deploy to Bluemix button at your repository.

If you want to change the name of the Cloudant instance that gets created, the memory allocated to the application or other deploy-time options, have a look in manifest.yml and .bluemix/pipeline.yml.

The method used in .bluemix/pipeline.yml will create an actual pipeline in DevOps. Where else the method used in the manifest.yml is a previous way to create a service.

Running locally

If you want to run the app locally, open credential.properties and enter username and password for Cloudant service

Privacy Notice

This package is configured to track deployments to IBM Bluemix and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:

  • Java repository URL
  • Application Name (application_name)
  • Space ID (space_id)
  • Application Version (application_version)
  • Application URIs (application_uris)
  • Labels of bound services
  • Number of instances for each bound service and associated plan information

This data is collected from the Meta-INF --> package.json file in this application and the VCAP_APPLICATION and VCAP_SERVICES environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of this applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.