Quickstart with the Scala API client

1
2
3
4
5
client.execute { from index "index" objectId "myId" }

// or

client.execute { get / "index" / "myId" }

1
2
3
4
val future: Future[Search] =
    client.execute {
        search into "index" query "a"
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
case class Contact(firstname: String,
                   lastname: String,
                   followers: Int,
                   company: String)

val future: Future[Seq[Contact]] =
    client
        .execute {
            search into "index" query "a"
        }
        .map { search =>
            search.as[Contact]
        }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
case class EnhanceContact(firstname: String,
                          lastname: String,
                          followers: Int,
                          company: String,
                          objectID: String,
                          _highlightResult: Option[Map[String, HighlightResult]],
                          _snippetResult: Option[Map[String, SnippetResult]],
                          _rankingInfo: Option[RankingInfo]) extends Hit

val future: Future[Seq[EnhanceContact]] =
    client
        .execute {
            search into "index" query "a"
        }
        .map { search =>
            search.asHit[EnhanceContact]
        }

1
2
3
client.execute {
    index into "contacts" `object` Contact("Jimmie", "Barninger", 93, "California Paint")
}

1
2
// The index doesn't need to be initialized
val client = new AlgoliaClient("YourApplicationID", "YourWriteAPIKey")

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// For the DSL
import algolia.AlgoliaDsl._

// For basic Future support, you might want to change this by your own ExecutionContext
import scala.concurrent.ExecutionContext.Implicits.global

// case class of your objects
case class Contact(firstname: String,
                   lastname: String,
                   followers: Int,
                   compagny: String)

val indexing1: Future[Indexing] = client.execute {
    index into "contacts" `object` Contact("Jimmie", "Barninger", 93, "California Paint")
}

val indexing2: Future[Indexing] = client.execute {
    index into "contacts" `object` Contact("Warren", "Speach", 42, "Norwalk Crmc")
}

1
2
3
4
5
client.execute {
    setSettings of "myIndex" `with` IndexSettings(
        customRanking = Some(Seq(CustomRanking.desc("followers")))
    )
}

1
2
3
4
5
client.execute {
    setSettings of "myIndex" `with` IndexSettings(
        searchableAttributes = Some(Seq("lastname", "firstname", "company"))
    )
}

1
2
3
4
5
6
7
8
9
10
11
// Search for a first name
client.execute { search into "contacts" query Query(query = Some("jimmie")) }

// Search for a first name with typo
client.execute { search into "contacts" query Query(query = Some("jimie")) }

// Search for a company
client.execute { search into "contacts" query Query(query = Some("california paint")) }

// Search for a first name and a company
client.execute { search into "contacts" query Query(query = Some("jimmie paint")) }