Class export=

Delete an attachment.

Deletes the attachment with the filename, {attachment_name}, from the specified doc. You must supply the rev query parameter or If-Match header with the current revision to delete the attachment.

Returns

Delete a database.

Deletes the specified database and all documents and attachments contained within it. To avoid deleting a database, the server responds with a 400 HTTP status code when the request URL includes a ?rev= parameter. This response suggests that a user wanted to delete a document but forgot to add the document ID to the URL.

Returns

Delete a design document.

Marks the specified design document as deleted by adding a _deleted field with the value true. Documents with this field are not returned with requests but stay in the database. You must supply the current (latest) revision, either by using the rev parameter or by using the If-Match header to specify the revision.

Returns

Delete a document.

Marks the specified document as deleted by adding a _deleted field with the value true. Documents with this field are not returned within requests anymore but stay in the database. You must supply the current (latest) revision, either by using the rev parameter or by using the If-Match header to specify the revision.

Returns

Delete an index.

Returns

Delete a local document.

Deletes the specified local document. The semantics are identical to deleting a standard document in the specified database, except that the document is not replicated.

Returns

Cancel a replication.

Cancels a replication by deleting the document that describes it from the _replicator database.

Returns

Retrieve list of running tasks.

Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the currently running tasks, with each task described as a single object. Depending on the operation type, the set of response object fields might be different.

Returns

Retrieve Activity Tracker events information.

Check event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.

Returns

Query a list of all database names in the instance.

Returns

Retrieve an attachment.

Returns the file attachment that is associated with the document. The raw data of the associated attachment is returned, just as if you were accessing a static file. The returned Content-Type header is the same as the content type set when the document attachment was submitted to the database.

Returns

Retrieve provisioned throughput capacity information.

View the amount of provisioned throughput capacity that is allocated to an IBM Cloudant instance and what is the target provisioned throughput capacity.

Returns

Retrieve CORS configuration information.

Lists all Cross-origin resource sharing (CORS) configuration. CORS defines a way in which the browser and the server interact to determine whether or not to allow the request.

Returns

Retrieve the current provisioned throughput capacity consumption.

View the current consumption of provisioned throughput capacity for an IBM Cloudant instance. The current consumption shows the quantities of reads, writes, and global queries conducted against the instance for a given second.

Returns

Retrieve information about a database.

Returns

Retrieve change events for all databases.

Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order and might repeat changes. Polling modes for this method work like polling modes for the changes feed. Note: This endpoint requires _admin or _db_updates role and is only available on dedicated clusters..

Returns

Retrieve a design document.

Returns design document with the specified doc_id from the specified database. Unless you request a specific revision, the current revision of the design document is always returned.

Returns

Retrieve information about a design document.

Retrieves information about the specified design document, including the index, index size, and current status of the design document and associated index information.

Returns

Retrieve a document.

Returns document with the specified doc_id from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

Returns

Retrieve a document as mixed.

Returns document with the specified doc_id from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

Returns

Retrieve a document as related.

Returns document with the specified doc_id from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

Returns

Retrieve a document as stream.

Returns document with the specified doc_id from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.

Returns

Retrieve shard information for a specific document.

Retrieves information about a specific shard where a particular document is stored, along with information about the nodes where that shard has a replica.

Returns

Retrieve information about all indexes.

When you make a GET request to /db/_index, you get a list of all indexes used by Cloudant Query in the database, including the primary index. In addition to the information available through this API, indexes are also stored in the indexes property of design documents.

Returns

Retrieve a local document.

Retrieves the specified local document. The semantics are identical to accessing a standard document in the specified database, except that the document is not replicated.

Returns

Retrieve cluster membership information.

Displays the nodes that are part of the cluster as cluster_nodes. The field, all_nodes, displays all nodes this node knows about, including the ones that are part of the cluster. This endpoint is useful when you set up a cluster.

Returns

Retrieve information about a database partition.

Given a partition key, return the database name, sizes, partition, doc count, and doc delete count.

Returns

Retrieve a replication document.

Retrieves a replication document from the _replicator database to view the configuration of the replication. The status of the replication is no longer recorded in the document but can be checked via the replication scheduler.

Returns

Retrieve replication scheduler documents.

Lists replication documents, including information about all documents, even the ones in a completed or failed state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and other information.

Returns

Retrieve a replication scheduler document.

Retrieves information about a replication document from the replicator database. The endpoint returns the document ID, database, replication ID, source and target, and other information.

Returns

Retrieve a replication scheduler job.

Retrieves the state of a single replication task based on its replication ID.

Returns

Retrieve replication scheduler jobs.

Retrieves information about replications that were created via /_replicate endpoint, as well as those created from replication documents. It doesn't include replications that completed or failed to start because replication documents were malformed. Each job description includes source and target information, replication ID, history of recent events, and other information.

Returns

Retrieve information about a search index.

Retrieve search index metadata information, such as the size of the index on disk.

Returns

Retrieve database permissions information.

See who has permission to read, write, and manage the database. The credentials you use to log in to the dashboard automatically include _admin permissions to all databases you create. Everyone and everything else, including users you share databases with and API keys you create, must be given a permission level explicitly.

Returns

Retrieve server instance information.

When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response includes a JSON structure that contains information about the server, including a welcome message and the server's version.

Tip: The authentication for this endpoint is only enforced when using IAM.

Returns

Retrieve current session cookie information.

Retrieves information about the authenticated user's session.

Returns

Retrieve shard information.

List each shard range and the corresponding replicas for a specified database.

Returns

Retrieve information about whether the server is up.

Confirms that the server is up, running, and ready to respond to requests. If maintenance_mode is true or nolb, the endpoint returns a 404 response.

Tip: The authentication for this endpoint is only enforced when using IAM.

Returns

Retrieve one or more UUIDs.

Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that provides a list of UUIDs.

Tip: The authentication for this endpoint is only enforced when using IAM.

Returns

Retrieve the HTTP headers for an attachment.

Returns the HTTP headers that contain a minimal amount of information about the specified attachment. This method supports the same query arguments as the GET /{db}/{doc_id}/{attachment_name} method, but only the header information (including attachment size, encoding, and the MD5 hash as an ETag), is returned.

Returns

Retrieve the HTTP headers for a database.

Returns the HTTP headers that contain a minimal amount of information about the specified database. Since the response body is empty, using the HEAD method is a lightweight way to check if the database exists or not.

Returns

Retrieve the HTTP headers for a design document.

This method supports the same query arguments as the GET /{db}/_design/{ddoc} method, but the results include only the header information (including design document size, and the revision as an ETag). The ETag header shows the current revision for the requested design document, and if you requested the design document in full, the Content-Length specifies the length of the data. If you add any of the query arguments, then the resulting HTTP headers correspond to what is returned for the equivalent GET request.

Returns

Retrieve the HTTP headers for the document.

This method supports the same query arguments as the GET /{db}/{docid} method, but only the header information (including document size and the revision as an ETag) is returned. The ETag header shows the current revision for the requested document, and the Content-Length specifies the length of the data if the document was requested in full. Add any of the query arguments, then the resulting HTTP headers that correspond to it are returned.

Returns

Retrieve HTTP headers for a local document.

Retrieves the HTTP headers containing minimal amount of information about the specified local document. Since the response body is empty, using the HEAD method is a lightweight way to check if the local document exists or not.

Returns

Retrieve the HTTP headers for a replication document.

Retrieves the HTTP headers containing minimal amount of information about the specified replication document from the _replicator database. The method supports the same query arguments as the GET /_replicator/{doc_id} method, but only headers like content length and the revision (ETag header) are returned.

Returns

Retrieve HTTP headers for a replication scheduler document.

Retrieves the HTTP headers containing minimal amount of information about the specified replication scheduler document. Since the response body is empty, using the HEAD method is a lightweight way to check if the replication scheduler document exists or not.

Returns

Retrieve the HTTP headers for a replication scheduler job.

Returns the HTTP headers that contain a minimal amount of information about the specified replication task. Only the header information is returned.

Returns

Retrieve HTTP headers about whether the server is up.

Retrieves the HTTP headers about whether the server is up.

Returns

Modify Activity Tracker events configuration.

Configure event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.

Returns

Query a list of all documents in a database.

Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.

Returns

Query a list of all documents in a database as stream.

Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.

Returns

Multi-query the list of all documents in a database.

Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

Returns

Multi-query the list of all documents in a database as stream.

Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

Returns

Generates API keys for apps or persons to enable database access.

Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant account for that person or application. An API key is a randomly generated username and password. The key is given the wanted access permissions for a database.

Returns

Bulk modify multiple documents in a database.

The bulk document API allows you to create, update, and delete multiple documents at the same time within a single request. The basic operation is similar to creating, updating, or deleting a single document, except that you batch the document structure and information.

Returns

Bulk query revision information for multiple documents.

Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

Returns

Bulk query revision information for multiple documents as mixed.

Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

Returns

Bulk query revision information for multiple documents as related.

Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

Returns

Bulk query revision information for multiple documents as stream.

Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

Returns

Query the database document changes feed.

Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the filter query parameter because it allows one to pass more information to the filter.

Before using the changes feed we recommend reading the FAQs to understand the limitations and appropriate use cases.

Returns

Query the database document changes feed as stream.

Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the filter query parameter because it allows one to pass more information to the filter.

Before using the changes feed we recommend reading the FAQs to understand the limitations and appropriate use cases.

Returns

Query information about multiple databases.

This operation enables you to request information about multiple databases in a single request, instead of issuing multiple GET /{db} requests. It returns a list that contains an information object for each database specified in the request.

Returns

Query a list of all design documents in a database.

Queries the index of all design document IDs. The results matching the request body parameters are returned in a JSON object, including a list of matching design documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all design documents in the database are returned. Optionally, the design document content or additional metadata can be included in the response.

Returns

Multi-query the list of all design documents.

This operation runs multiple view queries of all design documents in the database. This operation enables you to request numerous queries in a single request, in place of multiple POST /{db}/_design_docs requests.

Returns

Create or modify a document in a database.

Creates or modifies a document in the specified database by using the supplied JSON document.

For creation, you may specify the document ID but you should not specify the revision. If you don't specify the document ID, then the server generates an ID for your document.

For modification, you must specify the document ID and a revision identifier in the JSON document.

If your document ID includes the _local/ or _design/ prefix, then this operation creates or modifies a local or a design document respectively.

Returns

Retrieve information about which index is used for a query.

Shows which index is being used by the query. Parameters are the same as the _find endpoint.

Returns

Query an index by using selector syntax.

Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the _index endpoint.

Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body will include a warning field recommending that an index is created.

Returns

Query an index by using selector syntax as stream.

Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the _index endpoint.

Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body will include a warning field recommending that an index is created.

Returns

Create a new index on a database.

Create a new index on a database.

Returns

Query a list of all documents in a database partition.

Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.

Returns

Query a list of all documents in a database partition as stream.

Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.

Returns

Query a database partition index by using selector syntax.

Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the _index endpoint.

Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not recommended because it has a noticeable performance impact causing a full scan of the partition with each request. In this case the response body will include a warning field recommending that an index is created.

Returns

Query a database partition index by using selector syntax as stream.

Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the _index endpoint.

Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not recommended because it has a noticeable performance impact causing a full scan of the partition with each request. In this case the response body will include a warning field recommending that an index is created.

Returns

Query a database partition search index.

Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index.

Returns

Query a database partition search index as stream.

Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index.

Returns

Query a database partition MapReduce view function.

Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} API.

Returns

Query a database partition MapReduce view function as stream.

Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} API.

Returns

Query the document revisions and possible ancestors missing from the database.

The replicator is the primary user of this operation. After receiving a set of new revision IDs from the source database, the replicator sends this set to the destination database's _revs_diff to find out which of them already exists there. It can then avoid fetching and sending already-known document bodies.

Returns

Query a search index.

Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a GET request.

Returns

Query tokenization of sample text.

Returns the results of analyzer tokenization of the provided sample text. This endpoint can be used for testing analyzer tokenization.

Returns

Query a search index as stream.

Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a GET request.

Returns

Query a MapReduce view.

This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a GET request.

Returns

Query a MapReduce view as stream.

This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a GET request.

Returns

Multi-query a MapReduce view.

This operation runs multiple specified view queries against the view function from the specified design document.

Returns

Multi-query a MapReduce view as stream.

This operation runs multiple specified view queries against the view function from the specified design document.

Returns

Create or modify an attachment.

Uploads the supplied content as an attachment to the specified document. The attachment name that you provide must be a URL encoded string. You must supply the Content-Type header, and for an existing document, you must also supply either the rev query argument or the If-Match HTTP header. If you omit the revision, a new, otherwise empty, document is created with the provided attachment, or a conflict occurs. If the uploaded attachment uses an existing attachment name in the remote database, it updates the corresponding stored content of the database. Since you must supply the revision information to add an attachment to the document, this serves as validation to update the existing attachment.

Returns

Update the target provisioned throughput capacity.

Sets the target provisioned throughput capacity for an IBM Cloudant instance. When target capacity is changed, the current capacity asynchronously changes to meet the target capacity.

Returns

Modify only Cloudant related database permissions.

Modify only Cloudant related permissions to database. Be careful: by removing an API key from the list, you remove the API key from the list of users that have access to the database.

The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the nobody user has the role _reader.

Returns

Modify CORS configuration.

Sets the CORS configuration. The configuration applies to all databases and all account level endpoints in your account.

Returns

Create a database.

Returns

Create or modify a design document.

The PUT method creates a new named design document, or creates a new revision of the existing design document.

Returns

Create or modify a document.

Creates or modifies a document in the specified database.

For creation, you must specify the document ID but you should not specify the revision.

For modification, you must specify the document ID and a revision identifier.

Returns

Create or modify a local document.

Stores the specified local document. The semantics are identical to storing a standard document in the specified database, except that the document is not replicated.

Returns

Create or modify a replication using a replication document.

Creates or modifies a document in the _replicator database to start a new replication or to edit an existing replication.

Returns

Modify database permissions.

Modify who has permission to read, write, or manage a database. This endpoint can be used to modify both Cloudant and CouchDB related permissions. Be careful: by removing a Cloudant API key, a member or an admin from the list of users that have access permissions, you remove it from the list of users that have access to the database.

The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the nobody user has the role _reader.

Returns

Constructs an instance of CloudantV1 with passed in options and external configuration.

Returns