Sunbelt Computer Software

Examples for java

getServerInformation

GET /

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ServerInformation;
// section: code
Cloudant service = Cloudant.newInstance();

ServerInformation response =
    service.getServerInformation().execute().getResult();

System.out.println(response);

getActiveTasks

GET /_active_tasks

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ActiveTask;
// section: code
Cloudant service = Cloudant.newInstance();

List<ActiveTask> response =
    service.getActiveTasks().execute().getResult();

System.out.println(response);

getAllDbs

GET /_all_dbs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;

import java.util.List;
// section: code
Cloudant service = Cloudant.newInstance();

List<String> response =
    service.getAllDbs().execute().getResult();

System.out.println(response);

postApiKeys

POST /_api/v2/api_keys

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ApiKeysResult;
// section: code
Cloudant service = Cloudant.newInstance();

ApiKeysResult response =
    service.postApiKeys().execute().getResult();

System.out.println(response);

putCloudantSecurity

PUT /_api/v2/db/{db}/_security

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PutCloudantSecurityConfigurationOptions;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, List<String>> securityObject = new HashMap<>();
securityObject.put("nobody", Arrays.asList("_reader"));

PutCloudantSecurityConfigurationOptions securityOptions =
    new PutCloudantSecurityConfigurationOptions.Builder()
        .db("products")
        .cloudant(securityObject)
        .build();

Ok response =
    service.putCloudantSecurityConfiguration(securityOptions)
        .execute()
        .getResult();

System.out.println(response);
// section: markdown
// The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but didn't identify itself, the task can continue only if the `nobody` user has the role `_reader`.
// section: markdown
// If instead of using Cloudant's security model for managing permissions you opt to use the Apache CouchDB `_users` database (that is using legacy credentials _and_ the `couchdb_auth_only:true` option) then be aware that the user must already exist in `_users` database before adding permissions. For information on the `_users` database, see <a href="https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-work-with-your-account#using-the-users-database-with-cloudant-nosql-db" target="_blank">Using the `_users` database with Cloudant</a>.

getActivityTrackerEvents

GET /_api/v2/user/activity_tracker/events

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ActivityTrackerEvents;
// section: code
Cloudant service = Cloudant.newInstance();

ActivityTrackerEvents response =
    service.getActivityTrackerEvents().execute().getResult();

System.out.println(response);

postActivityTrackerEvents

POST /_api/v2/user/activity_tracker/events

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ActivityTrackerEvents;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PostActivityTrackerEventsOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PostActivityTrackerEventsOptions options =
    new PostActivityTrackerEventsOptions.Builder()
        .addTypes(ActivityTrackerEvents.Types.MANAGEMENT)
        .addTypes(ActivityTrackerEvents.Types.DATA)
        .build();

Ok response =
    service.postActivityTrackerEvents(options).execute().getResult();

System.out.println(response);

getCapacityThroughputInformation

GET /_api/v2/user/capacity/throughput

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.CapacityThroughputInformation;
// section: code
Cloudant service = Cloudant.newInstance();

CapacityThroughputInformation response =
    service.getCapacityThroughputInformation().execute().getResult();

System.out.println(response);

putCapacityThroughputConfiguration

PUT /_api/v2/user/capacity/throughput

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.CapacityThroughputInformation;
import com.ibm.cloud.cloudant.v1.model.PutCapacityThroughputConfigurationOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PutCapacityThroughputConfigurationOptions options =
    new PutCapacityThroughputConfigurationOptions.Builder()
        .blocks(1)
        .build();

CapacityThroughputInformation response =
    service.putCapacityThroughputConfiguration(options).execute().getResult();

System.out.println(response);

getCorsInformation

GET /_api/v2/user/config/cors

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.CorsInformation;
// section: code
Cloudant service = Cloudant.newInstance();

CorsInformation response =
    service.getCorsInformation().execute().getResult();

System.out.println(response);

putCorsConfiguration

PUT /_api/v2/user/config/cors

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PutCorsConfigurationOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PutCorsConfigurationOptions configurationOptions =
    new PutCorsConfigurationOptions.Builder()
        .addOrigins("https://example.com")
        .enableCors(true)
        .build();

Ok response =
    service.putCorsConfiguration(configurationOptions).execute()
        .getResult();

System.out.println(response);

getCurrentThroughputInformation

GET /_api/v2/user/current/throughput

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.CurrentThroughputInformation;
// section: code
Cloudant service = Cloudant.newInstance();

CurrentThroughputInformation response =
    service.getCurrentThroughputInformation().execute().getResult();

System.out.println(response);

getDbUpdates

GET /_db_updates

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DbUpdates;
import com.ibm.cloud.cloudant.v1.model.GetDbUpdatesOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetDbUpdatesOptions dbUpdatesOptions = new GetDbUpdatesOptions.Builder()
    .feed("normal")
    .since("now")
    .build();

DbUpdates response =
    service.getDbUpdates(dbUpdatesOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This request requires `server_admin` access.

postDbsInfo

POST /_dbs_info

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DbsInfoResult;
import com.ibm.cloud.cloudant.v1.model.PostDbsInfoOptions;

import java.util.Arrays;
import java.util.List;
// section: code
Cloudant service = Cloudant.newInstance();

PostDbsInfoOptions dbsInfoOptions =
    new PostDbsInfoOptions.Builder()
        .keys(Arrays.asList("products", "users", "orders"))
        .build();

List<DbsInfoResult> response =
    service.postDbsInfo(dbsInfoOptions).execute()
        .getResult();

System.out.println(response);

getMembershipInformation

GET /_membership

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.MembershipInformation;
// section: code
Cloudant service = Cloudant.newInstance();

MembershipInformation response =
    service.getMembershipInformation().execute().getResult();

System.out.println(response);

deleteReplicationDocument

DELETE /_replicator/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteReplicationDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteReplicationDocumentOptions replicationDocOptions =
    new DeleteReplicationDocumentOptions.Builder()
        .docId("repldoc-example")
        .rev("1-00000000000000000000000000000000")
        .build();

DocumentResult response =
    service.deleteReplicationDocument(replicationDocOptions).execute()
        .getResult();

System.out.println(response);

getReplicationDocument

GET /_replicator/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetReplicationDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.ReplicationDocument;
// section: code
Cloudant service = Cloudant.newInstance();

GetReplicationDocumentOptions replicationDocOptions =
    new GetReplicationDocumentOptions.Builder()
        .docId("repldoc-example")
        .build();

ReplicationDocument response =
    service.getReplicationDocument(replicationDocOptions).execute()
        .getResult();

System.out.println(response);

headReplicationDocument

HEAD /_replicator/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.sdk.core.http.Headers;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadReplicationDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

HeadReplicationDocumentOptions replicationDocOptions =
    new HeadReplicationDocumentOptions.Builder()
        .docId("repldoc-example")
        .build();

int statusCode =
    service.headReplicationDocument(replicationDocOptions).execute().getStatusCode();

Headers headers =
    service.headReplicationDocument(replicationDocOptions).execute().getHeaders();

System.out.println(statusCode);
System.out.println(headers.values("ETag"));

putReplicationDocument

PUT /_replicator/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PutReplicationDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.ReplicationDatabase;
import com.ibm.cloud.cloudant.v1.model.ReplicationDatabaseAuth;
import com.ibm.cloud.cloudant.v1.model.ReplicationDatabaseAuthIam;
import com.ibm.cloud.cloudant.v1.model.ReplicationDocument;
// section: code
Cloudant service = Cloudant.newInstance();

ReplicationDatabase sourceDb = new ReplicationDatabase.Builder()
    .url("https://~replace-with-source-host~.cloudantnosqldb.appdomain.cloud/animaldb")
    .build();

ReplicationDatabaseAuthIam targetAuthIam =
    new ReplicationDatabaseAuthIam.Builder()
        .apiKey("a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3") //use your own IAM API key
        .build();

ReplicationDatabaseAuth targetAuth = new ReplicationDatabaseAuth.Builder()
    .iam(targetAuthIam)
    .build();

ReplicationDatabase targetDb = new ReplicationDatabase.Builder()
    .auth(targetAuth)
    .url("https://~replace-with-target-host~.cloudantnosqldb.appdomain.cloud/animaldb-target")
    .build();

ReplicationDocument replDocument = new ReplicationDocument();
replDocument.setCreateTarget(true);
replDocument.setSource(sourceDb);
replDocument.setTarget(targetDb);

PutReplicationDocumentOptions replicationDocumentOptions =
    new PutReplicationDocumentOptions.Builder()
        .docId("repldoc-example")
        .replicationDocument(replDocument)
        .build();

DocumentResult response =
    service.putReplicationDocument(replicationDocumentOptions).execute()
        .getResult();

System.out.println(response);

getSchedulerDocs

GET /_scheduler/docs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSchedulerDocsOptions;
import com.ibm.cloud.cloudant.v1.model.SchedulerDocsResult;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

GetSchedulerDocsOptions schedulerDocsOptions = new GetSchedulerDocsOptions.Builder()
    .limit(100)
    .states(Arrays.asList("completed"))
    .build();

SchedulerDocsResult response =
    service.getSchedulerDocs(schedulerDocsOptions).execute()
        .getResult();

System.out.println(response);

getSchedulerDocument

GET /_scheduler/docs/_replicator/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSchedulerDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.SchedulerDocument;
// section: code
Cloudant service = Cloudant.newInstance();

GetSchedulerDocumentOptions schedulerDocumentOptions =
    new GetSchedulerDocumentOptions.Builder()
        .docId("repldoc-example")
        .build();

SchedulerDocument response =
    service.getSchedulerDocument(schedulerDocumentOptions).execute()
        .getResult();

System.out.println(response);

getSchedulerJobs

GET /_scheduler/jobs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSchedulerJobsOptions;
import com.ibm.cloud.cloudant.v1.model.SchedulerJobsResult;
// section: code
Cloudant service = Cloudant.newInstance();

GetSchedulerJobsOptions schedulerJobsOptions =
    new GetSchedulerJobsOptions.Builder()
        .limit(100)
        .build();

SchedulerJobsResult response =
    service.getSchedulerJobs(schedulerJobsOptions).execute()
        .getResult();

System.out.println(response);

getSchedulerJob

GET /_scheduler/jobs/{job_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSchedulerJobOptions;
import com.ibm.cloud.cloudant.v1.model.SchedulerJob;
// section: code
Cloudant service = Cloudant.newInstance();

GetSchedulerJobOptions schedulerJobOptions =
    new GetSchedulerJobOptions.Builder()
        .jobId("7b94915cd8c4a0173c77c55cd0443939+continuous")
        .build();

SchedulerJob response =
    service.getSchedulerJob(schedulerJobOptions).execute()
        .getResult();

System.out.println(response);

headSchedulerJob

HEAD /_scheduler/jobs/{job_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadSchedulerJobOptions;
// section: code
Cloudant service = Cloudant.newInstance();

HeadSchedulerJobOptions schedulerJobOptions =
    new HeadSchedulerJobOptions.Builder()
        .jobId("7b94915cd8c4a0173c77c55cd0443939+continuous")
        .build();

int statusCode =
    service.headSchedulerJob(schedulerJobOptions).execute()
        .getStatusCode();

System.out.println(statusCode);

postSearchAnalyze

POST /_search_analyze

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchAnalyzeOptions;
import com.ibm.cloud.cloudant.v1.model.SearchAnalyzeResult;
// section: code
Cloudant service = Cloudant.newInstance();

PostSearchAnalyzeOptions searchAnalyzerOptions =
    new PostSearchAnalyzeOptions.Builder()
        .analyzer("english")
        .text("running is fun")
        .build();

SearchAnalyzeResult response =
    service.postSearchAnalyze(searchAnalyzerOptions).execute()
        .getResult();

System.out.println(response);

getSessionInformation

GET /_session

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.SessionInformation;
// section: code
Cloudant service = Cloudant.newInstance();

SessionInformation response =
    service.getSessionInformation().execute().getResult();

System.out.println(response);
// section: markdown
// For more details on Session Authentication, see [Authentication.](#authentication)

getUpInformation

GET /_up

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.UpInformation;
// section: code
Cloudant service = Cloudant.newInstance();

UpInformation response =
    service.getUpInformation().execute().getResult();

System.out.println(response);

getUuids

GET /_uuids

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetUuidsOptions;
import com.ibm.cloud.cloudant.v1.model.UuidsResult;
// section: code
Cloudant service = Cloudant.newInstance();

GetUuidsOptions uuidsOptions = new GetUuidsOptions.Builder()
    .count(10)
    .build();

UuidsResult response =
    service.getUuids(uuidsOptions).execute()
        .getResult();

System.out.println(response);

deleteDatabase

DELETE /{db}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteDatabaseOptions;
import com.ibm.cloud.cloudant.v1.model.Ok;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteDatabaseOptions databaseOptions =
    new DeleteDatabaseOptions.Builder()
        .db("products")
        .build();

Ok response =
    service.deleteDatabase(databaseOptions).execute()
        .getResult();

System.out.println(response);

getDatabaseInformation

GET /{db}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DatabaseInformation;
import com.ibm.cloud.cloudant.v1.model.GetDatabaseInformationOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetDatabaseInformationOptions databaseInfoOptions =
    new GetDatabaseInformationOptions.Builder()
        .db("products")
        .build();

DatabaseInformation response =
    service.getDatabaseInformation(databaseInfoOptions).execute()
        .getResult();

System.out.println(response);

headDatabase

HEAD /{db}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadDatabaseOptions;
// section: code
Cloudant service = Cloudant.newInstance();

HeadDatabaseOptions databaseOptions =
    new HeadDatabaseOptions.Builder()
        .db("products")
        .build();

int statusCode =
    service.headDatabase(databaseOptions).execute().getStatusCode();

System.out.println(statusCode);

postDocument

POST /{db}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PostDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

Document productsDocument = new Document();
productsDocument.setId("1000042");
productsDocument.put("type", "product");
productsDocument.put("productId", "1000042");
productsDocument.put("brand", "Salter");
productsDocument.put("name", "Digital Kitchen Scales");
productsDocument.put("description", "Slim Colourful Design Electronic"
    + "Cooking Appliance for Home / Kitchen, Weigh up to 5kg + Aquatronic"
    + "for Liquids ml + fl. oz. 15Yr Guarantee - Green");
productsDocument.put("price", 14.99);
productsDocument.put("image", "assets/img/0gmsnghhew.jpg");

PostDocumentOptions documentOptions =
    new PostDocumentOptions.Builder()
        .db("products")
        .document(productsDocument)
        .build();

DocumentResult response =
    service.postDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

Example request as a stream

// section: code imports
import java.io.FileInputStream;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PostDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

try (FileInputStream productsDocumentStream = new FileInputStream("products_doc.json")) {
    PostDocumentOptions documentOptions =
        new PostDocumentOptions.Builder()
            .db("products")
            .contentType("application/json")
            .body(productsDocumentStream)
            .build();

    DocumentResult response =
        service.postDocument(documentOptions).execute()
            .getResult();

    System.out.println(response);
}

putDatabase

PUT /{db}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PutDatabaseOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PutDatabaseOptions databaseOptions = new PutDatabaseOptions.Builder()
    .db("events")
    .partitioned(true)
    .build();

Ok response =
    service.putDatabase(databaseOptions).execute()
        .getResult();

System.out.println(response);

postAllDocs

POST /{db}/_all_docs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsResult;
import com.ibm.cloud.cloudant.v1.model.PostAllDocsOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PostAllDocsOptions docsOptions =
    new PostAllDocsOptions.Builder()
        .db("orders")
        .includeDocs(true)
        .startKey("abc")
        .limit(10)
        .build();

AllDocsResult response =
    service.postAllDocs(docsOptions).execute().getResult();

System.out.println(response);

Example request as a stream

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostAllDocsOptions;

import java.io.InputStream;
import java.io.File;
import java.nio.file.StandardCopyOption;
// section: code
Cloudant service = Cloudant.newInstance();

PostAllDocsOptions docsOptions =
    new PostAllDocsOptions.Builder()
        .db("orders")
        .includeDocs(true)
        .startKey("abc")
        .limit(10)
        .build();

File file = new File("result.json");

try (InputStream response =
        service.postAllDocsAsStream(docsOptions).execute()
            .getResult()) {
    java.nio.file.Files.copy(
        response,
        file.toPath(),
        StandardCopyOption.REPLACE_EXISTING);
}

postAllDocsQueries

POST /{db}/_all_docs/queries

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsQuery;
import com.ibm.cloud.cloudant.v1.model.AllDocsQueriesResult;
import com.ibm.cloud.cloudant.v1.model.PostAllDocsQueriesOptions;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

AllDocsQuery query1 = new AllDocsQuery.Builder()
    .keys(Arrays.asList("1000042",
        "1000043"))
    .build();

AllDocsQuery query2 = new AllDocsQuery.Builder()
    .limit(3)
    .skip(2)
    .build();

PostAllDocsQueriesOptions queriesOptions =
    new PostAllDocsQueriesOptions.Builder()
        .queries(Arrays.asList(query1, query2))
        .db("products")
        .build();

AllDocsQueriesResult response =
    service.postAllDocsQueries(queriesOptions).execute()
        .getResult();

System.out.println(response);

postBulkDocs

POST /{db}/_bulk_docs

Example request: create documents

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.BulkDocs;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkDocsOptions;

import java.util.Arrays;
import java.util.List;
// section: code
Cloudant service = Cloudant.newInstance();

Document eventDoc1 = new Document();
eventDoc1.setId("ns1HJS13AMkK:0007241142412418284");
eventDoc1.put("type", "event");
eventDoc1.put("userId", "abc123");
eventDoc1.put("eventType", "addedToBasket");
eventDoc1.put("productId", "1000042");
eventDoc1.put("date", "2019-01-28T10:44:22.000Z");

Document eventDoc2 = new Document();
eventDoc2.setId("H8tDIwfadxp9:0007241142412418285");
eventDoc2.put("type", "event");
eventDoc2.put("userId", "abc234");
eventDoc2.put("eventType", "addedToBasket");
eventDoc2.put("productId", "1000050");
eventDoc2.put("date", "2019-01-28T10:44:22.000Z");

BulkDocs bulkDocs = new BulkDocs.Builder()
    .docs(Arrays.asList(eventDoc1, eventDoc2))
    .build();

PostBulkDocsOptions bulkDocsOptions = new PostBulkDocsOptions.Builder()
    .db("events")
    .bulkDocs(bulkDocs)
    .build();

List<DocumentResult> response =
    service.postBulkDocs(bulkDocsOptions).execute()
        .getResult();

System.out.println(response);

Example request: delete documents

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.BulkDocs;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkDocsOptions;

import java.util.Arrays;
import java.util.List;
// section: code
Cloudant service = Cloudant.newInstance();

Document eventDoc1 = new Document();
eventDoc1.setId("ns1HJS13AMkK:0007241142412418284");
eventDoc1.setRev("1-00000000000000000000000000000000");
eventDoc1.setDeleted(true);

Document eventDoc2 = new Document();
eventDoc2.setId("H8tDIwfadxp9:0007241142412418285");
eventDoc1.setRev("1-00000000000000000000000000000000");
eventDoc1.setDeleted(true);

BulkDocs bulkDocs = new BulkDocs.Builder()
    .docs(Arrays.asList(eventDoc1, eventDoc2))
    .build();

PostBulkDocsOptions bulkDocsOptions = new PostBulkDocsOptions.Builder()
    .db("events")
    .bulkDocs(bulkDocs)
    .build();

List<DocumentResult> response =
    service.postBulkDocs(bulkDocsOptions).execute()
        .getResult();

System.out.println(response);

Example request as a stream

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkDocsOptions;

import java.util.List;
import java.io.File;
import java.io.FileInputStream;
// section: code
Cloudant service = Cloudant.newInstance();

File file = new File("upload.json");
FileInputStream inputStream = new FileInputStream(file);

PostBulkDocsOptions bulkDocsOptions = new PostBulkDocsOptions.Builder()
    .db("events")
    .body(inputStream)
    .build();

List<DocumentResult> response =
    service.postBulkDocs(bulkDocsOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// Content of upload.json
// section: code
{
  "docs": [
    {
      "_id": "ns1HJS13AMkK:0007241142412418284",
      "type": "event",
      "userId": "abc123",
      "eventType": "addedToBasket",
      "productId": "1000042",
      "date": "2019-01-28T10:44:22.000Z"
    },
    {
      "_id": "H8tDIwfadxp9:0007241142412418285",
      "type": "event",
      "userId": "abc234",
      "eventType": "addedToBasket",
      "productId": "1000050",
      "date": "2019-01-25T20:00:00.000Z"
    }
  ]
}

postBulkGet

POST /{db}/_bulk_get

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.BulkGetQueryDocument;
import com.ibm.cloud.cloudant.v1.model.BulkGetResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkGetOptions;

import java.util.ArrayList;
import java.util.List;
// section: code
Cloudant service = Cloudant.newInstance();

String docId = "order00067";
List<BulkGetQueryDocument> bulkGetDocs = new ArrayList<>();

bulkGetDocs.add(
    new BulkGetQueryDocument.Builder()
        .id(docId)
        .rev("3-22222222222222222222222222222222")
        .build());
bulkGetDocs.add(
    new BulkGetQueryDocument.Builder()
        .id(docId)
        .rev("4-33333333333333333333333333333333")
        .build());

PostBulkGetOptions bulkGetOptions = new PostBulkGetOptions.Builder()
    .db("orders")
    .docs(bulkGetDocs)
    .build();

BulkGetResult response =
    service.postBulkGet(bulkGetOptions).execute()
        .getResult();

System.out.println(response);

Alternative example request for `open_revs=all`

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.BulkGetQueryDocument;
import com.ibm.cloud.cloudant.v1.model.BulkGetResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkGetOptions;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

BulkGetQueryDocument bulkGetDoc =
    new BulkGetQueryDocument.Builder()
        .id("order00067")
        .build();

PostBulkGetOptions postBulkGetOptions =
    new PostBulkGetOptions.Builder()
        .db("orders")
        .docs(Arrays.asList(bulkGetDoc))
        .build();

BulkGetResult response =
    service.postBulkGet(postBulkGetOptions).execute()
        .getResult();

System.out.println(response);

Alternative example request for `atts_since`

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.BulkGetQueryDocument;
import com.ibm.cloud.cloudant.v1.model.BulkGetResult;
import com.ibm.cloud.cloudant.v1.model.PostBulkGetOptions;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

BulkGetQueryDocument bulkGetQueryDocument =
    new BulkGetQueryDocument.Builder()
        .id("order00058")
        .addAttsSince("1-00000000000000000000000000000000")
        .build();

PostBulkGetOptions postBulkGetOptions =
    new PostBulkGetOptions.Builder()
        .db("orders")
        .docs(Arrays.asList(bulkGetQueryDocument)).build();

BulkGetResult response =
    service.postBulkGet(postBulkGetOptions).execute()
        .getResult();

System.out.println(response);

postChanges

POST /{db}/_changes

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ChangesResult;
import com.ibm.cloud.cloudant.v1.model.PostChangesOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PostChangesOptions changesOptions = new PostChangesOptions.Builder()
    .db("orders")
    .build();

ChangesResult response =
    service.postChanges(changesOptions).execute()
        .getResult();

System.out.println(response);

Example request as a stream

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostChangesOptions;

import java.io.InputStream;
import java.io.File;
import java.nio.file.StandardCopyOption;
// section: code
Cloudant service = Cloudant.newInstance();

PostChangesOptions changesOptions = new PostChangesOptions.Builder()
    .db("orders")
    .build();

File file = new File("result.json");

try (InputStream response =
        service.postChangesAsStream(changesOptions).execute()
            .getResult()) {
    java.nio.file.Files.copy(
        response,
        file.toPath(),
        StandardCopyOption.REPLACE_EXISTING);
}

deleteDesignDocument

DELETE /{db}/_design/{ddoc}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteDesignDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteDesignDocumentOptions designDocumentOptions =
    new DeleteDesignDocumentOptions.Builder()
        .db("products")
        .ddoc("appliances")
        .rev("1-00000000000000000000000000000000")
        .build();

DocumentResult response =
    service.deleteDesignDocument(designDocumentOptions).execute()
        .getResult();

System.out.println(response);

getDesignDocument

GET /{db}/_design/{ddoc}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DesignDocument;
import com.ibm.cloud.cloudant.v1.model.GetDesignDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetDesignDocumentOptions designDocumentOptions = new GetDesignDocumentOptions.Builder()
    .db("products")
    .ddoc("appliances")
    .build();

DesignDocument response =
    service.getDesignDocument(designDocumentOptions).execute()
        .getResult();

System.out.println(response);

headDesignDocument

HEAD /{db}/_design/{ddoc}

Example request

// section: code imports
import com.ibm.cloud.sdk.core.http.Headers;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadDesignDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

HeadDesignDocumentOptions designDocumentOptions =
    new HeadDesignDocumentOptions.Builder()
        .db("events")
        .ddoc("checkout")
        .build();

int statusCode =
    service.headDesignDocument(designDocumentOptions).execute()
        .getStatusCode();

Headers headers =
    service.headDesignDocument(designDocumentOptions).execute()
        .getHeaders();

System.out.println(statusCode);
System.out.println(headers.values("ETag"));

putDesignDocument

PUT /{db}/_design/{ddoc}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DesignDocument;
import com.ibm.cloud.cloudant.v1.model.DesignDocumentViewsMapReduce;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PutDesignDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.SearchIndexDefinition;

import java.util.Collections;
// section: code
Cloudant service = Cloudant.newInstance();

DesignDocumentViewsMapReduce emailViewMapReduce =
    new DesignDocumentViewsMapReduce.Builder()
        .map("function(doc) { if(doc.email_verified === true) { emit(doc.email, [doc.name, doc.email_verified, doc.joined]); }}")
        .build();

SearchIndexDefinition usersIndex =
    new SearchIndexDefinition.Builder()
        .index("function(doc) { index(\"name\", doc.name); index(\"active\", doc.active); }")
        .build();

DesignDocument designDocument = new DesignDocument();
designDocument.setViews(
    Collections.singletonMap("getVerifiedEmails", emailViewMapReduce));
designDocument.setIndexes(
    Collections.singletonMap("activeUsers", usersIndex));

PutDesignDocumentOptions designDocumentOptions =
    new PutDesignDocumentOptions.Builder()
        .db("users")
        .designDocument(designDocument)
        .ddoc("allusers")
        .build();

DocumentResult allusersResponse =
    service.putDesignDocument(designDocumentOptions).execute()
        .getResult();

System.out.println(allusersResponse);

DesignDocumentViewsMapReduce applianceView =
    new DesignDocumentViewsMapReduce.Builder()
        .map("function(doc) { emit(doc.productId, [doc.date, doc.eventType, doc.userId]); }")
        .build();

SearchIndexDefinition dateIndex =
    new SearchIndexDefinition.Builder()
        .index("function(doc) { index(\"date\", doc.date); }")
        .build();

DesignDocument partitionedDesignDocument = new DesignDocument();
partitionedDesignDocument.setViews(
    Collections.singletonMap("byProductId", applianceView));
partitionedDesignDocument.setIndexes(
    Collections.singletonMap("findByDate", dateIndex));

PutDesignDocumentOptions partitionedDesignDocumentOptions =
    new PutDesignDocumentOptions.Builder()
        .db("events")
        .designDocument(partitionedDesignDocument)
        .ddoc("checkout")
        .build();

DocumentResult appliancesResponse =
    service.putDesignDocument(partitionedDesignDocumentOptions).execute()
        .getResult();

System.out.println(appliancesResponse);
// section: markdown
// This example creates `allusers` design document in the `users` database and `checkout` design document in the partitioned `events` database.

getDesignDocumentInformation

GET /{db}/_design/{ddoc}/_info

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DesignDocumentInformation;
import com.ibm.cloud.cloudant.v1.model.GetDesignDocumentInformationOptions;


// section: code
Cloudant service = Cloudant.newInstance();

GetDesignDocumentInformationOptions informationOptions =
    new GetDesignDocumentInformationOptions.Builder()
        .db("products")
        .ddoc("appliances")
        .build();

DesignDocumentInformation response =
    service.getDesignDocumentInformation(informationOptions).execute()
        .getResult();

System.out.println(response);

postSearch

POST /{db}/_design/{ddoc}/_search/{index}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
// section: code
Cloudant service = Cloudant.newInstance();

PostSearchOptions searchOptions = new PostSearchOptions.Builder()
    .db("users")
    .ddoc("allusers")
    .index("activeUsers")
    .query("name:Jane* AND active:True")
    .build();

SearchResult response =
    service.postSearch(searchOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `activeUsers` Cloudant Search index to exist. To create the design document with this index, see [Create or modify a design document.](#putdesigndocument)

getSearchInfo

GET /{db}/_design/{ddoc}/_search_info/{index}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSearchInfoOptions;
import com.ibm.cloud.cloudant.v1.model.SearchInfoResult;
// section: code
Cloudant service = Cloudant.newInstance();

GetSearchInfoOptions infoOptions =
    new GetSearchInfoOptions.Builder()
        .db("events")
        .ddoc("checkout")
        .index("findByDate")
        .build();

SearchInfoResult response =
    service.getSearchInfo(infoOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `findByDate` Cloudant Search partitioned index to exist. To create the design document with this index, see [Create or modify a design document.](#putdesigndocument)

postView

POST /{db}/_design/{ddoc}/_view/{view}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostViewOptions;
import com.ibm.cloud.cloudant.v1.model.ViewResult;
// section: code
Cloudant service = Cloudant.newInstance();

PostViewOptions viewOptions = new PostViewOptions.Builder()
    .db("users")
    .ddoc("allusers")
    .view("getVerifiedEmails")
    .build();

ViewResult response =
    service.postView(viewOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `getVerifiedEmails` view to exist. To create the design document with this view, see [Create or modify a design document.](#putdesigndocument)

postViewQueries

POST /{db}/_design/{ddoc}/_view/{view}/queries

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostViewQueriesOptions;
import com.ibm.cloud.cloudant.v1.model.ViewQueriesResult;
import com.ibm.cloud.cloudant.v1.model.ViewQuery;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

ViewQuery query1 = new ViewQuery.Builder()
    .includeDocs(true)
    .limit(5)
    .build();

ViewQuery query2 = new ViewQuery.Builder()
    .descending(true)
    .skip(1)
    .build();

PostViewQueriesOptions queriesOptions =
    new PostViewQueriesOptions.Builder()
        .db("users")
        .ddoc("allusers")
        .queries(Arrays.asList(query1, query2))
        .view("getVerifiedEmails")
        .build();

ViewQueriesResult response =
    service.postViewQueries(queriesOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `getVerifiedEmails` view to exist. To create the design document with this view, see [Create or modify a design document.](#putdesigndocument)

postDesignDocs

POST /{db}/_design_docs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsResult;
import com.ibm.cloud.cloudant.v1.model.PostDesignDocsOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PostDesignDocsOptions docsOptions =
    new PostDesignDocsOptions.Builder()
        .descending(true)
        .db("users")
        .build();

AllDocsResult response =
    service.postDesignDocs(docsOptions).execute()
        .getResult();

System.out.println(response);

postDesignDocsQueries

POST /{db}/_design_docs/queries

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsQueriesResult;
import com.ibm.cloud.cloudant.v1.model.AllDocsQuery;
import com.ibm.cloud.cloudant.v1.model.PostDesignDocsQueriesOptions;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

AllDocsQuery query1 = new AllDocsQuery.Builder()
    .descending(true)
    .includeDocs(true)
    .limit(10)
    .build();
AllDocsQuery query2 = new AllDocsQuery.Builder()
    .inclusiveEnd(true)
    .startKey("_design/allusers")
    .skip(1)
    .build();

PostDesignDocsQueriesOptions queriesOptions =
    new PostDesignDocsQueriesOptions.Builder()
        .db("users")
        .queries(Arrays.asList(query1, query2))
        .build();

AllDocsQueriesResult response =
    service.postDesignDocsQueries(queriesOptions).execute()
        .getResult();

System.out.println(response);

postExplain

POST /{db}/_explain

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ExplainResult;
import com.ibm.cloud.cloudant.v1.model.PostExplainOptions;

import java.util.Collections;
import java.util.Map;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, Object> selector = Collections.singletonMap(
    "type",
    Collections.singletonMap("$eq", "user"));

PostExplainOptions explainOptions =
    new PostExplainOptions.Builder()
        .db("users")
        .executionStats(true)
        .limit(10)
        .selector(selector)
        .build();

ExplainResult response =
    service.postExplain(explainOptions).execute()
        .getResult();

System.out.println(response);

postFind

POST /{db}/_find

Example request for "json" index type

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.FindResult;
import com.ibm.cloud.cloudant.v1.model.PostFindOptions;

import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, Object> selector = Collections.singletonMap(
    "email_verified",
    Collections.singletonMap("$eq", true));

Map<String, String> fieldSort = Collections.singletonMap("email", "desc");

PostFindOptions findOptions = new PostFindOptions.Builder()
    .db("users")
    .selector(selector)
    .fields(Arrays.asList("_id", "type", "name", "email"))
    .addSort(fieldSort)
    .limit(3)
    .build();

FindResult response =
    service.postFind(findOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `getUserByEmail` Cloudant Query "json" index to exist. To create the index, see [Create a new index on a database.](#postindex)

Example request for "text" index type

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.FindResult;
import com.ibm.cloud.cloudant.v1.model.PostFindOptions;

import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, Object> selector = Collections.singletonMap(
    "address",
    Collections.singletonMap("$exists", true));

PostFindOptions findOptions = new PostFindOptions.Builder()
    .db("users")
    .selector(selector)
    .fields(Arrays.asList("_id", "type", "name", "email", "address"))
    .limit(3)
    .build();

FindResult response =
    service.postFind(findOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `getUserByAddress` Cloudant Query "text" index to exist. To create the index, see [Create a new index on a database.](#postindex)

getIndexesInformation

GET /{db}/_index

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetIndexesInformationOptions;
import com.ibm.cloud.cloudant.v1.model.IndexesInformation;
// section: code
Cloudant service = Cloudant.newInstance();

GetIndexesInformationOptions indexesInformationOptions =
    new GetIndexesInformationOptions.Builder()
        .db("users")
        .build();

IndexesInformation response =
    service.getIndexesInformation(indexesInformationOptions).execute()
        .getResult();

System.out.println(response);

postIndex

POST /{db}/_index

Example request using "json" type index

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.IndexDefinition;
import com.ibm.cloud.cloudant.v1.model.IndexField;
import com.ibm.cloud.cloudant.v1.model.IndexResult;
import com.ibm.cloud.cloudant.v1.model.PostIndexOptions;
// section: code
Cloudant service = Cloudant.newInstance();
// Type "json" index fields require an object that maps the name of a field to a sort direction.

IndexField field = new IndexField.Builder()
    .add("email", "asc")
    .build();

IndexDefinition indexDefinition = new IndexDefinition.Builder()
    .addFields(field)
    .build();

PostIndexOptions indexOptions = new PostIndexOptions.Builder()
    .db("users")
    .ddoc("json-index")
    .index(indexDefinition)
    .name("getUserByEmail")
    .type("json")
    .build();

IndexResult response =
    service.postIndex(indexOptions).execute()
        .getResult();

System.out.println(response);

Example request using "text" type index

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.IndexDefinition;
import com.ibm.cloud.cloudant.v1.model.IndexField;
import com.ibm.cloud.cloudant.v1.model.IndexResult;
import com.ibm.cloud.cloudant.v1.model.PostIndexOptions;
// section: code
Cloudant service = Cloudant.newInstance();

// Type "text" index fields require an object with a name and type properties for the field.
IndexField field = new IndexField.Builder()
    .name("address")
    .type(IndexField.Type.STRING)
    .build();

IndexDefinition indexDefinition = new IndexDefinition.Builder()
    .addFields(field)
    .build();

PostIndexOptions indexOptions = new PostIndexOptions.Builder()
    .db("users")
    .ddoc("text-index")
    .index(indexDefinition)
    .name("getUserByAddress")
    .type("text")
    .build();

IndexResult response =
    service.postIndex(indexOptions).execute()
        .getResult();

System.out.println(response);

deleteIndex

DELETE /{db}/_index/_design/{ddoc}/{type}/{index}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteIndexOptions;
import com.ibm.cloud.cloudant.v1.model.Ok;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteIndexOptions indexOptions = new DeleteIndexOptions.Builder()
    .db("users")
    .ddoc("json-index")
    .index("getUserByName")
    .type("json")
    .build();

Ok response =
    service.deleteIndex(indexOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example will fail if `getUserByName` index doesn't exist. To create the index, see [Create a new index on a database.](#postindex)

deleteLocalDocument

DELETE /{db}/_local/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteLocalDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteLocalDocumentOptions documentOptions =
    new DeleteLocalDocumentOptions.Builder()
        .db("orders")
        .docId("local-0007741142412418284")
        .build();

DocumentResult response =
    service.deleteLocalDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

getLocalDocument

GET /{db}/_local/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.GetLocalDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetLocalDocumentOptions documentOptions =
    new GetLocalDocumentOptions.Builder()
        .db("orders")
        .docId("local-0007741142412418284")
        .build();

Document response =
    service.getLocalDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

putLocalDocument

PUT /{db}/_local/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PutLocalDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

Document orderDocument = new Document();
orderDocument.put("type", "order");
orderDocument.put("user", "Bob Smith");
orderDocument.put("orderId", "0007741142412418284");
orderDocument.put("userId", "abc123");
orderDocument.put("total", 214.98);
orderDocument.put("deliveryAddress", "19 Front Street, Darlington, DL5 1TY");
orderDocument.put("delivered", true);
orderDocument.put("courier", "UPS");
orderDocument.put("courierId", "15125425151261289");
orderDocument.put("date", "2019-01-28T10:44:22.000Z");

PutLocalDocumentOptions documentOptions =
    new PutLocalDocumentOptions.Builder()
        .db("orders")
        .docId("local-0007741142412418284")
        .document(orderDocument)
        .build();

DocumentResult response =
    service.putLocalDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

getPartitionInformation

GET /{db}/_partition/{partition_key}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetPartitionInformationOptions;
import com.ibm.cloud.cloudant.v1.model.PartitionInformation;
// section: code
Cloudant service = Cloudant.newInstance();

GetPartitionInformationOptions informationOptions =
    new GetPartitionInformationOptions.Builder()
        .db("events")
        .partitionKey("ns1HJS13AMkK")
        .build();

PartitionInformation response =
    service.getPartitionInformation(informationOptions).execute()
        .getResult();

System.out.println(response);

postPartitionAllDocs

POST /{db}/_partition/{partition_key}/_all_docs

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsResult;
import com.ibm.cloud.cloudant.v1.model.PostPartitionAllDocsOptions;
// section: code
Cloudant service = Cloudant.newInstance();

PostPartitionAllDocsOptions allDocsOptions =
    new PostPartitionAllDocsOptions.Builder()
        .db("events")
        .partitionKey("ns1HJS13AMkK")
        .includeDocs(true)
        .build();

AllDocsResult response =
    service.postPartitionAllDocs(allDocsOptions).execute()
        .getResult();

System.out.println(response);

postPartitionSearch

POST /{db}/_partition/{partition_key}/_design/{ddoc}/_search/{index}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostPartitionSearchOptions;
import com.ibm.cloud.cloudant.v1.model.SearchResult;
// section: code
Cloudant service = Cloudant.newInstance();

PostPartitionSearchOptions searchOptions =
    new PostPartitionSearchOptions.Builder()
        .db("events")
        .partitionKey("ns1HJS13AMkK")
        .ddoc("checkout")
        .index("findByDate")
        .query("date:[2019-01-01T12:00:00.000Z TO 2019-01-31T12:00:00.000Z]")
        .build();

SearchResult response =
    service.postPartitionSearch(searchOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `findByDate` Cloudant Search partitioned index to exist. To create the design document with this index, see [Create or modify a design document.](#putdesigndocument)

postPartitionView

POST /{db}/_partition/{partition_key}/_design/{ddoc}/_view/{view}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostPartitionViewOptions;
import com.ibm.cloud.cloudant.v1.model.ViewResult;
// section: code
Cloudant service = Cloudant.newInstance();

PostPartitionViewOptions viewOptions =
    new PostPartitionViewOptions.Builder()
        .db("events")
        .ddoc("checkout")
        .includeDocs(true)
        .limit(10)
        .partitionKey("ns1HJS13AMkK")
        .view("byProductId")
        .build();

ViewResult response =
    service.postPartitionView(viewOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `byProductId` partitioned view to exist. To create the design document with this view, see [Create or modify a design document.](#putdesigndocument)

postPartitionExplain

POST /{db}/_partition/{partition_key}/_explain

Example request

postPartitionFind

POST /{db}/_partition/{partition_key}/_find

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.FindResult;
import com.ibm.cloud.cloudant.v1.model.PostPartitionFindOptions;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, String> typeEqualsProduct = new HashMap<>();
typeEqualsProduct.put("$eq", "abc123");

Map<String, Object> selector = new HashMap<>();
selector.put("userId", typeEqualsProduct);

PostPartitionFindOptions findOptions =
    new PostPartitionFindOptions.Builder()
        .db("events")
        .partitionKey("ns1HJS13AMkK")
        .fields(Arrays.asList("productId", "eventType", "date"))
        .selector(selector)
        .build();

FindResult response =
    service.postPartitionFind(findOptions).execute()
        .getResult();

System.out.println(response);

postRevsDiff

POST /{db}/_revs_diff

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.PostRevsDiffOptions;
import com.ibm.cloud.cloudant.v1.model.RevsDiff;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

Map<String, List<String>> docRevisions =
    Collections.singletonMap("order00077", Arrays.asList(
        "1-00000000000000000000000000000000", // missing revision
        "2-11111111111111111111111111111111", // missing revision
        "3-22222222222222222222222222222222"  // possible ancestor revision
    ));

PostRevsDiffOptions revsDiffOptions =
    new PostRevsDiffOptions.Builder()
        .db("orders")
        .documentRevisions(docRevisions)
        .build();

Map<String,RevsDiff> response =
    service.postRevsDiff(revsDiffOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the example revisions in the POST body to be replaced with valid revisions.

getSecurity

GET /{db}/_security

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetSecurityOptions;
import com.ibm.cloud.cloudant.v1.model.Security;
// section: code
Cloudant service = Cloudant.newInstance();

GetSecurityOptions securityOptions =
    new GetSecurityOptions.Builder()
        .db("products")
        .build();

Security response =
    service.getSecurity(securityOptions).execute()
        .getResult();

System.out.println(response);

putSecurity

PUT /{db}/_security

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PutSecurityOptions;
import com.ibm.cloud.cloudant.v1.model.SecurityObject;

import java.util.Arrays;
// section: code
Cloudant service = Cloudant.newInstance();

SecurityObject members = new SecurityObject.Builder()
    .names(Arrays.asList("user1", "user2"))
    .roles(Arrays.asList("developers"))
    .build();

PutSecurityOptions securityOptions =
    new PutSecurityOptions.Builder()
        .db("products")
        .members(members)
        .build();

Ok response =
    service.putSecurity(securityOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but didn't identify itself, the task can continue only if the `nobody` user has the role `_reader`.
// section: markdown
// If instead of using Cloudant's security model for managing permissions you opt to use the Apache CouchDB `_users` database (that is using legacy credentials _and_ the `couchdb_auth_only:true` option) then be aware that the user must already exist in `_users` database before adding permissions. For information on the `_users` database, see <a href="https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-work-with-your-account#using-the-users-database-with-cloudant-nosql-db" target="_blank">Using the `_users` database with Cloudant</a>.

getShardsInformation

GET /{db}/_shards

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetShardsInformationOptions;
import com.ibm.cloud.cloudant.v1.model.ShardsInformation;
// section: code
Cloudant service = Cloudant.newInstance();

GetShardsInformationOptions shardsInformationOptions =
    new GetShardsInformationOptions.Builder()
        .db("products")
        .build();

ShardsInformation response =
    service.getShardsInformation(shardsInformationOptions)
        .execute().getResult();

System.out.println(response);

getDocumentShardsInfo

GET /{db}/_shards/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DocumentShardInfo;
import com.ibm.cloud.cloudant.v1.model.GetDocumentShardsInfoOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetDocumentShardsInfoOptions shardsInfoOptions =
    new GetDocumentShardsInfoOptions.Builder()
        .db("products")
        .docId("1000042")
        .build();

DocumentShardInfo response =
    service.getDocumentShardsInfo(shardsInfoOptions).execute()
        .getResult();

System.out.println(response);

deleteDocument

DELETE /{db}/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteDocumentOptions;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteDocumentOptions documentOptions =
    new DeleteDocumentOptions.Builder()
        .db("orders")
        .docId("order00058")
        .rev("1-00000000000000000000000000000000")
        .build();

DocumentResult response =
    service.deleteDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

getDocument

GET /{db}/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.GetDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

GetDocumentOptions documentOptions =
    new GetDocumentOptions.Builder()
        .db("products")
        .docId("1000042")
        .build();

Document response =
    service.getDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

headDocument

HEAD /{db}/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.sdk.core.http.Headers;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();
HeadDocumentOptions documentOptions =
    new HeadDocumentOptions.Builder()
        .db("orders")
        .docId("order00058")
        .build();

int statusCode =
    service.headDocument(documentOptions).execute()
        .getStatusCode();
Headers headers =
    service.headDocument(documentOptions).execute()
        .getHeaders();

System.out.println(statusCode);
System.out.println(headers.values("ETag"));

putDocument

PUT /{db}/{doc_id}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PutDocumentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

Document eventDoc = new Document();
eventDoc.put("type", "event");
eventDoc.put("userId", "abc123");
eventDoc.put("eventType", "addedToBasket");
eventDoc.put("productId", "1000042");
eventDoc.put("date", "2019-01-28T10:44:22.000Z");

PutDocumentOptions documentOptions =
    new PutDocumentOptions.Builder()
        .db("events")
        .docId("ns1HJS13AMkK:0007241142412418284")
        .document(eventDoc)
        .build();

DocumentResult response =
    service.putDocument(documentOptions).execute()
        .getResult();

System.out.println(response);

deleteAttachment

DELETE /{db}/{doc_id}/{attachment_name}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DeleteAttachmentOptions;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
// section: code
Cloudant service = Cloudant.newInstance();

DeleteAttachmentOptions attachmentOptions =
    new DeleteAttachmentOptions.Builder()
        .db("products")
        .docId("1000042")
        .attachmentName("product_details.txt")
        .rev("4-33333333333333333333333333333333")
        .build();

DocumentResult response =
    service.deleteAttachment(attachmentOptions).execute()
        .getResult();

System.out.println(response);
// section: markdown
// This example requires the `product_details.txt` attachment in `1000042` document to exist. To create the attachment, see [Create or modify an attachment.](#putattachment)

getAttachment

GET /{db}/{doc_id}/{attachment_name}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.GetAttachmentOptions;

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.stream.Collectors;
// section: code
Cloudant service = Cloudant.newInstance();

GetAttachmentOptions attachmentOptions =
    new GetAttachmentOptions.Builder()
        .db("products")
        .docId("1000042")
        .attachmentName("product_details.txt")
        .build();

try(InputStream streamResult =
        service.getAttachment(attachmentOptions).execute()
            .getResult()) {        
    String response =
        new BufferedReader(new InputStreamReader(streamResult))
            .lines().collect(Collectors.joining("\n"));
    
    System.out.println(response);
}

// section: markdown
// This example requires the `product_details.txt` attachment in `1000042` document to exist. To create the attachment, see [Create or modify an attachment.](#putattachment)

headAttachment

HEAD /{db}/{doc_id}/{attachment_name}

Example request

// section: code imports
import com.ibm.cloud.sdk.core.http.Headers;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.HeadAttachmentOptions;
// section: code
Cloudant service = Cloudant.newInstance();

HeadAttachmentOptions attachmentOptions =
    new HeadAttachmentOptions.Builder()
        .db("products")
        .docId("1000042")
        .attachmentName("product_details.txt")
        .build();

int statusCode =
    service.headAttachment(attachmentOptions).execute()
        .getStatusCode();

Headers headers =
    service.headAttachment(attachmentOptions).execute()
        .getHeaders();

System.out.println(statusCode);
System.out.println(headers.values("Content-Length"));
System.out.println(headers.values("Content-Type"));
// section: markdown
// This example requires the `product_details.txt` attachment in `1000042` document to exist. To create the attachment, see [Create or modify an attachment.](#putattachment)

putAttachment

PUT /{db}/{doc_id}/{attachment_name}

Example request

// section: code imports
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DocumentResult;
import com.ibm.cloud.cloudant.v1.model.PutAttachmentOptions;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
// section: code
Cloudant service = Cloudant.newInstance();

String detailedDescription = "This appliance includes...";

InputStream detailedDescriptionStream =
    new ByteArrayInputStream(detailedDescription
        .getBytes(StandardCharsets.UTF_8));

PutAttachmentOptions attachmentOptions =
    new PutAttachmentOptions.Builder()
        .db("products")
        .docId("1000042")
        .attachmentName("product_details.txt")
        .attachment(detailedDescriptionStream)
        .contentType("text/plain")
        .build();

DocumentResult response =
    service.putAttachment(attachmentOptions).execute()
        .getResult();

System.out.println(response);

Name		Name	Last commit message	Last commit date
parent directory ..
snippets		snippets
README.md		README.md

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

examples

Directory actions

More options

Directory actions

More options

Latest commit

History

examples

Folders and files

parent directory

Examples for java

getServerInformation

getActiveTasks

getAllDbs

postApiKeys

putCloudantSecurity

getActivityTrackerEvents

postActivityTrackerEvents

getCapacityThroughputInformation

putCapacityThroughputConfiguration

getCorsInformation

putCorsConfiguration

getCurrentThroughputInformation

getDbUpdates

postDbsInfo

getMembershipInformation

deleteReplicationDocument

getReplicationDocument

headReplicationDocument

putReplicationDocument

getSchedulerDocs

getSchedulerDocument

getSchedulerJobs

getSchedulerJob

headSchedulerJob

postSearchAnalyze

getSessionInformation

getUpInformation

getUuids

deleteDatabase

getDatabaseInformation

headDatabase

postDocument

putDatabase

postAllDocs

postAllDocsQueries

postBulkDocs

postBulkGet

postChanges

deleteDesignDocument

getDesignDocument

headDesignDocument

putDesignDocument

getDesignDocumentInformation

postSearch

getSearchInfo

postView

postViewQueries

postDesignDocs

postDesignDocsQueries

postExplain

postFind

getIndexesInformation

postIndex

deleteIndex

deleteLocalDocument

getLocalDocument

putLocalDocument

getPartitionInformation

postPartitionAllDocs