Make a branch

Make a branch in the editor or from your AI assistant: where it starts from, what data its database gets, which keys it uses, and what is copied.

Making a branch takes a few seconds. The choices that matter are what its database starts with and which keys it uses: they decide whether the branch can touch real data and real services.

In the editor

  1. 1

    Open New branch

    Open the branch switcher beside the project name and click New branch…. The branch starts from the project or branch you have open; you can pick another one to start from.

  2. 2

    Name it and pick its type

    Give it a name that says what it is for, such as "Checkout redesign". Under Branch type, Standard lets you choose its data and keys; Isolated gives it no real data or keys (see Isolated branches). Turn on Scratch branch for a branch you will throw away.

  3. 3

    Set up the branch

    For a standard branch, the second step has the database, the test keys and the Floot services, described below. Then click Create branch. The editor opens the new branch.

What the database starts with

ChoiceThe branch's databaseUse it for
Full copyA copy of every table and row of the branch it starts from, as it is now. Nothing syncs afterwardsChanges you want to try on realistic data. The default
Empty databaseThe same tables, with no rows. If the project has a seed script, it fills themA clean start, and data you must not copy (health, payments, personal details)
As of a date and timeThe database as it was at that moment. Only the database goes back: code, files and keys stay as they are nowLooking at or recovering data that was changed or deleted since

A branch's database has no history from before the branch was made, so As of on a branch can go back only to its start. Code that uses a table or column added after the chosen moment fails on that branch until the table or column is added to its database.

External databases are shared

Only a Floot database is copied. A database outside Floot (one you connected with its own address or key) is not: the branch connects to the same one, so whatever it writes there changes the real data. New branch names such databases before you create the branch.

Test keys

Every key the project uses is copied into the branch. Under Test keys, type a value to use on the branch only, or leave the field empty to use the value shown. A branch starts from main's preview values where someone saved one. Main is never changed.

A key whose value is the same as main's calls the real service with main's real key: the branch's project settings say how many keys are like that. Give a key its own value on the branch when the service must not be touched, such as a payment provider's live key.

Floot services

The switches that connect a branch to main's real users are off when it is made. You can turn them on in New branch or later in the branch's settings. See Branch settings.

What a branch gets

Copied
The code and its packages, the keys (or the test values you gave), the scheduled jobs (off until you turn them on), the queued tasks that were waiting (held until you turn them on), app connections, the self-edit token, and the project's settings.
Read from the branch it starts from
Stored files. The branch lists and shows the parent's files without copying them; a file is copied into the branch the first time the branch opens it. Files the branch uploads stay on the branch. To keep the parent's private files out, turn on Own private files only.
Made fresh for the branch
The secret that signs your app's sign-in sessions, and push notification keys: a push from the branch reaches only people who subscribed on the branch.
Not carried over
The published address, custom domains and app store connections: the branch starts unpublished, and anything you set up for it is removed when it is deleted.

From your AI assistant

Ask in your own words: "make a branch called checkout redesign with an empty database". The assistant uses fork_project, which makes the branch at once, with no card to confirm, and returns its preview link. It works on the branch from then on by its id. A full copy of the data is the default; say so when you want it empty, isolated or scratch.

Who can make a branch

The project's owner and anyone with Full access, team builders on a team project, and Isolated collaborators (whose branches are always isolated). See Collaborators and protecting main.