Trait

com.ubirch.util.elasticsearch.client.binary.storage.base

ESStorageBase

Related Doc: package base

Permalink

trait ESStorageBase extends StrictLogging

Using the Elasticsearch TransportClient to access the database: https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html

author: derMicha since: 2016-10-06

Linear Supertypes
StrictLogging, Logging, AnyRef, Any
Known Subclasses
ESSimpleStorage
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ESStorageBase
  2. StrictLogging
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val esClient: TransportClient

    Permalink
    Attributes
    protected

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    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

  7. implicit val ec: ExecutionContext

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. implicit val formats: Formats

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def getCurrentEsClient: TransportClient

    Permalink

    returns current ElasticSearch Transport Client instance

    returns current ElasticSearch Transport Client instance

    returns

    esClient as TransportClient

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

    Permalink

    docIndex

    name of the ElasticSearch index

    docType

    name of the type of document

    docId

    unique Id per Document

  15. 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]]

    Permalink

    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

  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    StrictLogging → Logging

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

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def storeDoc(docIndex: String, docType: String, doc: JValue, ttl: Long = 0l, docIdOpt: Option[String] = None, timestamp: Option[String] = None): Future[JValue]

    Permalink

    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

    ttl

    sets the relative ttl value in milliseconds, a value of 0 means no ttl

    docIdOpt

    unique id which identifies current document uniquely inside the index

    timestamp

    name of timestamp attribute

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StrictLogging

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped