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. |
Client application quick start
Fauna supports drivers in several popular programming languages for programmatic management and manipulation of Fauna databases. To get started, complete the prerequisites and then select a language.
For a complete list of supported drivers, see Drivers. |
Prerequisites
To use a Fauna driver, you must have:
-
A Fauna account. Sign up at https://dashboard.fauna.com/register.
-
A database with an access key.
-
Sign up for a free account
Sign up at https://dashboard.fauna.com/register.
-
Create a database
Click NEW DATABASE and select the your Region Group.
-
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.
For a more detailed description of the signup and database creation steps, see the Dashboard quick start. |
When you’re ready with a database and an access key, select a language to get started with a driver.
Choose a language
C#
For complete C# driver information, see the driver page.
Go
For complete Go driver information, see the driver page.
Java
For complete Java driver information, see the driver page.
JavaScript
For complete JavaScript driver information, see the driver page.
Python
For complete Python driver information, see the driver page.
Scala
For complete Scala driver information, see the driver page.
-
Install the driver
-
On Windows system, install Visual Studio. On macOS or Linux, install Mono.
-
Install .Net Core 3.1.
-
Open a terminal window and navigate to the folder where the project should live.
-
Create the folder
example
, and the enter it. -
With your preferred text editor, create a new file called
example.csproj
. Add the following lines to the file:<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>netcoreapp3.1</TargetFramework> </PropertyGroup> <ItemGroup> <PackageReference Include="FaunaDB.Client" Version="4.1.0" /> </ItemGroup> </Project>
Enter the following at the command line:
go get github.com/fauna/faunadb-go/v4/faunadb
-
Install Maven for your system.
-
In a terminal window, navigate to the folder that should contain the Java project, then run the following command:
mvn archetype:generate \ -DgroupId=example \ -DartifactId=example \ -DarchetypeArtifactId=maven-archetype-quickstart \ -DinteractiveMode=false
-
Enter the
example
folder. -
Edit the
pom.xml
file so that it contains the following lines:<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>example</groupId> <artifactId>example</artifactId> <packaging>jar</packaging> <version>1.0-SNAPSHOT</version> <name>example</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> <dependency> <groupId>com.faunadb</groupId> <artifactId>faunadb-java</artifactId> <version>4.1.2</version> <scope>compile</scope> </dependency> </dependencies> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.7</maven.compiler.source> <maven.compiler.target>1.7</maven.compiler.target> </properties> <build> <plugins> <plugin> <!-- Build an executable JAR --> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.1.0</version> <configuration> <archive> <manifest> <addC\lasspath>true</addClasspath> <classpathPrefix>lib/</classpathPrefix> <mainC\lass>example.App</mainClass> </manifest> </archive> </configuration> </plugin> </plugins> </build> </project>
Enter the following at the command line:
npm install --save faunadb
Enter the following at the command line:
pip install faunadb
-
In a terminal window, navigate to the folder that should contain the Scala project, then run the following command:
sbt new scala/hello-world.g8
-
When prompted for a name, enter
example
. -
Enter the
example
folder. -
Edit the
build.sbt
file so that it contains the following lines:import sbt._ ThisBuild / scalaVersion := "2.12.8" ThisBuild / version := "0.1.0" ThisBuild / organization := "com.example" ThisBuild / organizationName := "example" lazy val root = (project in file(".")) .settings( name := "example", libraryDependencies += "org.slf4j" % "slf4j-nop" % "1.7.28", libraryDependencies += "com.faunadb" %% "faunadb-scala" % "{driver-jvm-version}" ) assemblyMergeStrategy in assembly := { case x if x.endsWith("io.netty.versions.properties") => MergeStrategy.discard case "module-info.class" => MergeStrategy.discard case x => val oldStrategy = (assemblyMergeStrategy in assembly).value oldStrategy(x) }
-
Edit the
project/assembly.scala
file so that it contains the following lines:addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.15.0")
-
-
Create a program file
With your preferred text editor, create a new file called
Program.cs
. We’ll use this file to run a Fauna query which creates a new collection namedmyCollection
.Add the following lines to your file:
With your preferred text editor, create a new file called
app.go
. We’ll use this file to run a Fauna query which creates a new collection namedmyCollection
.Add the following lines to your file:
With your preferred text editor, edit the
src/main/java/example/fauna/App.java
file. We’ll use this file to run a Fauna query which creates a new collection namedmyCollection
.Modify the file to contain the following lines:
With your preferred text editor, create a new file called
app.js
. We’ll use this file to run a Fauna query which creates a new collection namedmyCollection
.Add the following lines to your file:
With your preferred text editor, create a new file called
app.py
. We’ll use this file to run a Fauna query which creates a new collection calledmyCollection
.Add the following lines to your file:
With your preferred text editor, edit the
src/main/scala/Main.scala
file. We’ll use this file to run a Fauna query which creates a new collection namedmyCollection
.Modify the file to contain the following lines:
-
Run the program
Run the following command in a terminal window, in the directory where you created the program file. Be sure to replace
YOUR_FAUNA_SECRET
with the secret that you created at the beginning of this guide.Run the following command in a terminal window, in the directory where you created the project. Be sure to replace
YOUR_FAUNA_SECRET
with the secret that you created at the beginning of this guide.FAUNADB_SECRET=YOUR_FAUNA_SECRET dotnet run
FAUNADB_SECRET=YOUR_FAUNA_SECRET go run app.go
FAUNADB_SECRET=YOUR_FAUNA_SECRET mvn clean package \ && java -jar target/example-1.0-SNAPSHOT.jar
FAUNADB_SECRET=YOUR_FAUNA_SECRET node app.js
FAUNADB_SECRET=YOUR_FAUNA_SECRET python app.py
FAUNADB_SECRET=YOUR_FAUNA_SECRET sbt run
You should see the result of your
CreateCollection
query:{ ref: Collection("myCollection"), ts: 1633458045000000, history_days: 30, name: 'myCollection' }
{'ref': Ref(id=myCollection, collection=Ref(id=collections)), 'ts': 1633458048030000, 'history_days': 30, 'name': 'myCollection'}
map[history_days:30 name:myCollection ref:{myCollection 0xc0000924b0 0xc0000924b0 <nil>} ts:1633458042080000]
ObjectV(ref: RefV(id = "myCollection", collection = RefV(id = "collections")),ts: LongV(1633476829160000),history_days: LongV(30),name: StringV(myCollection))
-
Learn more
Fauna’s query model relies on indexes to support all query patterns which do not involve looking up documents directly by their Reference. An understanding of index creation and usage is crucial for effective Fauna development.
See the Index tutorials for more information.
To learn more about Fauna, FQL, and the C# driver, explore the documentation:
To learn more about Fauna, FQL, and the Go driver, explore the documentation:
To learn more about Fauna, FQL, and the Java driver, explore the documentation:
To learn more about Fauna, FQL, and the JavaScript driver, explore the documentation:
To learn more about Fauna, FQL, and the Python driver, explore the documentation:
To learn more about Fauna, FQL, and the Scala driver, explore the documentation:
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!