GitHub Blog Community Support
  • Fauna version:
    • current
    • v4
    • Welcome
      • Docs home
      • Changelog
    • Get started
      • Overview
      • Tour
      • Fauna for MongoDB users
      • Fauna for DynamoDB users
      • Fauna for SQL users
    • Learn
      • Data model
        • Databases and multi-tenancy
        • Collections
          • Documents
          • Sets
          • Indexes
        • Relationships
        • Best practices
      • Security
        • Authentication
          • Access providers
          • Tokens
          • Keys
        • Authorization
          • Roles
          • ABAC
        • Best practices
      • Schema
        • User-defined functions (UDFs)
        • Manage schema as .fsl files
      • Query data
        • Static typing
        • Pagination
        • Query composition
        • Performance hints
        • Query patterns
          • CRUD and basic operations
          • Bulk writes
          • Check a secret’s user-defined roles
          • Conditional operations
          • Get unique field values
          • Geospatial search
          • Group by aggregations
          • String search
          • Work with dates and times
          • Work with multiple Sets
        • Best practices
      • Transactions
        • Contention
      • Document time-to-live (TTL)
      • Document history
      • Event Feeds and Event Streams
        • Best practices
    • Build
      • Client drivers
        • JavaScript driver
        • Python client driver
        • Go client driver
        • .NET/C# client driver
        • JVM client driver
      • Fauna CLI v4
        • Commands
          • completion
          • database
            • database create
            • database delete
            • database list
          • local
          • login
          • query
          • schema
            • schema abandon
            • schema commit
            • schema diff
            • schema pull
            • schema push
            • schema status
          • shell
      • Fauna CLI v3
        • Commands
          • add-endpoint
          • cloud-login
          • create-database
          • create-key
          • default-endpoint
          • delete-database
          • delete-endpoint
          • delete-key
          • endpoint add
          • endpoint list
          • endpoint remove
          • endpoint select
          • environment add
          • environment list
          • environment select
          • eval
          • help
          • import
          • list-databases
          • list-endpoints
          • list-keys
          • project init
          • run-queries
          • schema abandon
          • schema commit
          • schema diff
          • schema pull
          • schema push
          • schema status
          • shell
      • Tools
        • Develop locally using Docker
        • Visual Studio Code extension
      • Tutorials
        • Perform basic operations
        • Set up a project using FSL and the Fauna CLI
        • Enforce a document type
        • Build an end-user authentication system
        • Control access with ABAC
      • Sample apps
        • JavaScript
        • Java
        • .NET
        • Event Feeds
        • Event Streaming
      • Workshops
        • AWS
        • Cloudflare
      • Integrations
        • Algolia
        • Auth0
        • Clerk
        • Amazon Cognito
        • AWS
        • Cloudflare
        • Datadog
        • Microsoft Entra
        • Fastly
        • Fly.io
        • GitHub
        • GitLab
        • Temporal
        • Vercel
    • Manage
      • Plans and billing
        • Plan details
        • Billing
      • Region Groups
      • Virtual Private Fauna
      • Private endpoints
      • Database backup and restore
      • Logs
        • Access logs in the Dashboard
        • Access logs using the API
        • Log record format
      • Team management
      • Multi-factor authentication
    • Reference
      • General requirements and limits
      • FQL language reference
        • FQL syntax quick look
        • Lexical elements
        • Literals
        • Reserved words
        • Types
        • Variables and identifiers
        • Blocks and lexical scoping
        • Field accessors and method chaining
        • Operators
        • Operator precedence
        • Expressions and statements
        • Anonymous functions
        • Naming and aliasing
        • Projection and field aliasing
        • Static typing
      • 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()
        • 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
        • Access provider schema
        • Collection schema
          • Check constraint definitions
          • Computed field definitions
          • Field definitions
          • Index definitions
          • Migrations block
          • Unique constraint definitions
        • Function schema
        • Role schema
      • HTTP API reference
        • Core API
          • Error handling
          • Query and event stats
          • Query summary
          • Wire protocol
        • 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

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!

query schema abandon
Copyright © 2018–2024 Fauna, Inc.
Terms of use Privacy Policy ↑

Sign in to your Fauna account to access Fauna v4 docs.

For the latest version, see the Fauna v10 docs.

Sign In
\