net.sf.jkniv.whinstone.couchdb.commands

Class BulkCommand

java.lang.Object

net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

net.sf.jkniv.whinstone.couchdb.commands.BulkCommand

All Implemented Interfaces:

Command, CouchCommand

public class BulkCommand
extends AbstractCommand
implements CouchCommand

 
 http://docs.couchdb.org/en/2.2.0/api/database/bulk-api.html
 
  POST /{db}/_bulk_docs

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

  Request Headers:
      
      
    - Accept 
      + application/json
      +  text/plain
    - Content-Type – application/json
    - X-Couch-Full-Commit – Overrides server’s commit policy. Possible values are: false and true. Optional

 
  Request JSON Object:
  
     - docs (array) – List of documents objects
     - new_edits (boolean) – If false, prevents the database from assigning them new revision IDs. Default is true. Optional
     

  Response Headers:
      

      Content-Type
        + application/json
        + text/plain; charset=utf-8

  Response JSON Array of Objects:
      
      
      - id (string) – Document ID
      - rev (string) – New document revision token. Available if document has saved without errors. Optional
      - error (string) – Error type. Optional
      - reason (string) – Error reason. Optional

  Status Codes:   
 
     201 Created – Document(s) have been created or updated
     400 Bad Request – The request provided invalid JSON data
     417 Expectation Failed – Occurs when at least one document was rejected by a validation function
 

Since:

0.6.0

Author:

Alisson Gomes

Field Summary

Fields inherited from class net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

body, commandHandler, handlerException, method, url

Fields inherited from interface net.sf.jkniv.whinstone.couchdb.commands.CouchCommand

HTTP_ACCEPTED, HTTP_BAD_REQUEST, HTTP_CREATED, HTTP_EXPECTATION_FAILED, HTTP_NO_CONTENT, HTTP_NOT_FOUND, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_RESET_CONTENT

Constructor Summary

Constructors

Constructor and Description
BulkCommand(HttpBuilder httpBuilder, Queryable queryable)

Method Summary

Modifier and Type	Method and Description
HttpMethod	asPost()
HttpMethod	asPut()
<T> T	execute() Execute the database statement could be a Command or a Query
String	getBody()

Methods inherited from class net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

asDelete, asGet, asHead, errorFormat, getContentEncode, getContentType, getEntity, getRevision, injectAutoIdentity, injectIdentity, isAccepted, isCreated, isExpectationFailed, isNotFound, isOk, printRequest, printResponse, setBookmark, with, with, with

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jkniv.whinstone.couchdb.commands.CouchCommand

asDelete, asGet, asHead

Methods inherited from interface net.sf.jkniv.whinstone.commands.Command

with, with, with

Constructor Detail

BulkCommand

public BulkCommand(HttpBuilder httpBuilder,
                   Queryable queryable)

Method Detail

execute

public <T> T execute()

Description copied from interface: Command

Execute the database statement could be a Command or a Query

Specified by:

execute in interface Command

Type Parameters:

T - Generic type of return, example: rows affected by a command or list of objects.

Returns:

the result of the statement execution

getBody

public String getBody()

Specified by:

getBody in interface CouchCommand

asPut

public HttpMethod asPut()

Specified by:

asPut in interface CouchCommand

Overrides:

asPut in class AbstractCommand

asPost

public HttpMethod asPost()

Specified by:

asPost in interface CouchCommand

Overrides:

asPost in class AbstractCommand