Supercharge your DevOps workflow with Fauna Schema Language and GitHub Actions or GitLab CI/CD

• Declarative schema: Focus on the definition of your database schema, rather than imperative steps for how to get there.
• Integrate with your existing version control: Track changes easily and manage your schema evolution directly alongside your existing source code.
• Automated schema migrations: Apply updates to your production database without downtime or manual interventions.

• Rich command set: Interact with Fauna using a comprehensive set of commands that are well-suited to accomplish any task..
• Schema diffing/drift detection: Fauna CLI with FSL gives your the ability to visualize schema diffs and drift detection.

Schema as Code

FSL and Fauna Shell Quick Start:

Install the Fauna CLI

$ npm i -g fauna-shell

Login to Fauna from the command line

$ fauna cloud-login

? Endpoint name cloud
? Email address (from https://dashboard.fauna.com/) youremail@email.com # email
? Password ************* # <-- your password here

❯ Keep 'cloud-global' endpoint as default
  cloud-global
  cloud-us
  cloud-eu

$ mkdir myawesomeapp 
$ cd myawesomeapp

$ fauna project init

? What directory would you like to store your schema files in? (defaults to current directory)
? environment <mynewproject>
? Use the default endpoint [us] yes
Fetching databases... done
? Select a database
❯ db1
  db2
  db3
  db4

# ./fauna-project

[environment.dev]
endpoint=cloud-global
database=devdb

collection User {
    unique [.email]
}

$ fauna schema push

Updating Schema

collection User {
    unique [.email]

    index byEmail {
        terms [.email]
    }
}

@role(server)
function usersWithSameAddress (address) {
  User.where(.address == address)
} 

$ fauna schema push 

Proposed diff:

* Adding function 'usersWithSameAddress' to 98:189/myschema.fsl:

  + @role(server)
  + function usersWithSameAddress (address) {
  +   User.where(.address == address)
  + }

* Modifying collection 'User' at 0:96/myschema.fsl:
  * Summary:
    + added: index 'byEmail' (see diff)

  * Diff:
      collection User {
          unique [.phone .email]
    + 
    +     index byEmail {
    +         terms [.email]
    +     }
      }

$ ? Push file contents? (y/N) y
$ You database has been updated

Using FSL in your CI/CD with GitHub Actions

name: Main CI

# Trigger the workflow on a push to the 'main' branch
on:
  push:
    branches: [ main ]

# Define jobs to be run by the workflow
jobs:
  ci:  # This is the identifier for the job
    runs-on: ubuntu-latest  # Specifies that the job should run on the latest Ubuntu runner
    env:
      # Set an environment variable using a secret stored in the repository's secrets
      FAUNA_SECRET_KEY: ${{ secrets.FAUNA_SECRET_KEY }}

    strategy:
      matrix:
        node-version: [18.x] 

    # Steps to be run as part of this job
    steps:
    - uses: actions/checkout@v3  # Checks out the repository code

    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v3  # Sets up the Node.js environment
      with:
        node-version: ${{ matrix.node-version }}  # Use the Node.js version from the strategy matrix

    - name: Install dependencies
      run: npm install  # Install npm dependencies specified in package.json

    - name: Install Fauna CLI
      run : npm install -g fauna-shell@beta  # Install Fauna CLI globally with npm at beta version

    # Push the schema to a test database, potentially overwriting existing schema
    - name: Push schema to Test Database
      run: fauna schema push --force --secret $FAUNA_SECRET_KEY # Using the force flag will omit user confirmation input
      env:
        FAUNA_SECRET_KEY: ${{ secrets.FAUNA_SECRET_KEY }}

    - name: Run tests
      run: npm test  # Run tests using the npm test script

    # Reset the test database by pushing a cleanup schema
    - name: Reset Test Database
      run: fauna schema push --dir=./cleanup/ --force --secret $FAUNA_SECRET_KEY
      # An additional environment variable for this step
      env:
        FAUNA__SECRET_KEY: ${{ secrets.FAUNA_SECRET_KEY }}

$ fauna create-key –-endpoint cloud-global <your-db>

Using FSL in your CI/CD with GitLab CI/CD

# Define the stages in the pipeline
stages:
  - build
  - test
  - deploy

# Job definitions
build_job:
  stage: build
  image: node:18
  script:
    - npm install
    - npm install -g fauna-shell
  only:
    - main

test_job:
  stage: test
  image: node:18
  script:

    - fauna schema push --force --secret $FAUNA_SECRET_KEY
    - npm test
    - fauna schema push --dir=./cleanup/ --force --secret $FAUNA_SECRET_KEY
  only:
    - main
  variables:
    FAUNA_SECRET_KEY: $FAUNA_SECRET_KEY

Conclusion