Packages

class DBFind extends AnyRef

Service class responsible for entity search

Annotations
@Singleton()
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DBFind
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DBFind(configuration: Configuration, db: DBConfiguration, ec: ExecutionContext, mat: Materializer)
    Annotations
    @Inject()
  2. new DBFind(pageSize: Int, keepAlive: FiniteDuration, db: DBConfiguration, ec: ExecutionContext, mat: Materializer)

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. def apply(query: (String) ⇒ SearchRequest): Future[SearchResponse]

    Execute the search definition This function is used to run aggregations

  5. def apply(range: Option[String], sortBy: Seq[String])(query: (String) ⇒ SearchRequest): (Source[JsObject, NotUsed], Future[Long])

    Search entities in ElasticSearch

    Search entities in ElasticSearch

    range

    first and last entities to retrieve, for example "23-42" (default value is "0-10")

    sortBy

    define order of the entities by specifying field names used in sort. Fields can be prefixed by "-" for descendant or "+" for ascendant sort (ascendant by default).

    query

    a function that build a SearchRequest using the index name

    returns

    Source (akka stream) of JsObject. The source is materialized as future of long that contains the total number of entities.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. implicit val ec: ExecutionContext
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getOffsetAndLimitFromRange(range: Option[String]): (Int, Int)

    Extract offset and limit from optional range Range has the following format : "start-end" If format is invalid of range is None, this function returns (0, 10)

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val keepAliveStr: String
  17. implicit val mat: Materializer
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def searchWithScroll(searchRequest: SearchRequest, offset: Int, limit: Int): (Source[SearchHit, NotUsed], Future[Long])

    Execute the search definition using scroll

  22. def searchWithoutScroll(searchRequest: SearchRequest, offset: Int, limit: Int): (Source[SearchHit, NotUsed], Future[Long])

    Execute the search definition

  23. def switchTo(otherDB: DBConfiguration): DBFind

    return a new instance of DBFind but using another DBConfiguration

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped