*Introduction:*
Elasticsearch is a distributed, open source search and analytics engine,
designed for horizontal scalability, reliability, and easy management. The
elasticsearch REST APIs are exposed using JSON over HTTP.

*API Document*:
https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
*Technology*: REST
*Version*: 1.0
*Connector Name*: elasticsearch-connector-1.0.0
*Authentication*: Basic authentication based on username/password

*Methods Selected:*

*Document API*:
*Index API*:
createDocumentWithIndex: Creates or update documente with given index
createAutomaticIndex: Creates given index
createAutomaticId: The index operation can be executed without specifying
the id. In such a       case, an id will be generated automatically.
routeDocument: Routes the document in to shared base
indexChildDocument: Sets child document index   

*GET API*
getDocument: Gets the typed JSON document from the index based on its id

*Delete API*
deleteDocument: The delete API allows to delete a typed JSON document from a
specific index based on its id.

*Update API*
updatedDocument: Update a document based on a script provided
        
*Multi Get API*
getDocuments: Gets multiple documents based on an index, type and id

*Bulk API*
performBulkOperatioin: Performs many index/delete operations in a single API
call    

*Search API*

*Search*
searchDocumentsByIndex: Search on all documents across all types within the
given index
searchDocumentByTypes: Search all documents with in indexes and types
searchByQuery: Search across all indices and all types
multiSearch: Execute several search requests within the same API

Following method are omitted due to low business value and most of them
could be only used for reporting purposes.

*Method Omitted:*

*CAT API*
getAliaseDetails: Shows information about currently configured aliases
getAllocationDetails: Provides a snapshot of how shards have located around
the cluster and the state of disk usage
getCountOfAnIndice: Provides quick access to the document count of an
individual indices.
getTotalCount: Provides the total count of entire cluster.
getFieldData: Shows information about currently loaded fielddata on a
per-node basis.
getIndicesDetails: Provides entire details about indices.
getIndiceDetails        : Provides entire details about a single indice.
getPendingTasks: Provides information about pending tasks.
getSegmentDetails: Provides low level information about the segments in the
shards of an index

*Indices API*

createIndex: can set mappings, warmers, aliases, creation date
deleteIndex: The delete index API allows to delete an existing index
deleteAllIndexes: Delete all indexes
getIndex: The get index API allows to retrieve information about one or more
indexes.
existIndex: Used to check if the index exists or not
changeIndexStatus: Allows to close/open index
addMapping: API allows to register specific mapping definition for a
specific type.
getMapping: Get more than one index or type mapping with a single call
getFieldMapping: Retrieves mapping definitions for one or more fields
isTypeExist: Checks if a type/types exists in an index/indices.
deleteMapping: Deletes a mapping (type) along with its data. 
associateAliasesIndex: Allows to alias an index with a name, with all APIs
automatically converting the alias name to the actual index name
createAlias: Add/Delete alias with the endpoint
getAlias        : Retreive alias
optimize: optimize one or more indices

Thank you,
Sajitha




--
View this message in context: 
http://wso2-oxygen-tank.10903.n7.nabble.com/Connector-Elasticsearch-V1-0-tp125083.html
Sent from the WSO2 Architecture mailing list archive at Nabble.com.
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to