Columns and types

A column (also called a field) is one named piece of data in every record. You define each column’s type and rules once, and Pawabase validates every write against them, documents them in the API, and uses them to build the table.

Columns tab of a table — The Columns tab. A table with no resource shows its raw columns and Define a resource.

In Studio

Open a table and choose the Columns tab. If the table has no resource yet, the tab shows its raw columns and Define a resource (type a Resource name and click it); after that each column becomes editable as below. Each column is a row that expands into its settings.

Add column adds a row. Give it a name (a letter or underscore, then letters, digits and underscores) and pick a Column type from the menu.
Click a row to open its details: Description (shown in the API docs), Default, Example, plus type-specific limits and the flags below.
Collapsed rows show the flags that change behaviour: Nullable, Unique, Indexed, Read only, Write only.
Changing a type converts the column’s settings sensibly; you review the migration before anything runs.

Types

Studio name	`type`	Stores	Notes
Text (short)	`string`	Short text	The default type
Text (long)	`text`	Long text	Paragraphs, notes
Integer	`integer`	Whole numbers	Counts, cents
Number	`number`	Decimals	Rates, measurements
Yes / no	`boolean`	true or false
Choice	`string` or number with `enum`	One value from a list	A display type; stored as text or number
Multiple choice	`array` of `enum`	Several values from a list
Date & time	`datetime`	A moment	ISO 8601, UTC
Date	`date`	A calendar date
UUID	`uuid`	A UUID
ULID	`ulid`	A ULID
Email	`email`	An email address	Validated
URL	`url`	A web address	Validated
JSON	`json`	Any JSON	For free-form data
List	`array`	A list of one item type	Set Item type
Object	`object`	A nested group of columns	Define its own `fields`
Schema reference	`ref`	A shape from Schemas	Reuse one shape in many places

Money: store integers in the smallest unit (cents), plus a currency column. Floats round.

Constraints

Set these in the column’s details in Studio. They are enforced on every create and update.

Setting	Applies to	Key	Meaning
Required	all	`required`	Must be present on create
Nullable	all	`nullable`	May be `null`
Default	all	`default`	Used when a value is not given
Min length / Max length	text types	`min_length`, `max_length`	Character limits
Pattern	text types	`pattern`	A regular expression the value must match, such as `^[a-z0-9-]+$`
Allowed values (Options)	text, numbers	`enum`	Restrict to a list. For numbers: `1, 2, 5, 10`
Minimum / Maximum	numbers	`minimum`, `maximum`	Range
Item type	List	`items`	The type of each entry
Schema	Schema reference	`schema`	The named shape

Flags

Flag	Key	Meaning
Unique	`unique`	No two rows may share a value. Implies an index
Indexed	`indexed`	Make lookups on it fast. See Indexes
Read only	`read_only`	Returned by the API, never accepted on write. Good for values the server computes
Write only	`write_only`	Accepted on write, never returned (a PIN, a secret). Also removed from realtime messages

What your app sees

A write that breaks a rule fails with a ValidationError that names the field:

try {
  await pawabase.from("products").create({ sku: "bad sku", title: "", price_cents: -5 });
} catch (e) {
  if (e instanceof ValidationError) e.byField();
  // { sku: ["does not match the pattern"], title: ["too short"], price_cents: ["must be at least 0"] }
}

try:
    pb.from_("products").create(sku="bad sku", title="", price_cents=-5)
except ValidationError as e:
    print(e)

A duplicate unique value is a ConflictError. Show these next to the form inputs (Write records).

Changing columns safely

Adding a column is safe. Make it nullable or give it a default, so existing rows are valid.
Making a column required on a table with rows needs a value for old rows first: add as nullable, backfill, then require.
Changing a type or removing a column is a risky migration. Studio marks it Needs review, keeps the old values next to the column until you remove them, and lets you roll back. See Migrations and history.
Pawabase never drops a column by itself.

Ids and timestamps

The columns every record has.

Schemas

Reusable object shapes.

Getting started

Define your data

Change safely

Read and write

Protect and shape

Studio tools

Build well

Columns and types

In Studio

Types

Constraints

Flags

What your app sees

Changing columns safely

Ids and timestamps

Schemas

​In Studio

​Types

​Constraints

​Flags

​What your app sees

​Changing columns safely

Ids and timestamps

Schemas

In Studio

Types

Constraints

Flags

What your app sees

Changing columns safely