Plan and deploy

Plan

pawabase plan reads the environment and prints what a deploy would do. It writes nothing.

pawabase plan
pawabase plan -e production

Mark	Meaning
`+`	Will be created
`~`	Will be changed. The fields that differ are listed
`-`	Exists in the environment but not in your code (only removed in `override` mode)

+ table   students
~ policy  staff       (condition)
~ flow    issue_invoice (definition)
  ...
1 to create, 2 to change, 0 to remove

How comparison works

The server fills in defaults and ids, so the comparison asks only whether what you wrote is present in what the server returns (an empty value matches a missing one). That avoids false differences.

Deploy

pawabase deploy                  # shows the plan, asks, applies
pawabase deploy --dry-run        # same as plan
pawabase deploy --yes            # no questions (CI)
pawabase deploy --mode override  # also delete what your code doesn't mention
pawabase deploy --force-secrets  # resend secrets that haven't changed
pawabase deploy --no-migrate     # don't create or extend tables

Modes

Mode	Behaviour
`merge` (default)	Creates and changes what your code defines; leaves everything else alone. Extras are shown as notes
`override`	Makes the environment match your code exactly and deletes the rest. Asks first, or needs `--yes`

Use merge when Studio is also used for some things. Use override only when code is the single source of truth.

What happens

Everything is validated. If an env("…") is unset, nothing is sent.
Definitions are applied in dependency order: roles, schemas, policies, tables, flows, routes, then events, webhooks, buckets and mail templates.
After a table is created or changed, its database table is created or extended (columns are only added). Skip with --no-migrate.
A summary lists what was created, changed and removed.

Safety

A secret key is required. deploy refuses without PAWABASE_API_KEY, and accepts only a secret key (pb_sk…) with the Deploy and configure preset.
Production asks first, even in merge mode.
Exit codes: 0 success, 1 a failure or a refusal, 2 when --yes was needed but not given.

After deploying

Open Studio: your table is under Data, your policy under Access → Policies, your flow under Logic → Flows. Check Activity for errors.

Roll back

Deploy the previous commit: git checkout <old> && pawabase deploy. Data isn’t rolled back (columns added stay); take a backup before risky changes.

Commands

Every option.

CI/CD

Deploy on merge.

Overview

Infrastructure as code

Define your backend

Logic and events

Files and mail

Ship it

Reference

SDK clients

Plan

How comparison works

Deploy

Modes

What happens

Safety

After deploying

Roll back

Commands

CI/CD

​Plan

​How comparison works

​Deploy

​Modes

​What happens

​Safety

​After deploying

​Roll back

Commands

CI/CD

Plan

How comparison works

Deploy

Modes

What happens

Safety

After deploying

Roll back