cbelasticsearch

Interface iNativeClient

cbelasticsearch.iNativeClient
All Known Implementing Classes:
JestClient

Elasticsearch Native Client Interface

Class Attributes:
  • singleton : true
  •  
  • license : Apache v2.0
  •  
  • package : cbElasticsearch.models
  •  
  • author : Jon Clausen
  •  
    Method Summary
    boolean applyIndex(IndexBuilder indexBuilder)
         Applies an index item ( create/update ).
    struct applyMapping(string indexName, string mappingName, struct mappingConfig)
         Applies a single mapping to an index.
    struct applyMappings(string indexName, struct mappings)
         Applies multiple mappings to an index.
    void close()
         Closes any connections to the pool and destroys the client singleton.
    boolean delete(any document, [boolean throwOnError])
         Deletes a single document.
    any deleteAll(array documents, [boolean throwOnError])
         Deletes documents from an array of documents or IDs.
    boolean deleteByQuery(SearchBuilder searchBuilder)
         Deletes items in the index by query.
    struct deleteIndex(string indexName)
         Deletes an index.
    boolean deleteMapping(string indexName, string mapping, [boolean throwOnError])
         Deletes a mapping.
    SearchResult executeSearch(SearchBuilder searchBuilder)
         Execute a client search request.
    any get(any id, [string index], [string type])
         Retrieves a document by ID.
    array getMultiple(array keys, [string index], [string type])
         Gets multiple items when provided an array of keys.
    boolean indexExists(string indexName)
         Verifies whether an index exists.
    boolean indexMappingExists(string indexName, string mapping)
         Verifies whether an index mapping exists.
    Document save(Document document)
    array saveAll(array documents)
         Persists multiple items to the index.
    boolean updateByQuery(SearchBuilder searchBuilder, struct script)
         Updates items in the index by query.

    Method Detail

    applyIndex

    public boolean applyIndex(IndexBuilder indexBuilder)

    Applies an index item ( create/update )

    Parameters:
    indexBuilder - IndexBuilder An instance of the IndexBuilder object
    Returns:
    struct A struct representation of the transaction result

    applyMapping

    public struct applyMapping(string indexName, string mappingName, struct mappingConfig)

    Applies a single mapping to an index

    Parameters:
    indexName - string the name of the index
    mappingName - string the name of the mapping
    mappingConfig - struct the mapping configuration struct

    applyMappings

    public struct applyMappings(string indexName, struct mappings)

    Applies multiple mappings to an index

    Parameters:
    indexName - string The name of the index
    mappings - struct a struct containing the mapping configuration

    close

    public void close()

    Closes any connections to the pool and destroys the client singleton


    delete

    public boolean delete(any document, [boolean throwOnError])

    Deletes a single document

    Parameters:
    document - Document the Document object for the document to be deleted
    throwOnError - boolean whether to throw an error if the document cannot be deleted ( default: false )

    deleteAll

    public any deleteAll(array documents, [boolean throwOnError])

    Deletes documents from an array of documents or IDs

    Parameters:
    documents - array Either an array of Document objects
    throwOnError - boolean whether to throw an error if the document cannot be deleted ( default: false )

    deleteByQuery

    public boolean deleteByQuery(SearchBuilder searchBuilder)

    Deletes items in the index by query

    Parameters:
    searchBuilder - SearchBuilder The search builder object to use for the query

    deleteIndex

    public struct deleteIndex(string indexName)

    Deletes an index

    Parameters:
    indexName - string the name of the index to be deleted

    deleteMapping

    public boolean deleteMapping(string indexName, string mapping, [boolean throwOnError])

    Deletes a mapping

    Parameters:
    indexName - string the name of the index which contains the mapping
    mapping - string the mapping ( e.g. type ) to delete
    throwOnError - boolean Whether to throw an error if the mapping could not be deleted ( default=false )
    Returns:
    struct the deletion transaction response

    executeSearch

    public SearchResult executeSearch(SearchBuilder searchBuilder)

    Execute a client search request

    Parameters:
    searchBuilder - SearchBuilder An instance of the SearchBuilder object
    Returns:
    iNativeClient An implementation of the iNativeClient

    get

    public any get(any id, [string index], [string type])

    Retrieves a document by ID

    Parameters:
    id - any The document key
    index - string The name of the index
    type - type The name of the type
    Returns:
    any Returns a Document object if found, otherwise returns null

    getMultiple

    public array getMultiple(array keys, [string index], [string type])

    Gets multiple items when provided an array of keys

    Parameters:
    keys - array An array of keys to retrieve
    index - string The name of the index
    type - type The name of the type
    Returns:
    array An array of Document objects

    indexExists

    public boolean indexExists(string indexName)

    Verifies whether an index exists

    Parameters:
    indexName - string the name of the index

    indexMappingExists

    public boolean indexMappingExists(string indexName, string mapping)

    Verifies whether an index mapping exists

    Parameters:
    indexName - string the name of the index
    mapping - string the name of the mapping

    save

    public Document save(Document document)

    Parameters:
    document - Document@cbElasticSearch An instance of the elasticsearch Document object
    Returns:
    iNativeClient An implementation of the iNativeClient

    saveAll

    public array saveAll(array documents)

    Persists multiple items to the index

    Parameters:
    documents - array An array of elasticsearch Document objects to persist
    Returns:
    array An array of results for the saved items

    updateByQuery

    public boolean updateByQuery(SearchBuilder searchBuilder, struct script)

    Updates items in the index by query

    Parameters:
    searchBuilder - SearchBuilder The search builder object to use for the query
    script - struct script to process on the query