ESSimpleStorage

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def byDocumentId(docIndex: String, docType: String, docId: UUID): Option[JValue]

   

   Loads a document by it's documentId.

   Loads a document by it's documentId. This allows us to load a document before Elasticsearch has finished indexing it.

   docIndex

   name of the ElasticSearch index

   docType

   name of the type of document

   docId

   unique Id per Document as UUID

   Definition Classes

   ESStorageBase

6. def byDocumentId(docIndex: String, docType: String, docId: String): Option[JValue]

   

   Loads a document by it's documentId.

   Loads a document by it's documentId. This allows us to load a document before Elasticsearch has finished indexing it.

   docIndex

   name of the ElasticSearch index

   docType

   name of the type of document

   docId

   unique Id per Document

   Definition Classes

   ESStorageBase

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def connectivityCheck(docIndex: String = "foo", docType: String = "bar"): Future[DeepCheckResponse]

   

   Query an index for a single record to test connectivity to Elasticsearch.

   Query an index for a single record to test connectivity to Elasticsearch.

   docIndex

   index to query

   docType

   type to query

   returns

   result of connectivity check

   Definition Classes

   ESStorageBase

9. def deleteDoc(docIndex: String, docType: String, docId: String): Future[Boolean]

   

   removes a document from it's index

   removes a document from it's index

   docIndex

   name of the index

   docType

   name of the doc type

   docId

   unique id

   Definition Classes

   ESStorageBase

10. implicit val ec: ExecutionContext

    

    Definition Classes

    ESStorageBase

11. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. val esClient: TransportClient

    

    Attributes

    protected

    Definition Classes

    ESSimpleStorage → ESStorageBase

14. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

15. implicit val formats: Formats

    

    Definition Classes

    ESStorageBase

16. def getAverage(docIndex: String, docType: String, query: Option[QueryBuilder] = None, agg: AvgAggregationBuilder): Future[Option[Double]]

    
    docIndex

    name of the ElasticSearch index

    docType

    name of the type of document

    query

    search query as created with org.elasticsearch.index.query.QueryBuilders

    agg

    average function

    Definition Classes

    ESStorageBase

17. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

18. def getCurrentEsClient: TransportClient

    

    returns current ElasticSearch Transport Client instance

    returns current ElasticSearch Transport Client instance

    returns

    esClient as TransportClient

    Definition Classes

    ESStorageBase

19. def getDoc(docIndex: String, docType: String, docId: String): Future[Option[JValue]]

    
    docIndex

    name of the ElasticSearch index

    docType

    name of the type of document

    docId

    unique Id per Document

    Definition Classes

    ESStorageBase

20. def getDocs(docIndex: String, docType: String, query: Option[QueryBuilder] = None, from: Option[Int] = None, size: Option[Int] = None, sort: Option[SortBuilder[_]] = None): Future[List[JValue]]

    
    docIndex

    name of the ElasticSearch index

    docType

    name of the type of document

    query

    search query as created with org.elasticsearch.index.query.QueryBuilders

    from

    pagination from

    size

    maximum number of results

    sort

    optional result sort

    Definition Classes

    ESStorageBase

21. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

22. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

23. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    StrictLogging → Logging

24. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

25. final def notify(): Unit

    

    Definition Classes

    AnyRef

26. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

27. def storeDoc(docIndex: String, docType: String, doc: JValue, docIdOpt: Option[String] = None): Future[JValue]

    
    docIndex

    name of the index into which the current document should be stored

    docType

    name of the current documents type

    doc

    document as a JValue which should be stored

    docIdOpt

    unique id which identifies current document uniquely inside the index

    Definition Classes

    ESStorageBase

28. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

29. def toString(): String

    

    Definition Classes

    AnyRef → Any

30. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )