implementation 'com.ibm.cloud:cloudant:0.+'

npm install --save @ibm-cloud/cloudant

pip3 install ibmcloudant

go get -u github.com/IBM/cloudant-go-sdk/cloudantv1

{service-name}_URL={url}
{service-name}_APIKEY={apikey}

import com.ibm.cloud.cloudant.v1.Cloudant;

Cloudant service = Cloudant.newInstance("{service-name}");

import { CloudantV1 } from '@ibm-cloud/cloudant';

const service = CloudantV1.newInstance({
    serviceName: '{service-name}'
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance(service_name="{service-name}")

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
    &cloudantv1.CloudantV1Options{
        ServiceName: "{service-name}",
    },
)

{service-name}_AUTH_TYPE=COUCHDB_SESSION
{service-name}_URL={url}
{service-name}_USERNAME={username}
{service-name}_PASSWORD={password}

import com.ibm.cloud.cloudant.v1.Cloudant;

Cloudant service = Cloudant.newInstance("{service-name}");

import { CloudantV1 } from '@ibm-cloud/cloudant';

const service = CloudantV1.newInstance({
    serviceName: '{service-name}'
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance(service_name="{service-name}")

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
    &cloudantv1.CloudantV1Options{
        ServiceName: "{service-name}",
    },
)

{service-name}_AUTH_TYPE=BASIC
{service-name}_URL={url}
{service-name}_USERNAME={username}
{service-name}_PASSWORD={password}

import com.ibm.cloud.cloudant.v1.Cloudant;

Cloudant service = Cloudant.newInstance("{service-name}");

import { CloudantV1 } from '@ibm-cloud/cloudant';

const service = CloudantV1.newInstance({
    serviceName: '{service-name}'
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance(service_name="{service-name}")

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
    &cloudantv1.CloudantV1Options{
        ServiceName: "{service-name}",
    },
)

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.sdk.core.security.IamAuthenticator;

IamAuthenticator authenticator = new IamAuthenticator.Builder()
    .apikey("{apikey}")
    .build();

Cloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);

service.setServiceUrl("{url}");

import { CloudantV1 } from '@ibm-cloud/cloudant';
import { IamAuthenticator } from 'ibm-cloud-sdk-core';

const authenticator = new IamAuthenticator({
    apikey: '{apikey}'
});

const service = new CloudantV1({
    authenticator: authenticator
});

service.setServiceUrl('{url}');

from ibmcloudant.cloudant_v1 import CloudantV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')

service = CloudantV1(authenticator=authenticator)

service.set_service_url('{url}')

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
    "github.com/IBM/go-sdk-core/core"
)

authenticator := &core.IamAuthenticator{
    ApiKey: "{apikey}",
}

service, err := cloudantv1.NewCloudantV1(
    &cloudantv1.CloudantV1Options{
        URL:           "{url}",
        Authenticator: authenticator,
    },
)
if err != nil {
    panic(err)
}

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.sdk.core.security.Authenticator;
import com.ibm.cloud.cloudant.security.CouchDbSessionAuthenticator;

Authenticator authenticator = CouchDbSessionAuthenticator.newAuthenticator("{username}", "{password}");

Cloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);

service.setServiceUrl("{url}");

import { CloudantV1, CouchdbSessionAuthenticator } from '@ibm-cloud/cloudant';

const authenticator = new CouchdbSessionAuthenticator({
    username: '{username}',
    password: '{password}'
});

const service = new CloudantV1({
    authenticator: authenticator
});

service.setServiceUrl('{url}');

from ibmcloudant.cloudant_v1 import CloudantV1
from ibmcloudant import CouchDbSessionAuthenticator

authenticator = CouchDbSessionAuthenticator('{username}', '{password}')

service = CloudantV1(authenticator=authenticator)

service.set_service_url('{url}')

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
    "github.com/IBM/cloudant-go-sdk/auth"
)

authenticator, err := auth.NewCouchDbSessionAuthenticator(
    "{username}",
    "{password}",
)
if err != nil {
    panic(err)
}

service, err := cloudantv1.NewCloudantV1(
    &cloudantv1.CloudantV1Options{
        URL:           "{url}",
        Authenticator: authenticator,
    },
)
if err != nil {
    panic(err)
}

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.sdk.core.security.BasicAuthenticator;

BasicAuthenticator authenticator = new BasicAuthenticator.Builder()
    .username("{username}")
    .password("{password}")
    .build();

Cloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);

service.setServiceUrl("{url}");

import { CloudantV1 } from '@ibm-cloud/cloudant';
import { BasicAuthenticator } from 'ibm-cloud-sdk-core';

const authenticator = new BasicAuthenticator({
    username: '{username}',
    password: '{password}'
});

const service = new CloudantV1({
    authenticator: authenticator
});

service.setServiceUrl('{url}');

from ibmcloudant.cloudant_v1 import CloudantV1
from ibm_cloud_sdk_core.authenticators import BasicAuthenticator

authenticator = BasicAuthenticator('{username}', '{password}')

service = CloudantV1(authenticator=authenticator)

service.set_service_url('{url}')

import (
    "github.com/IBM/cloudant-go-sdk/cloudantv1"
    "github.com/IBM/go-sdk-core/core"
)

authenticator, err := core.NewBasicAuthenticator(
    "{username}",
    "{password}",
)
if err != nil {
    panic(err)
}

service, err := cloudantv1.NewCloudantV1(
    &cloudantv1.CloudantV1Options{
        URL:           "{url}",
        Authenticator: authenticator,
    },
)
if err != nil {
    panic(err)
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -X GET 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/products'

{
  "error": "not_found",
  "reason": "Database does not exist."
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/_api/v2/db/products/_security'

{
  "code": 400,
  "error": "No DB products belonging to 00000000-0000-0000-0000-000000000000-bluemix"
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -d '' 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/_api/v2/user/capacity/throughput'

{
    "message": "The method is not allowed for the requested URL."
}

import (
	"encoding/json"
	"fmt"

	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/go-sdk-core/v5/core"
)

func errorHandlingExample() {
	service, err := cloudantv1.NewCloudantV1(
		&cloudantv1.CloudantV1Options{},
	)
	if err != nil {
		panic(err)
	}

	getDatabaseInformationOptions := service.NewGetDatabaseInformationOptions(
		"products",
	)

	var response core.DetailedResponse
	databaseInformation, response, err := service.GetDatabaseInformation(getDatabaseInformationOptions)
	if err != nil {
		// Use the DetailedResponse to check the HTTP status code
		if response.StatusCode == 404 {
			// Handle database not existing, maybe create it
		} else {
			fmt.Println("Error: ", err.Error())
			fmt.Println("Error status code: ", response.StatusCode)
			// Handle other errors
			errorMap, ok := response.GetResultAsMap()
			if ok {
				// Get the request UUID for what went wrong
				fmt.Println("Trace request UUID: ", errorMap["trace"])
			} else {
				// For example to handle non-JSON response bodies
				fmt.Println("Raw error response: ", response.RawResult)
			}
		}
	}

	b, _ := json.MarshalIndent(databaseInformation, "", "  ")
	fmt.Println(string(b))
}

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DatabaseInformation;
import com.ibm.cloud.cloudant.v1.model.GetDatabaseInformationOptions;
import com.ibm.cloud.sdk.core.service.exception.NotFoundException;
import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;

public class ErrorHandlingExample {

    public static void main() {
        Cloudant service = Cloudant.newInstance();

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

        try {
            DatabaseInformation response =
                    service.getDatabaseInformation(databaseInfoOptions).execute().getResult();
            System.out.println(response);
        } catch (NotFoundException e) {
            // Handle database not existing, maybe create it
        } catch (ServiceResponseException e) {
            System.out.println("Error: " + e.getMessage());
            System.out.println("Error status code: " + e.getStatusCode());
            System.out.println("Trace UUID: " + e.getDebuggingInfo().getOrDefault("trace", "No trace available"));
        } catch (RuntimeException e) {
            e.printStackTrace();
        }
    }
}

import { CloudantV1 } from '@ibm-cloud/cloudant';

function errorHandlingExample() {
  const service = CloudantV1.newInstance({});

  return service.getDatabaseInformation({ db: "products"})
    .then(response => {
      console.log(response.result);
    }).catch((error) => {
      console.log(`Error message:      ${error.message}`);
      console.log(`Error status text:  ${error.statusText}`);
      if (error.status) {
        if (error.status === 404) {
          // Handle database not existing, maybe create it
        } else {
          console.log(`Error status code:  ${error.status}`);
          console.log(`Trace request UUID: ${error?.result?.trace}`);
        }
      } else if (error.code) {
        console.log(`Error code:         ${error.code}`);
      } else {
        console.log(`Error body:         ${error.body}`);
      }
    });
}

await errorHandlingExample();

from ibmcloudant.cloudant_v1 import CloudantV1
from ibm_cloud_sdk_core import ApiException
from requests import RequestException

service = CloudantV1.new_instance()

try:
    response = service.get_database_information(db="products").get_result()
    print(response)
except ApiException as ae:
    print("Error message: " + ae.message)
    if ae.status_code == 404:
        # Handle database not existing, maybe create it
        pass
    else:
        print(f'Error status code: {ae.status_code}')
        if 'trace' in (debugInfo := ae.http_response.json()):
            print(f'Trace request UUID: {debugInfo["trace"]}')
except (RequestException, ValueError) as err:
    print(err)

curl -H 'Custom-Header:custom_value' -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -X GET https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud

customHeaders := http.Header{}
customHeaders.Add("Custom-Header", "custom_value")
service.SetDefaultHeaders(customHeaders)

options := service.NewGetServerInformationOptions()

customHeaders := make(map[string]string)
customHeaders["Custom-Header"] = "custom_value"

options.SetHeaders(customHeaders)

serverInformation, response, err := service.GetServerInformation(options)

Map<String, String> headers = new HashMap<String, String>();
headers.put("Customer-Header", "custom_value");

service.setDefaultHeaders(headers);

ServerInformation response = service.getServerInformation()
        .addHeader("Custom-Header", "custom_value")
        .execute();

const service = CloudantV1.newInstance({
  headers: {
    'Custom-Header': 'custom_value',
  },
});

service.getServerInformation({
  headers: {
    'Custom-Header': 'custom_value'
  }
}).then(response => {
  console.log(response.result);
});

headers = {
    'Custom-Header': 'custom_value'
}

service.set_default_headers(headers)

response = service.get_server_information(
    headers = {
        'Custom-Header': 'custom_value'
    })

curl -i -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -X GET https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/products/1000042

HTTP/1.1 200 OK
X-Couch-Request-ID: 00000000-0000-0000-0000-000000000000
Content-Type: application/json
...

getDocumentOptions := service.NewGetDocumentOptions(
    "products",
    "1000042",
)

document, response, err := service.GetDocument(getDocumentOptions)
if err != nil {
    panic(err)
}

// Access response headers
responseHeaders := response.GetHeaders()
couchRequestID := responseHeaders.Get("X-Couch-Request-ID")
fmt.Printf("X-Couch-Request-ID: %s\n", couchRequestID)

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

Response<Document> response = service.getDocument(getDocumentOptions).execute();

// Access response headers
Headers responseHeaders = response.getHeaders();
String couchRequestId = responseHeaders.values("X-Couch-Request-ID").get(0);
System.out.println("X-Couch-Request-ID: " + couchRequestId);

service.getDocument({
  db: 'products',
  docId: '1000042'
}).then(response => {
  // Access response headers
  const couchRequestId = response.headers['x-couch-request-id'];
  console.log('X-Couch-Request-ID: ' + couchRequestId);
});

response = service.get_document(
    db='products',
    doc_id='1000042'
)

# Access response headers
response_headers = response.get_headers()
couch_request_id = response_headers.get('X-Couch-Request-ID')
print(f'X-Couch-Request-ID: {couch_request_id}')

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_all_docs?limit=6"

{
  "total_rows": 11,
  "offset": 0,
  "rows": [
    { "id": "4eee973603bf77f30b1f880ed83df76a" ....},
    { "id": "4eee973603bf77f30b1f880ed83f469a" ....},
    { "id": "65fa623a384648740ec1f39b495d591c" ....},
    { "id": "d7404903579d6d5880514c22ad983529" ....},
    { "id": "example" ....},
    { "id": "mydoc" ....} // <-- This is the 6th result we use as the start_key of the next request
   ]
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_all_docs?limit=6&start_key=\"mydoc\""

{
  "total_rows": 11,
  "offset": 5,
  "rows": [
    { "id": "mydoc" ....},
    { "id": "order00057" ....},
    ...
   ]
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_all_docs?limit=5"

{
  "total_rows": 11,
  "offset": 0,
  "rows": [
    { "id": "4eee973603bf77f30b1f880ed83df76a" ....},
    { "id": "4eee973603bf77f30b1f880ed83f469a" ....},
    { "id": "65fa623a384648740ec1f39b495d591c" ....},
    { "id": "d7404903579d6d5880514c22ad983529" ....},
    { "id": "example" ....} // <-- append \u0000 to this to get the start_key of the next request
   ]
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_all_docs?limit=5&start_key=\"example\u0000\""

{
  "total_rows": 11,
  "offset": 5,
  "rows": [
    { "id": "mydoc" ....},
    { "id": "order00057" ....},
    ...
    { "id": "order00067" ....} <-- append \u0000 to this to get the start_key of the next request
   ]
}

import java.util.List;
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.DocsResultRow;
import com.ibm.cloud.cloudant.v1.model.PostAllDocsOptions;
import com.ibm.cloud.cloudant.features.pagination.Pager;
import com.ibm.cloud.cloudant.features.pagination.Pagination;

// Initialize service
Cloudant service = Cloudant.newInstance();

// Setup options
PostAllDocsOptions options = new PostAllDocsOptions.Builder()
  .db("orders") // example database name
  .limit(50) // limit option sets the page size
  .startKey("abc") // start from example doc ID abc
  .build();

// Create pagination
Pagination<PostAllDocsOptions, DocsResultRow> pagination = Pagination.newPagination(service, options);
// pagination can be reused without side-effects as a factory for iterables, streams or pagers
// options are fixed at pagination creation time

// Option: iterate rows
// Ideal for using an enhanced for loop with each row.
// The Iterable returned from rows() is reusable in that
// calling iterator() returns a new iterator each time.
// The returned iterators, however, are single use.
for (DocsResultRow row : pagination.rows()) {
  // Do something with row
}

import { CloudantV1, Pagination, PagerType } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises';

// Initialize service
const client = CloudantV1.newInstance();

// Setup params
const paginationParams = {
  db: 'orders', // Required: the database name.
  limit: 50, // Optional: limit parameter sets the page size. Default and max is 200.
  startKey: 'abc', // start from example doc ID abc
};

// Create pagination
// pagination can be reused without side-effects as a factory for async iterables, streams or pagers
const pagination = Pagination.newPagination(
  client, // Required: the Cloudant service client instance.
  PagerType.POST_ALL_DOCS, // Required: Pager type
  paginationParams // Required: pagination configuration params are fixed at pagination creation time
);

// Option: iterate rows with for await...of statement
(async () => {
  for await (const row of pagination.rows()) {
    // Do something with row
  }
})();
// Note: Alternatively to for await....of the iterator protocol functions and properties:
// `next()`, `done`, value`, can be also used on rows().
// As `next(`)` returns with a Promise, make sure using `await` or `.then()` on it.

from ibmcloudant import Pager, Pagination, PagerType
from ibmcloudant.cloudant_v1 import CloudantV1

# Initialize service
service = CloudantV1.new_instance()

# Setup options
opts = {
    'db': 'orders',  # example database name
    'limit': 50,  # limit option sets the page size,
    'start_key':  'abc' # start from example doc ID abc
}

# Create pagination
pagination = Pagination.new_pagination(
    service, PagerType.POST_ALL_DOCS, **opts)
# pagination can be reused without side-effects as a factory for iterables or pagers
# options are fixed at pagination creation time

# Option: iterate rows
# Ideal for using a for loop with each row.
# Each call to rows() returns a fresh iterator that can be traversed once.
for row in pagination.rows():
    # Do something with row
    pass

import (
	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/cloudant-go-sdk/features"
)

// Initialize service
service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
	&cloudantv1.CloudantV1Options{},
)
if err != nil {
	panic(err)
}

// Setup options
opts := service.NewPostAllDocsOptions("orders")
opts.SetLimit(50)
opts.SetStartKey("abc")

// Create pagination
// pagination can be reused without side-effects as a factory for iterators or pagers
// options are fixed at pagination creation time
pagination := features.NewAllDocsPagination(service, opts)

// Option: iterate rows
// Ideal for using a for/range loop with each row.
// The iter.Seq2 returned from Rows() has an error as a second element.
for row, err := range pagination.Rows() {
	// Break on err != nil
	// Do something with row
}

# get first page of fulfilled orders
curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_design/allClients/_view/getStatus?limit=3&start_key=\"fulfilled\"&end_key=\"fulfilled\""

{
  "total_rows": 10,
  "offset": 2,
  "rows": [
    {
      "id": "order00057",
      "key": "fulfilled",
      "value": 1
    },
    {
      "id": "order00058",
      "key": "fulfilled",
      "value": 1
    },
    {
      "id": "order00067", // <-- append \u0000 to the start_key_doc_id to of the next request
      "key": "fulfilled",
      "value": 1
    }
  ]
}

# get next page of fulfilled orders
curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud//orders/_design/allClients/_view/getStatus?limit=3&start_key=\"fulfilled\"&end_key=\"fulfilled\"&start_key_doc_id=order00067%00"

{
  "total_rows": 10,
  "offset": 5,
  "rows": [
    {
      "id": "order00077",
      "key": "fulfilled",
      "value": 1
    }
  ]
}

import java.util.List;
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ViewResultRow;
import com.ibm.cloud.cloudant.v1.model.PostViewOptions;
import com.ibm.cloud.cloudant.features.pagination.Pager;
import com.ibm.cloud.cloudant.features.pagination.Pagination;

// Initialize service
Cloudant service = Cloudant.newInstance();

// Setup options
PostViewOptions options = new PostViewOptions.Builder()
  .db("shoppers") // example database name
  .limit(50) // limit option sets the page size
  .ddoc("allUsers") // use the allUsers design document
  .view("getVerifiedEmails") // the view to use
  .build();

// Create pagination
Pagination<PostViewOptions, ViewResultRow> pagination = Pagination.newPagination(service, options);
// pagination can be reused without side-effects as a factory for iterables, streams or pagers
// options are fixed at pagination creation time

// Option: iterate rows
// Ideal for using an enhanced for loop with each row.
// The Iterable returned from rows() is reusable in that
// calling iterator() returns a new iterator each time.
// The returned iterators, however, are single use.
for (ViewResultRow row : pagination.rows()) {
  // Do something with row
}

import { CloudantV1, Pagination, PagerType } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises';

// Initialize service
const client = CloudantV1.newInstance();

// Setup params
const paginationParams = {
  db: 'shoppers', // Required: the database name.
  limit: 50, // Optional: limit parameter sets the page size. Default and max is 200.
  ddoc: 'allUsers', // use the allUsers design document
  view: 'getVerifiedEmails', // the view to use
};

// Create pagination
// pagination can be reused without side-effects as a factory for async iterables, streams or pagers
const pagination = Pagination.newPagination(
  client, // Required: the Cloudant service client instance.
  PagerType.POST_VIEW, // Required: Pager type
  paginationParams // Required: pagination configuration params are fixed at pagination creation time
);

// Option: iterate rows with for await...of statement
(async () => {
  for await (const row of pagination.rows()) {
    // Do something with row
  }
})();
// Note: Alternatively to for await....of the iterator protocol functions and properties:
// `next()`, `done`, value`, can be also used on rows().
// As `next(`)` returns with a Promise, make sure using `await` or `.then()` on it.

from ibmcloudant import Pager, Pagination, PagerType
from ibmcloudant.cloudant_v1 import CloudantV1

# Initialize service
service = CloudantV1.new_instance()

# Setup options
opts = {
    'db': 'shoppers',  # example database name
    'limit': 50,  # limit option sets the page size
    'ddoc': 'allUsers',  # use the allUsers design document
    'view': 'getVerifiedEmails' # the view to use
}

# Create pagination
pagination = Pagination.new_pagination(
    service, PagerType.POST_VIEW, **opts)
# pagination can be reused without side-effects as a factory for iterables or pagers
# options are fixed at pagination creation time

# Option: iterate rows
# Ideal for using a for loop with each row.
# Each call to rows() returns a fresh iterator that can be traversed once.
for row in pagination.rows():
    # Do something with row
    pass

import (
	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/cloudant-go-sdk/features"
)

// Initialize service
service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
	&cloudantv1.CloudantV1Options{},
)
if err != nil {
	panic(err)
}

// Setup options
opts := service.NewPostViewOptions("shoppers", "allUsers", "getVerifiedEmails")
opts.SetLimit(50)

// Create pagination
// pagination can be reused without side-effects as a factory for iterators or pagers
// options are fixed at pagination creation time
pagination := features.NewViewPagination(service, opts)

// Option: iterate rows
// Ideal for using a for/range loop with each row.
// The iter.Seq2 returned from Rows() has an error as a second element.
for row, err := range pagination.Rows() {
	// Break on err != nil
	// Do something with row
}

curl -X POST      -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"      -H 'Content-type: application/json'      -d '{"selector":{"country":{"$eq": "US"}},"limit":5}'      "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/cities/_find"

{
  "docs":[
    {"_id":"10104153","_rev":"1-32aab6258c65c5fc5af044a153f4b994","name":"Silver Lake","latitude":34.08668,"longitude":-118.27023,"country":"US","population":32890,"timezone":"America/Los_Angeles"},
    {"_id":"10104154","_rev":"1-125f589bf4e39d8e119b4b7b5b18caf6","name":"Echo Park","latitude":34.07808,"longitude":-118.26066,"country":"US","population":43832,"timezone":"America/Los_Angeles"},
    {"_id":"4046704","_rev":"1-2e4b7820872f108c077dab73614067da","name":"Fort Hunt","latitude":38.73289,"longitude":-77.05803,"country":"US","population":16045,"timezone":"America/New_York"},
    {"_id":"4048023","_rev":"1-744baaba02218fd84b350e8982c0b783","name":"Bessemer","latitude":33.40178,"longitude":-86.95444,"country":"US","population":27456,"timezone":"America/Chicago"},
    {"_id":"4048662","_rev":"1-e95c97013ece566b37583e451c1864ee","name":"Paducah","latitude":37.08339,"longitude":-88.60005,"country":"US","population":25024,"timezone":"America/Chicago"}
  ],
  "bookmark": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"
}

curl -X POST      -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"      -H 'Content-type: application/json'      -d '{"selector":{"country":{"$eq": "US"}},"limit":5,"bookmark":"g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"}'      "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/cities/_find"

{
  "docs":[
    {"_id":"4049979","_rev":"1-1fa2591477c774a07c230571568aeb66","name":"Birmingham","latitude":33.52066,"longitude":-86.80249,"country":"US","population":212237,"timezone":"America/Chicago"},
    {"_id":"4054378","_rev":"1-a750085697685e7bc0e49d103d2de59d","name":"Center Point","latitude":33.64566,"longitude":-86.6836,"country":"US","population":16921,"timezone":"America/Chicago"},
    {"_id":"4058219","_rev":"1-9b4eb183c9cdf57c19be660ec600330c","name":"Daphne","latitude":30.60353,"longitude":-87.9036,"country":"US","population":21570,"timezone":"America/Chicago"},
    {"_id":"4058553","_rev":"1-56100f7e7742028facfcc50ab6b07a04","name":"Decatur","latitude":34.60593,"longitude":-86.98334,"country":"US","population":55683,"timezone":"America/Chicago"},
    {"_id":"4059102","_rev":"1-612ae37d982dc71eeecf332c1e1c16aa","name":"Dothan","latitude":31.22323,"longitude":-85.39049,"country":"US","population":65496,"timezone":"America/Chicago"}
  ],
  "bookmark": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWhoaGIGkOWDSyBJZAO9qD40"
}

import java.util.Collections;
import java.util.List;
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Document;
import com.ibm.cloud.cloudant.v1.model.PostFindOptions;
import com.ibm.cloud.cloudant.features.pagination.Pager;
import com.ibm.cloud.cloudant.features.pagination.Pagination;

// Initialize service
Cloudant service = Cloudant.newInstance();

// Setup options
PostFindOptions options = new PostFindOptions.Builder()
  .db("shoppers") // Database name
  .limit(50) // limit option sets the page size
  .fields(List.of("_id", "type", "name", "email")) // return these fields
  .selector(Collections.singletonMap("email_verified", "true")) // select docs with verified emails
  .sort(Collections.singletonList(Collections.singletonMap("email", "desc"))) // sort descending by email
  .build();

// Create pagination
Pagination<PostFindOptions, Document> pagination = Pagination.newPagination(service, options);
// pagination can be reused without side-effects as a factory for iterables, streams or pagers
// options are fixed at pagination creation time

// Option: iterate rows
// Ideal for using an enhanced for loop with each row.
// The Iterable returned from rows() is reusable in that
// calling iterator() returns a new iterator each time.
// The returned iterators, however, are single use.
for (Document row : pagination.rows()) {
  // Do something with row
}

import { CloudantV1, Pagination, PagerType } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises';

// Initialize service
const client = CloudantV1.newInstance();

// Setup params
const paginationParams = {
  db: 'shoppers', // Required: the database name.
  limit: 50, // Optional: limit parameter sets the page size. Default and max is 200.
  fields: ['_id', 'type', 'name', 'email'], // return these fields
  selector: { email_verified: { '$eq': true } }, // select docs with verified emails
  sort: [{ email: 'desc' }],
};

// Create pagination
// pagination can be reused without side-effects as a factory for async iterables, streams or pagers
const pagination = Pagination.newPagination(
  client, // Required: the Cloudant service client instance.
  PagerType.POST_FIND, // Required: Pager type
  paginationParams // Required: pagination configuration params are fixed at pagination creation time
);

// Option: iterate rows with for await...of statement
(async () => {
  for await (const row of pagination.rows()) {
    // Do something with row
  }
})();
// Note: Alternatively to for await....of the iterator protocol functions and properties:
// `next()`, `done`, value`, can be also used on rows().
// As `next(`)` returns with a Promise, make sure using `await` or `.then()` on it.

from ibmcloudant import Pager, Pagination, PagerType
from ibmcloudant.cloudant_v1 import CloudantV1

# Initialize service
service = CloudantV1.new_instance()

# Setup options
opts = {
    'db': 'shoppers',  # example database name
    'limit': 50,  # limit option sets the page size
    'fields': ['_id', 'type', 'name', 'email'],  # return these fields
    'selector': {'email_verified': True},  # select docs with verified emails
    'sort': [{'email': 'desc'}]  # sort descending by email
}

# Create pagination
pagination = Pagination.new_pagination(
    service, PagerType.POST_FIND, **opts)
# pagination can be reused without side-effects as a factory for iterables or pagers
# options are fixed at pagination creation time

# Option: iterate rows
# Ideal for using a for loop with each row.
# Each call to rows() returns a fresh iterator that can be traversed once.
for row in pagination.rows():
    # Do something with row
    pass

import (
	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/cloudant-go-sdk/features"
)

// Initialize service
service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
	&cloudantv1.CloudantV1Options{},
)
if err != nil {
	panic(err)
}

// Setup options
opts := service.NewPostFindOptions("shoppers", map[string]any{"email_verified": true})
opts.SetLimit(50)
opts.SetFields([]string["_id", "type", "name", "email"])
opts.SetSort([]map[string]string{map[string]string{"email": "desc"}})

// Create pagination
// pagination can be reused without side-effects as a factory for iterators or pagers
// options are fixed at pagination creation time
pagination := features.NewFindPagination(service, opts)

// Option: iterate rows
// Ideal for using a for/range loop with each row.
// The iter.Seq2 returned from Rows() has an error as a second element.
for row, err := range pagination.Rows() {
	// Break on err != nil
	// Do something with row
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/cities/_search/search/_search/freetext?q=country:US&limit=5"

{
  "total_rows": 65,
  "rows":[
    {"_id":"10104153","_rev":"1-32aab6258c65c5fc5af044a153f4b994","name":"Silver Lake","latitude":34.08668,"longitude":-118.27023,"country":"US","population":32890,"timezone":"America/Los_Angeles"},
    {"_id":"10104154","_rev":"1-125f589bf4e39d8e119b4b7b5b18caf6","name":"Echo Park","latitude":34.07808,"longitude":-118.26066,"country":"US","population":43832,"timezone":"America/Los_Angeles"},
    {"_id":"4046704","_rev":"1-2e4b7820872f108c077dab73614067da","name":"Fort Hunt","latitude":38.73289,"longitude":-77.05803,"country":"US","population":16045,"timezone":"America/New_York"},
    {"_id":"4048023","_rev":"1-744baaba02218fd84b350e8982c0b783","name":"Bessemer","latitude":33.40178,"longitude":-86.95444,"country":"US","population":27456,"timezone":"America/Chicago"},
    {"_id":"4048662","_rev":"1-e95c97013ece566b37583e451c1864ee","name":"Paducah","latitude":37.08339,"longitude":-88.60005,"country":"US","population":25024,"timezone":"America/Chicago"}
  ],
  "bookmark": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/cities/_search/search/_search/freetext?q=country:US&limit=5&bookmark=g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"

{
  "total_rows": 65,
  "rows":[
    {"_id":"4049979","_rev":"1-1fa2591477c774a07c230571568aeb66","name":"Birmingham","latitude":33.52066,"longitude":-86.80249,"country":"US","population":212237,"timezone":"America/Chicago"},
    {"_id":"4054378","_rev":"1-a750085697685e7bc0e49d103d2de59d","name":"Center Point","latitude":33.64566,"longitude":-86.6836,"country":"US","population":16921,"timezone":"America/Chicago"},
    {"_id":"4058219","_rev":"1-9b4eb183c9cdf57c19be660ec600330c","name":"Daphne","latitude":30.60353,"longitude":-87.9036,"country":"US","population":21570,"timezone":"America/Chicago"},
    {"_id":"4058553","_rev":"1-56100f7e7742028facfcc50ab6b07a04","name":"Decatur","latitude":34.60593,"longitude":-86.98334,"country":"US","population":55683,"timezone":"America/Chicago"},
    {"_id":"4059102","_rev":"1-612ae37d982dc71eeecf332c1e1c16aa","name":"Dothan","latitude":31.22323,"longitude":-85.39049,"country":"US","population":65496,"timezone":"America/Chicago"}
  ],
  "bookmark": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWhoaGIGkOWDSyBJZAO9qD40",
}

import java.util.List;
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.SearchResultRow;
import com.ibm.cloud.cloudant.v1.model.PostSearchOptions;
import com.ibm.cloud.cloudant.features.pagination.Pager;
import com.ibm.cloud.cloudant.features.pagination.Pagination;

// Initialize service
Cloudant service = Cloudant.newInstance();

// Setup options
PostSearchOptions options = new PostSearchOptions.Builder()
  .db("shoppers") // example database name
  .limit(50) // limit option sets the page size
  .ddoc("allUsers") // use the allUsers design document
  .index("activeUsers") // search in this index
  .query("name:Jane* AND active:True") // Lucene search query
  .build();

// Create pagination
Pagination<PostSearchOptions, SearchResultRow> pagination = Pagination.newPagination(service, options);
// pagination can be reused without side-effects as a factory for iterables, streams or pagers
// options are fixed at pagination creation time

// Option: iterate rows
// Ideal for using an enhanced for loop with each row.
// The Iterable returned from rows() is reusable in that
// calling iterator() returns a new iterator each time.
// The returned iterators, however, are single use.
for (SearchResultRow row : pagination.rows()) {
  // Do something with row
}

import { CloudantV1, Pagination, PagerType } from '@ibm-cloud/cloudant';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises';

// Initialize service
const client = CloudantV1.newInstance();

// Setup params
const paginationParams = {
  db: 'shoppers', // Required: the database name.
  limit: 50, // Optional: limit parameter sets the page size. Default and max is 200.
  ddoc: 'allUsers', // use the allUsers design document
  index: 'activeUsers', // search in this index
  query: 'name:Jane* AND active:True', // Lucene search query
};

// Create pagination
// pagination can be reused without side-effects as a factory for async iterables, streams or pagers
const pagination = Pagination.newPagination(
  client, // Required: the Cloudant service client instance.
  PagerType.POST_SEARCH, // Required: Pager type
  paginationParams // Required: pagination configuration params are fixed at pagination creation time
);

// Option: iterate rows with for await...of statement
(async () => {
  for await (const row of pagination.rows()) {
    // Do something with row
  }
})();
// Note: Alternatively to for await....of the iterator protocol functions and properties:
// `next()`, `done`, value`, can be also used on rows().
// As `next(`)` returns with a Promise, make sure using `await` or `.then()` on it.

from ibmcloudant import Pager, Pagination, PagerType
from ibmcloudant.cloudant_v1 import CloudantV1

# Initialize service
service = CloudantV1.new_instance()

# Setup options
opts = {
    'db': 'shoppers',  # example database name
    'limit': 50,  # limit option sets the page size
    'ddoc': 'allUsers',  # use the allUsers design document
    'index': 'activeUsers',  # search in this index
    'query': 'name:Jane* AND active:True'  # Lucene search query
}

# Create pagination
pagination = Pagination.new_pagination(
    service, PagerType.POST_SEARCH, **opts)
# pagination can be reused without side-effects as a factory for iterables or pagers
# options are fixed at pagination creation time

# Option: iterate rows
# Ideal for using a for loop with each row.
# Each call to rows() returns a fresh iterator that can be traversed once.
for row in pagination.rows():
    # Do something with row
    pass

import (
	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/cloudant-go-sdk/features"
)

// Initialize service
service, err := cloudantv1.NewCloudantV1UsingExternalConfig(
	&cloudantv1.CloudantV1Options{},
)
if err != nil {
	panic(err)
}

// Setup options
opts := service.NewPostSearchOptions("shoppers", "allUsers", "activeUsers", "name:Jane* AND active:True")
opts.SetLimit(50)

// Create pagination
// pagination can be reused without side-effects as a factory for iterators or pagers
// options are fixed at pagination creation time
pagination := features.NewSearchPagination(service, opts)

// Option: iterate rows
// Ideal for using a for/range loop with each row.
// The iter.Seq2 returned from Rows() has an error as a second element.
for row, err := range pagination.Rows() {
	// Break on err != nil
	// Do something with row
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -X GET "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_changes?limit=5" -H "Content-Type: application/json"

{
    "results": [
        {"seq": "1-g1AAAA...", "id": "4eee973603bf77f30b1f880ed83df76a", "changes": [{"rev": "1-9d0c2..."}]},
        {"seq": "2-g1AAAA...", "id": "4eee973603bf77f30b1f880ed83f469a", "changes": [{"rev": "1-b1f67..."}]},
        ...
    ],
    "last_seq": "6-g1AAAA...",  // <-- This is the sequence we use as the since parameter of the next request
    "pending": 2998
}

curl -H "Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" -X GET "https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/orders/_changes?limit=5&since=6-g1AAAA..." -H "Content-Type: application/json"

{
    "results": [
        {"seq": "6-g1AAAA...", "id": "65fa623a384648740ec1f39b495d591c", "changes": [{"rev": "1-00203..."}]},
        {"seq": "7-g1AAAA...", "id": "d7404903579d6d5880514c22ad983529", "changes": [{"rev": "1-9410b..."}]},
        ...
    ],
    "last_seq": "10-g1AAAA...",
    "pending": 2993
}

import java.util.stream.Stream;
import com.ibm.cloud.cloudant.features.ChangesFollower;
import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Change;
import com.ibm.cloud.cloudant.v1.model.ChangesResultItem;
import com.ibm.cloud.cloudant.v1.model.PostChangesOptions;

public class StartOneOffAndProcess {
    public static void main(String[] args) {

        Cloudant client = Cloudant.newInstance();

        // Start from a perviously persisted seq
        // Normally this would be read by the app from persistent storage
        // e.g. String previouslyPersistedSeq = yourAppPersistenceReadFunction();
        String previouslyPersistedSeq = "3-g1AG3...";
        PostChangesOptions options = new PostChangesOptions.Builder("example")
            .since(previouslyPersistedSeq)
            .build();
        ChangesFollower changesFollower = new ChangesFollower(client, options);
        Stream<ChangesResultItem> changesItems = changesFollower.startOneOff();
        changesItems.forEach(changesItem -> {
            // do something with changes
            System.out.println(changesItem.getId());
            for (Change change : changesItem.getChanges()) {
                System.out.println(change.getRev());
            }
            // when change item processing is complete app can store seq
            String seq = changesItem.getSeq();
            // write seq to persistent storage for use as since if required to resume later
            // e.g. call yourAppPersistenceWriteFunction(seq);
        });
        // Note: java.util.Stream terminal operations are blocking, code here will be unreachable
        // until all changes are processed (or another stop condition is reached).
    }
}

const client = CloudantV1.newInstance();
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams = {
  db: 'example',
  since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.startOneOff();

const destinationStream = new Writable({
  objectMode: true,
  write(changesItem, _, callback) {
    // do something with change item
    console.log(changesItem.id);
    for (const change of changesItem.changes) {
      console.log(change.rev);
    }
    // when change item processing is complete app can store seq
    const seq = changesItem.seq;
    // write seq to persistent storage for use as since if required to resume later
    // e.g. yourAppPersistenceWriteFunc()
    callback();
  }
});

pipeline(changesItemsStream, destinationStream)
  .then(() => {
    console.log('All changes done');
  })
  .catch((err) => {
    console.log(err);
  });

// use for-async-loop feature for stream
/*
getChangesFromFollower(changesItemsStream);
async function getChangesFromFollower(changesItemsStream) {
  for await (const changesItem of changesItemsStream) {
    // do something with change item
    // write seq to persistent storage for use as since
    console.log(changesItem.id);
    for (const change of changesItem.changes) {
      console.log(change.rev);
    }
    // when change item processing is complete app can store seq
    seq = changesItem.seq;
    // write seq to persistent storage for use as since if required to resume later
    // e.g. yourAppPersistenceWriteFunc();
  }
}
*/

import ChangesFollower
from ibmcloudant.cloudant_v1 import CloudantV1

client = CloudantV1.new_instance()

# Start from a previously persisted seq
# Normally this would be read by the app from persistent storage
# e.g. previously_persisted_seq = your_app_persistence_read_func()
previously_persisted_seq = '3-g1AG3...'
changes_follower = ChangesFollower(
    service=client,
    **{'db': 'example', 'since': previously_persisted_seq})

changes_items = changes_follower.start_one_off()
for changes_item in changes_items:
    # do something with changes
    print(changes_item.id)
    for change in changes_item.changes:
        print(change.rev)
    # when change item processing is complete app can store seq
    seq = changes_item.seq
    # write seq to persistent storage for use as since if required to resume later
    # e.g. your_app_persistence_write_func(seq)

# Note: iterator above is blocking, code here will be unreachable
# until all changes are processed (or another stop condition is reached).

package main

import (
	"fmt"

	"github.com/IBM/cloudant-go-sdk/cloudantv1"
	"github.com/IBM/cloudant-go-sdk/features"
)

func main() {
	client, err := cloudantv1.NewCloudantV1UsingExternalConfig(
		&cloudantv1.CloudantV1Options{},
	)
	if err != nil {
		panic(err)
	}

	postChangesOptions := client.NewPostChangesOptions("example")

	// Start from a previously persisted seq
	// Normally this would be read by the app from persistent storage
	// e.g. prevSeq = yourAppPersistenceReadFunc()
	prevSeq := "3-g1AG3..."
	postChangesOptions.SetSince(prevSeq)

	follower, err := features.NewChangesFollower(client, postChangesOptions)
	if err != nil {
		panic(err)
	}

	changesCh, err := follower.StartOneOff()
	if err != nil {
		panic(err)
	}

	for changesItem := range changesCh {
		// changes item structure returns an error on failed requests
		item, err := changesItem.Item()
		if err != nil {
			panic(err)
		}

		// do something with changes
		fmt.Printf("%s\n", *item.ID)
		for _, change := range item.Changes {
			fmt.Printf("%s\n", *change.Rev)
		}

		// when change item processing is complete app can store seq
		seq := *item.Seq
		// write seq to persistent storage for use as since if required
		// to resume later, e.g. yourAppPersistenceWriteFunc(seq)
	}

	// Note: iterating the returned channel above is blocking, code here
	// will be unreachable until all changes are processed
	// or another stop condition is reached.
}

// Enable Debug logging
core.SetLoggingLevel(core.LevelDebug)

import java.util.logging.Logger;
import java.util.logging.ConsoleHandler;
import com.ibm.cloud.sdk.core.http.HttpConfigOptions;

// Set logger on core with FINE level
Logger sdkLogger = Logger.getLogger("com.ibm.cloud.sdk.core");
sdkLogger.setLevel(Level.FINE);

// Configure the logging output to the standard error stream with FINE level
ConsoleHandler handler = new ConsoleHandler();
handler.setLevel(Level.FINE);

// Set the HTTP logging level to BASIC
HttpConfigOptions options =
    new HttpConfigOptions.Builder()
        .loggingLevel(HttpConfigOptions.LoggingLevel.BASIC)
    .build();

service.configureClient(options);

import debug from 'debug'

// Enable debug logs on ibm-cloud-sdk-core and error logs on @ibm-cloud/cloudant packages
debug.enable('ibm-cloud-sdk-core:debug,cloudant-node-sdk:error');

// You must use dynamic imports (`await import(...)`) for monitored packages
// to ensure they load only after debug has been enabled.
const { CloudantV1 } = await import('@ibm-cloud/cloudant');
const { BasicAuthenticator } = await import('ibm-cloud-sdk-core');

import logging

# Enable DEBUG logging level which writes with a handler that display messages on the console
logging.basicConfig(level=logging.DEBUG)

// Enable custom file logger
type FileLogger struct {
	logLevel core.LogLevel // use log levels defined in core
	logFile *os.File
}
func NewFileLogger(level core.LogLevel, filename string) *FileLogger {
	logFile, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err != nil {
        log.Fatalf("Failed to open log file: %v", err)
    }
	return &FileLogger{
		logLevel: level,
		logFile: logFile,
	}
}

// Implement the Log function of FileLogger from the Logger interface
func (l *FileLogger) Log(level core.LogLevel, format string, inserts ...interface{}) {
	if l.IsLogLevelEnabled(level) {
		logger := log.New(l.logFile, "", log.LstdFlags)
		logger.Printf(format, inserts...)
	}
}

// Implement all the other functions from the Logger interface for FileLogger
// func (l *FileLogger) Error(format string, inserts ...interface{}) { ... }
// func (l *FileLogger) Warn(format string, inserts ...interface{}) { ... }
// func (l *FileLogger) Info(format string, inserts ...interface{}) { ... }
// func (l *FileLogger) Debug(format string, inserts ...interface{}) { ... }
// func (l *FileLogger) SetLogLevel(level core.LogLevel) { ... }
// func (l *FileLogger) GetLogLevel() core.LogLevel { ... }
// func (l *FileLogger) IsLogLevelEnabled(level core.LogLevel) bool { ... }

// Create a new file logger with debug level
yourLogger := NewFileLogger(core.LevelDebug, "your_log_file.log")
core.SetLogger(yourLogger)

import java.util.logging.Logger;
import java.util.logging.FileHandler;
import com.ibm.cloud.sdk.core.http.HttpConfigOptions;

// Set logger on core with FINE level
Logger sdkLogger = Logger.getLogger("com.ibm.cloud.sdk.core");
sdkLogger.setLevel(Level.FINE);

// Use FileHandler if the target of logging is a file
FileHandler handler = new FileHandler("your_log_file.log")
handler.setLevel(Level.FINE);

// Set the HTTP logging level to BODY
HttpConfigOptions options =
    new HttpConfigOptions.Builder()
        .loggingLevel(HttpConfigOptions.LoggingLevel.BODY)
    .build();

service.configureClient(options);

import fs from 'fs';
import debug from 'debug';

// Create a writable stream for the log file
const logStream = fs.createWriteStream('./your_log_file.log', { flags: 'a' });
// Namespace for all kind of logs on ibm-cloud-sdk-core package
const namespace = 'ibm-cloud-sdk-core*';

// Override global log method of the debug package
Object.getPrototypeOf(debug(namespace)).log = (...args) => {
    logStream.write(args.join(' ') + '\n');
};
// Enable namespace
debug.enable(namespace);

// You must use dynamic imports (`await import(...)`) for monitored packages
// to ensure they load only after debug has been enabled.
const { CloudantV1 } = await import('@ibm-cloud/cloudant');
const { BasicAuthenticator } = await import('ibm-cloud-sdk-core');

import logging

# Enable DEBUG logging level and use filename parameter when the target of logging is a file
logging.basicConfig(level=logging.DEBUG, filename='your_log_file.log')