avokka.arangodb.ArangoQuery.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avokka-arangodb_2.12 Show documentation
ArangoDB core
The newest version!
package avokka.arangodb

import avokka.arangodb.models.{Cursor, Query, Transaction}
import avokka.arangodb.protocol.{ArangoClient, ArangoResponse}
import avokka.arangodb.types.{DatabaseName, TransactionId}
import avokka.velocypack.{VPackDecoder, VPackEncoder}
import cats.Functor
import cats.syntax.functor._

/**
  * AQL query to be executed
  *
  * @tparam F effect
  * @tparam V bind vars
  */
trait ArangoQuery[F[_], V] {

  /**
    * modify query
    * @param f update function
    * @return modified query
    */
  def withQuery(f: Query[V] => Query[V]): ArangoQuery[F, V]

  def batchSize(value: Long): ArangoQuery[F, V] = withQuery(_.copy(batchSize = Some(value)))
  def count(value: Boolean): ArangoQuery[F, V] = withQuery(_.copy(count = Some(value)))
  def transaction(id: TransactionId): ArangoQuery[F, V]

  /**
    * execute the query
    * @tparam T result document
    * @return response
    */
  def execute[T: VPackDecoder]: F[ArangoResponse[Cursor[T]]]

  /**
    * execute the query
    * @tparam T result document
    * @return cursor
    */
  def cursor[T: VPackDecoder]: F[ArangoCursor[F, T]]

  /**
    * execute the query with streaming handler
    * @param S arango stream implementation
    * @tparam T result document
    * @return stream instance
    */
  def stream[T: VPackDecoder](implicit S: ArangoStream[F]): S.S[F, T]
}

object ArangoQuery {

  case class Options(
                      transaction: Option[TransactionId] = None,
                    )

  def apply[F[_]: ArangoClient : Functor, V: VPackEncoder](
      database: DatabaseName,
      query: Query[V],
      options: Options = Options()
  ): ArangoQuery[F, V] = new ArangoQuery[F, V] {

    override def withQuery(f: Query[V] => Query[V]): ArangoQuery[F, V] = apply(database, f(query), options)

    override def transaction(id: TransactionId): ArangoQuery[F, V] = apply(database, query, options.copy(transaction = Some(id)))

    override def execute[T: VPackDecoder]: F[ArangoResponse[Cursor[T]]] =
      POST(
        database,
        "/_api/cursor",
        meta = Map(
          Transaction.KEY -> options.transaction.map(_.repr)
        ).collectDefined
      ).body(query).execute

    override def cursor[T: VPackDecoder]: F[ArangoCursor[F, T]] = execute.map { resp =>
      ArangoCursor(database, resp, options)
    }

    override def stream[T: VPackDecoder](implicit S: ArangoStream[F]): S.S[F, T] = S.fromQuery(this)

  }

}