Index

Abstract Value Members

abstract def /(type: String): Index[JsonR]
abstract def bulk[D](publisher: Publisher[Bulk[D]], batchSize: Int)(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Publisher[BulkResponse[JsonR]]

Bulk operation for the current index see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
Bulk operation for the current index see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
D
the type of the document
publisher
a org.reactivestreams.Publisher (see reactive streams) of elastic.api.Bulk
batchSize
the size of the packet of bulk operations to send to elastic
sWrites
json to string conversion
docWriter
document to json object conversion
bulkOpWriter
elastic.api.Bulk to json object conversion
sReader
string to json object conversion
bReader
json object to elastic.api.BulkResponse conversion
ec
ExecutionContext for future execution
returns
a org.reactivestreams.Publisher (see reactive streams) of elastic.api.BulkResponse
abstract def bulkFlow[D](batchSize: Int)(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Flow[Bulk[D], BulkResponse[JsonR], NotUsed]

A akka stream flow to bulk datas.
A akka stream flow to bulk datas.
D
the type of the document
batchSize
the size of the packet of bulk operations to send to elastic
sWrites
json to string conversion
docWriter
document to json object conversion
bulkOpWriter
elastic.api.Bulk to json object conversion
sReader
string to json object conversion
bReader
json object to elastic.api.BulkResponse conversion
ec
ExecutionContext for future execution
returns
a akka.stream.scaladsl.Flow that ingest elastic.api.Bulk and out elastic.api.BulkResponse
abstract def delete(id: String, refresh: Boolean = false, routing: Option[String] = None)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

Delete a document by its id.
Delete a document by its id.
id
of the document
sReader
string to json object conversion
jsonReader
json object to elastic.api.IndexResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.IndexResponse object
abstract def delete(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexOps], ec: ExecutionContext): Future[IndexOps]

Delete index operation
Delete index operation
sReader
string to json object conversion
jsonReader
a json object to elastic.api.IndexOps conversion
ec
ExecutionContext for future execution
abstract def get(id: String, routing: Option[String] = None, fields: Seq[String] = Seq(), _source: Boolean = true)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, GetResponse[JsonR]], ec: ExecutionContext): Future[GetResponse[JsonR]]

Get a document by id
Get a document by id
id
id of the document
routing
the routing key
fields
a scala.Seq of fields to filter the source
_source
if false, the source is ignored
sReader
string to json object conversion
jsonReader
json object to elastic.api.GetResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.GetResponse
abstract def index[D](data: D, id: Option[String] = None, version: Option[Int] = None, versionType: Option[VersionType] = None, create: Boolean = false, routing: Option[String] = None, parent: Option[String] = None, refresh: Boolean = false, timeout: Option[String] = None, consistency: Option[Consistency] = None, detectNoop: Boolean = false)(implicit writer: Writer[D, JsonR], strWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

Index operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
Index operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
D
the type of the document
data
document to index
id
optional id of the document
version
current version of the document
versionType
type of the version
create
if true an excpetion is thrown if the document allready exists
routing
routing key
parent
parent id if there is a parent child relation
refresh
if true, the index will be refresh
timeout
a timeout
consistency
consistency level ALL, QUORUM, ONE
detectNoop
detect if the version should be increase
writer
document to json object conversion
strWriter
json object to string conversion
sReader
string to json object conversion
jsonReader
json object to elastic.api.IndexResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.IndexResponse
abstract def mget(request: MGets)(implicit sWriter: Writer[JsonR, String], jsonWriter: Writer[MGets, JsonR], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, MGetResponse[JsonR]], ec: ExecutionContext): Future[MGetResponse[JsonR]]

Multiple get operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
Multiple get operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
request
multiple get request : elastic.api.MGets
sWriter
json to string conversion
jsonWriter
elastic.api.MGets to json object conversion
sReader
string to json object conversion
jsonReader
json object to elastic.api.MGetResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.MGetResponse response
abstract def oneBulk[D](bulk: Seq[Bulk[D]])(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Future[BulkResponse[JsonR]]

A atomic bulk opération see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
A atomic bulk opération see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
D
the type of the document
bulk
a Seq of elastic.api.Bulk to send in bulk
sWrites
json to string conversion
docWriter
document to json object conversion
bulkOpWriter
elastic.api.Bulk to json object conversion
sReader
string to json object conversion
bReader
json object to elastic.api.BulkResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.BulkResponse
abstract def scroll[Q](query: Q, scroll: String = "1m", size: Int = 20)(implicit qWrites: Writer[Q, String], jsonWriter: Writer[Scroll, JsonR], sWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Source[SearchResponse[JsonR], NotUsed]

The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result.
The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result. All the result of the search are returned in an asynchronous stream.
Q
the query object type
query
the query to execute
qWrites
Query to json object conversion
sReader
string to json conversion
jsonReader
json string to json object conversion
ec
ExecutionContext for future execution
returns
a org.reactivestreams.Publisher (see reactive streams) of elastic.api.SearchResponse
abstract def scrollPublisher[Q](query: Q, scroll: String = "1m", size: Int = 20)(implicit qWrites: Writer[Q, String], jsonWriter: Writer[Scroll, JsonR], sWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Publisher[SearchResponse[JsonR]]

The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result.
The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result. All the result of the search are returned in an asynchronous stream.
Q
the query object type
query
the query to execute
qWrites
Query to json object conversion
sReader
string to json conversion
jsonReader
json string to json object conversion
ec
ExecutionContext for future execution
returns
a org.reactivestreams.Publisher (see reactive streams) of elastic.api.SearchResponse
abstract def search[Q](query: Q)(implicit qWrites: Writer[Q, String], sReads: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Future[SearchResponse[JsonR]]

Search operation on this index.
Search operation on this index.
Q
type of the query object
query
the search query object
qWrites
query to json object conversion
sReads
string to json object conversion
jsonReader
json object to elastic.api.SearchResponse conversion
ec
ExecutionContext for future execution
returns
a elastic.api.SearchResponse
abstract def update[D](data: D, id: String, version: Option[Int] = None, versionType: Option[VersionType] = None, retry_on_conflict: Option[Int] = None, routing: Option[String] = None, parent: Option[String] = None, timeout: Option[String] = None, refresh: Boolean = false, wait_for_active_shards: Option[Boolean] = None)(implicit writer: Writer[D, JsonR], strWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

Update operation : index operation with create = false and id required.
Update operation : index operation with create = false and id required.
D
the type of the document
data
document to index
id
id of the document
version
current version of the document
versionType
type of the version
routing
routing key
parent
parent id if there is a parent child relation
timeout
a timeout
refresh
if true, the index will be refresh
writer
document to json object conversion
strWriter
json object to string conversion
sReader
string to json object conversion
jsonReader
json object to elastic.api.IndexResponse conversion
returns
a elastic.api.IndexResponse

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package api

trait Index[JsonR] extends AnyRef

Abstract Value Members

abstract def /(type: String): Index[JsonR]

abstract def bulkFlow[D](batchSize: Int)(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Flow[Bulk[D], BulkResponse[JsonR], NotUsed]

abstract def delete(id: String, refresh: Boolean = false, routing: Option[String] = None)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

abstract def delete(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexOps], ec: ExecutionContext): Future[IndexOps]

abstract def get(id: String, routing: Option[String] = None, fields: Seq[String] = Seq(), _source: Boolean = true)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, GetResponse[JsonR]], ec: ExecutionContext): Future[GetResponse[JsonR]]

abstract def mget(request: MGets)(implicit sWriter: Writer[JsonR, String], jsonWriter: Writer[MGets, JsonR], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, MGetResponse[JsonR]], ec: ExecutionContext): Future[MGetResponse[JsonR]]

abstract def oneBulk[D](bulk: Seq[Bulk[D]])(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Future[BulkResponse[JsonR]]

abstract def search[Q](query: Q)(implicit qWrites: Writer[Q, String], sReads: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Future[SearchResponse[JsonR]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped