Skip to content
πŸ” Algolia Search API Client for Scala 2.11 & 2.12
Branch: master
Clone or download
Latest commit 14bcf16 Jun 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(md): Update contribution-related files Sep 3, 2018
project chore: Bump sbt-pgp plugin from 1.0.1 to 1.1.1 (only used to release … Jul 11, 2018
src fixed: replace expected hit in one search integration test Feb 14, 2019
.gitignore chore: List gpg.sbt file in the .gitignore [skip ci] Jul 11, 2018
.scalafmt.conf feat(query,indexsettings): Fix index settings & query types (#372) Mar 28, 2017
.travis.yml
CHANGELOG.md chore: Release version 1.32.0 [skip ci] Jan 8, 2019
CONTRIBUTING.md chore(md): Update contribution-related files (#475) Mar 21, 2018
LICENSE chore(md): Update contribution-related files Jul 12, 2018
MAINTAINERS.md
README.md Update README.md Jun 17, 2019
build.sbt chore: Release version 1.32.0 [skip ci] Jan 8, 2019
release.sh chore: Ensure sync of local/remote master branches during a release [… Jul 11, 2018

README.md

Algolia for Scala

The perfect starting point to integrate Algolia within your Scala project

Licence Licence Licence

Documentation β€’ Community Forum β€’ Stack Overflow β€’ Report a bug β€’ Support

✨ Features

  • Supports Scala 2.11 & 2.12
  • Asynchronous methods to target Algolia's API
  • Json as case class
  • DSL

πŸ’‘ Getting Started

WARNING: The JVM has an infinite cache on successful DNS resolution. As our hostnames points to multiple IPs, the load could be not evenly spread among our machines, and you might also target a dead machine.

You should change this TTL by setting the property networkaddress.cache.ttl. For example to set the cache to 60 seconds:

java.security.Security.setProperty("networkaddress.cache.ttl", "60");

For debug purposes you can enable debug logging on the API client. It's using slf4j so it should be compatible with most java loggers. The logger is named algoliasearch.

Install

With Maven, add the following dependency to your pom.xml file:

<dependency>
    <groupId>com.algolia</groupId>
    <artifactId>algoliasearch-scala_2.11</artifactId>
    <version>[1,)</version>
</dependency>

For snapshots, add the sonatype repository:

<repositories>
    <repository>
        <id>oss-sonatype</id>
        <name>oss-sonatype</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

If you're using sbt, add the following dependency to your build.sbt file:

libraryDependencies += "com.algolia" %% "algoliasearch-scala" % "[1,)"

For snapshots, add the sonatype repository:

resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Initialize the client

To start, you need to initialize the client. To do this, you need your Application ID and API Key. You can find both on your Algolia account.

// No initIndex
val client = new AlgoliaClient("YourApplicationID", "YourAPIKey")

Push data

// 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")
}

DSL

The main goal of this client is to provide a human-accessible and readable DSL for using AlgoliaSearch.

The entry point of the DSL is the algolia.AlgoliaDSL object. This DSL is used in the execute method of algolia.AlgoliaClient.

As we want to provide human-readable DSL, there's more than one way to use this DSL. For example, to get an object by its objectID:

client.execute { from index "index" objectId "myId" }

// or

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

Future

The execute method always returns a scala.concurrent.Future. Depending on the operation, it's parametrized by a case class. For example:

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

JSON as case class

Putting or getting objects from the API is wrapped into case class automatically with json4s.

If you want to get objects, search for them and unwrap the result:

case class Contact(firstname: String,
                   lastname: String,
                   followers: Int,
                   compagny: String)

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

If you want to get the full results (with _highlightResult, etc.):

case class EnhanceContact(firstname: String,
                          lastname: String,
                          followers: Int,
                          compagny: 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]
        }

For indexing documents, pass an instance of your case class to the DSL:

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

For full documentation, visit the Algolia Scala API Client.

πŸ“„ License

Algolia Scala API Client is an open-sourced software licensed under the MIT license.

You can’t perform that action at this time.