GitHub

Fauna version:
- current
- v4

- Welcome
  - Docs home
  - Docs for LLMs
- Get started
  - Overview
  - Quick starts
    - Node.js
    - Python
    - Go
    - .NET/C#
    - Java
    - Ruby
    - Rust
    - Swift
    - HTTP API
    - Script tag
    - Cloudflare Workers
    - AWS Lambda
  - Fauna for MongoDB users
  - Fauna for DynamoDB users
  - Fauna for SQL users
- Learn
- Build
- Reference
  - General requirements and limits
  - FQL language reference
  - FQL API reference
    - FQL cheat sheet
    - AccessProvider
      - Static Methods
      - AccessProvider.all()
      - AccessProvider.byName()
      - AccessProvider.create()
      - AccessProvider.firstWhere()
      - AccessProvider.toString()
      - AccessProvider.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - Array
      - Static Methods
      - Array.sequence()
      - Instance Properties
      - array.length
      - Instance Methods
      - aggregate()
      - any()
      - append()
      - at()
      - concat()
      - distinct()
      - drop()
      - entries()
      - every()
      - filter()
      - first()
      - firstWhere()
      - flatMap()
      - flatten()
      - fold()
      - foldRight()
      - forEach()
      - includes()
      - indexOf()
      - indexWhere()
      - isEmpty()
      - last()
      - lastIndexOf()
      - lastIndexWhere()
      - lastWhere()
      - map()
      - nonEmpty()
      - order()
      - prepend()
      - reduce()
      - reduceRight()
      - reverse()
      - slice()
      - take()
      - toSet()
      - toString()
      - where()
    - Bytes
      - Static Methods
      - Bytes()
      - Bytes.fromBase64()
      - Instance Methods
      - toBase64()
      - toString()
    - Collection
      - Instance Properties
      - collection.definition
      - Static Methods
      - Collection()
      - Collection.all()
      - Collection.byName()
      - Collection.create()
      - Collection.firstWhere()
      - Collection.toString()
      - Collection.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
      - Collection Name Methods
      - all()
      - byId()
      - create()
      - createData()
      - firstWhere()
      - where()
      - indexName()
    - Credential
      - Static Methods
      - Credential.all()
      - Credential.byDocument()
      - Credential.byId()
      - Credential.create()
      - Credential.firstWhere()
      - Credential.toString()
      - Credential.where()
      - Instance Methods
      - delete()
      - exists()
      - login()
      - replace()
      - update()
      - verify()
    - Database
      - Static Methods
      - Database.all()
      - Database.byName()
      - Database.create()
      - Database.firstWhere()
      - Database.toString()
      - Database.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - Date
      - Instance properties
      - dayOfMonth
      - dayOfWeek
      - dayOfYear
      - month
      - year
      - Static Methods
      - Date()
      - Date.fromString()
      - Date.today()
      - Instance Methods
      - add()
      - difference()
      - subtract()
      - toString()
    - Document
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - replaceData()
      - update()
      - updateData()
    - EventSource
      - Instance Methods
      - map()
      - toString()
      - where()
    - FQL
      - Static Methods
      - FQL.Schema.defForIdentifier()
    - Function
      - Instance Properties
      - function.definition
      - Static Methods
      - Function()
      - Function.all()
      - Function.byName()
      - Function.create()
      - Function.firstWhere()
      - Function.toString()
      - Function.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - Key
      - Static Methods
      - Key.all()
      - Key.byId()
      - Key.create()
      - Key.firstWhere()
      - Key.toString()
      - Key.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - Math
      - Static Properties
      - Math.E
      - Math.Infinity
      - Math.NaN
      - Math.PI
      - Static Methods
      - Math.abs()
      - Math.acos()
      - Math.asin()
      - Math.atan()
      - Math.ceil()
      - Math.cos()
      - Math.cosh()
      - Math.degrees()
      - Math.exp()
      - Math.floor()
      - Math.hypot()
      - Math.log()
      - Math.log10()
      - Math.max()
      - Math.mean()
      - Math.min()
      - Math.pow()
      - Math.radians()
      - Math.round()
      - Math.sign()
      - Math.sin()
      - Math.sinh()
      - Math.sqrt()
      - Math.sum()
      - Math.tan()
      - Math.tanh()
      - Math.trunc()
    - Object
      - Static Methods
      - Object.assign()
      - Object.entries()
      - Object.fromEntries()
      - Object.hasPath()
      - Object.keys()
      - Object.select()
      - Object.toString()
      - Object.values()
    - Query
      - Static Methods
      - Query.identity()
      - Query.isEnvProtected()
      - Query.isEnvTypechecked()
      - Query.token()
    - Role
      - Static Methods
      - Role.all()
      - Role.byName()
      - Role.create()
      - Role.firstWhere()
      - Role.toString()
      - Role.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - Set
      - Static Methods
      - Set.paginate()
      - Set.sequence()
      - Set.single()
      - Instance Methods
      - aggregate()
      - any()
      - changesOn()
      - concat()
      - count()
      - distinct()
      - drop()
      - eventsOn()
      - eventSource()
      - every()
      - first()
      - firstWhere()
      - flatMap()
      - fold()
      - foldRight()
      - forEach()
      - includes()
      - isEmpty()
      - last()
      - lastWhere()
      - map()
      - nonEmpty()
      - order()
      - pageSize()
      - paginate()
      - reduce()
      - reduceRight()
      - reverse()
      - take()
      - toArray()
      - toStream()
      - toString()
      - where()
    - String
      - Instance Properties
      - string.length
      - Instance Methods
      - at()
      - casefold()
      - concat()
      - endsWith()
      - includes()
      - includesRegex()
      - indexOf()
      - indexOfRegex()
      - insert()
      - lastIndexOf()
      - matches()
      - matchIndexes()
      - parseDouble()
      - parseInt()
      - parseLong()
      - parseNumber()
      - replace()
      - replaceAll()
      - replaceAllRegex()
      - replaceRegex()
      - slice()
      - split()
      - splitAt()
      - splitRegex()
      - startsWith()
      - toLowerCase()
      - toString()
      - toUpperCase()
    - Time
      - Instance properties
      - dayOfMonth
      - dayOfWeek
      - dayOfYear
      - hour
      - minute
      - month
      - second
      - year
      - Static Methods
      - Time()
      - Time.epoch()
      - Time.fromString()
      - Time.now()
      - Instance Methods
      - add()
      - difference()
      - subtract()
      - toMicros()
      - toMillis()
      - toSeconds()
      - toString()
    - Token
      - Static Methods
      - Token.all()
      - Token.byDocument()
      - Token.byId()
      - Token.create()
      - Token.firstWhere()
      - Token.toString()
      - Token.where()
      - Instance Methods
      - delete()
      - exists()
      - replace()
      - update()
    - TransactionTime
      - Static Methods
      - TransactionTime()
      - TransactionTime.toString()
    - Global functions
      - abort()
      - dbg()
      - ID()
      - log()
      - newId()
  - FSL reference
  - HTTP API reference
    - Core API
    - Account API

Build
Fauna CLI v4
Commands
schema

`fauna schema`

fauna schema <method> [flags]

Use fauna schema commands to create and manage database schema as .fsl schema files.

Available commands

fauna schema abandon
fauna schema commit
fauna schema diff
fauna schema pull
fauna schema push
fauna schema status

query schema abandon

Copyright © 2018–2025 Fauna, Inc.

Terms of use Privacy Policy ↑

\