avokka.arangodb.ArangoIndex.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 models._
import avokka.arangodb.types.DatabaseName
import protocol._

/**
  * Arango index API
  *
  * @tparam F effect
  * @see [[https://www.arangodb.com/docs/stable/http/indexes-working-with.html]]
  */
trait ArangoIndex[F[_]] {
  def id: String
  def read(): F[ArangoResponse[Index]]
  def delete(): F[ArangoResponse[DeleteResult]]
}

object ArangoIndex {
  def apply[F[_]: ArangoClient](database: DatabaseName, _id: String): ArangoIndex[F] = new ArangoIndex[F] {

    override val id: String = _id

    private val path: String = "/_api/index/" + id

    override def read(): F[ArangoResponse[Index]] =
      GET(database, path).execute

    override def delete(): F[ArangoResponse[DeleteResult]] =
      DELETE(database, path).execute

  }
}