FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, review the migration guide. Contact support@fauna.com with any questions.

Scala

This section is intended to help Scala developers get started using the Fauna Scala driver for application development.

Current version and repository location

Current stable version

4.3.0

Repository

fauna/faunadb-jvm

Dependencies

  • Scala 2.11.x

  • Scala 2.12.x

  • Jackson for JSON parsing.

Installation

faunadb-scala/sbt:
libraryDependencies += ("com.faunadb" %% "faunadb-scala" % "4.3.0")

Example application

The following example code runs a bare-bones Scala application which creates a new document in a

collection called People.

Prerequisites

  • A Fauna account. If you don’t have one, see the dashboard quick start for help getting set up.

  • A supported version of Scala and the Fauna Scala driver.

  • sbt, version 1.4 or higher.

Procedure

  1. Navigate to the Fauna Dashboard

    Log in to your Fauna account at Fauna Dashboard if you’re not already logged in.

  2. Create a new database

    Click NEW DATABASE and select your Region Group.

  3. Create a new collection

    Click NEW COLLECTION. Name your new collection People and save it.

  4. Create an access key

    Click SECURITY in the left-side navigation menu. Create a new key for your database. Be sure to save the key’s secret in a safe place, as it is only displayed once.

  5. Create a local environment variable with your access key’s secret

    On MacOS and Linux systems, enter the following in a terminal window:

    export FAUNADB_SECRET=<your-secret>

    For Windows systems, enter the following in a terminal window:

    set FAUNADB_SECRET=<your secret>

    For either example, replace <your secret> with the secret for the access key that you created.

  6. Create a project folder using the standard directory layout

    In a terminal window, in an empty folder, run the following command:

    sbt new scala/hello-world.g8

    When prompted, name the project example.

    Then enter the folder:

    cd example

  7. Edit the build.sbt file

    With your preferred editor, replace the contents of the build.sbt file with the following:

    ThisBuild / scalaVersion := "2.12.15"
ThisBuild / version := "0.1.0"
ThisBuild / organization := "com.example"
ThisBuild / organizationName := "example"
ThisBuild / showSuccess := false

lazy val root = (project in file("."))
  .settings(
    name := "example",
    libraryDependencies += "org.slf4j" % "slf4j-nop" % "1.7.28",
    libraryDependencies += "com.faunadb" %% "faunadb-scala" % "4.3.0"
  )

  8. Create a local application file

    With your preferred editor, replace the contents of the src/main/scala/Main.scala file with the following code:

  9. Compile and run the application

    sbt run

    You should see results similar to this:

    If you get an error, check to make sure that the secret for your access key is correct.

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!