Tables

A Table (also available as Resource) is the same thing you create under Data → Create table in Studio.

from pawabase_iac import (
    Allow, Array, BelongsTo, Boolean, Desc, Email, Index, Integer, P, Policy, RateLimit, String, Table, Where, crud,
)

mine = Policy("mine", P.owner("user_id"))
staff = Policy("staff", P.role("admin") | P.role("teacher"))

students = Table(
    "students",
    fields=[
        String("user_id", unique=True),
        String("admission_number", required=True, unique=True, max_length=20),
        Email("email"),
        Integer("age", minimum=3, maximum=25),
        String("status", enum=["active", "graduated", "withdrawn"], default="active"),
        Array("guardian_ids", of=String("guardian_id")),
    ],
    operations=crud(staff, get=Allow(mine.condition | staff.condition), delete=Allow(P.role("admin"))),
    indexes=[Index("status", Desc("age"), where=[Where("status", "!=", "withdrawn")])],
    rate_limit=RateLimit(120, 60),
    realtime=True,
)

Arguments

Argument	Meaning	Default
`name`	The resource name and API path	required
`fields`	A list of fields	`[]`
`operations`	Which of `list`, `get`, `create`, `update`, `delete` exist and who may use each	none enabled
`description`	Shown in the API docs	`""`
`table`	The database table, to serve an existing one under another name	the name
`primary_key`	Key column	`id`
`id_type`	`ulid`, `uuid` or `integer`	`ulid`
`relations`	`BelongsTo` / `HasMany`	`[]`
`indexes`	`Index(...)`	`[]`
`cache_ttl`	Seconds to cache reads, up to 86400	`0`
`rate_limit`	`RateLimit(limit, window)`	none
`events`	Emit `<name>.created/updated/deleted`	`True`
`realtime`	Broadcast changes	`False`
`capture`	Also announce changes made outside the API	`False`
`timestamps`	Maintain `created_at` and `updated_at`	`True`
`owner_field`	Column filled with the caller’s id on create	none
`tags`	Group endpoints in the API docs	`[]`

Each matches a setting in Studio: see Table settings.

Operations

crud(policy, **per_operation) enables all five operations with one policy, and lets you override individual ones:

operations=crud(staff)                                            # all five: staff
operations=crud(mine, create=Allow(P.authenticated()))            # owner, but anyone signed in may create
operations=crud(staff, delete=None)                               # no delete operation at all
operations={"list": Allow(staff), "get": Allow(staff)}            # exactly these two

Allow(policy) accepts a Policy, a condition built with P, or a built-in name ("public", "authenticated", "owner", "mfa", "service", "deny"). An action that isn’t listed is off.

Derived values

A table’s table name defaults to the resource name, and the server fills in ids and defaults. plan knows this, so it won’t report a false difference for things the server normalised.

Deploying a table

deploy creates the resource, then creates or extends its database table (use --no-migrate to skip). Columns are only added: nothing is dropped or retyped. See Migrations.

Fields

Every field type.

Policies

Write the rules.

Overview

Infrastructure as code

Define your backend

Logic and events

Files and mail

Ship it

Reference

SDK clients

Arguments

Operations

Derived values

Deploying a table

Fields

Policies

​Arguments

​Operations

​Derived values

​Deploying a table

Fields

Policies

Arguments

Operations

Derived values

Deploying a table