Fields

Fields describe a table’s columns. Each is a function that returns a field; pass them to Table(fields=[...]).

from pawabase_iac import (
    Array, Boolean, Date, DateTime, Email, Integer, JSON, Number, Object, Ref, String, Text, ULID, URL, UUID,
)

fields = [
    String("sku", required=True, unique=True, pattern=r"^[A-Z0-9-]+$", max_length=32),
    Text("description", max_length=5000),
    Integer("price_cents", required=True, minimum=0),
    Number("weight_kg", minimum=0),
    Boolean("active", default=True),
    DateTime("published_at", nullable=True),
    Email("contact"),
    URL("website"),
    String("status", enum=["draft", "live"], default="draft"),
    Array("tags", of=String("tag")),
    Object("dimensions", fields=[Number("width"), Number("height")]),
    JSON("attributes"),
    Ref("billing_address", schema="Address"),
]

Types

Function	Studio name	Extra options
`String`	Text (short)	`min_length`, `max_length`, `pattern`, `enum`
`Text`	Text (long)	`min_length`, `max_length`
`Integer`	Integer	`minimum`, `maximum`
`Number`	Number	`minimum`, `maximum`
`Boolean`	Yes / no
`DateTime`, `Date`	Date & time, Date
`UUID`, `ULID`	UUID, ULID
`Email`, `URL`	Email, URL
`JSON`	JSON
`Array`	List	`of=<field>` for the item type
`Object`	Object	`fields=[...]`
`Ref`	Schema reference	`schema=<Schema or name>`

A choice column is a String or number field with enum=[...]; a multiple choice is an Array(..., of=String(..., enum=[...])).

Options for every field

Option	Meaning
`required`	Must be present on create
`nullable`	May be `null`
`default`	Used when no value is given
`unique`	No two rows share a value. Implies an index
`indexed`	Fast lookups
`description`	Shown in the API docs
`read_only`	Returned, never accepted on write
`write_only`	Accepted, never returned (a PIN, a secret)
`enum`	Restrict to a list of values

Each is explained, with Studio’s wording, on Columns and types.

Vectors

A Vector field stores the meaning of a record’s text as numbers, so you can search by meaning. See Vector search.

from pawabase_iac import Embed, Table, Index, String, Text, Vector

notes = Table(
    "notes",
    fields=[
        String("title", required=True),
        Text("body"),
        Vector("embedding", dimensions=1536, embed=Embed("embed", "title", "body")),
    ],
    indexes=[Index("embedding", method="hnsw", metric="cosine")],
)

Argument	Meaning
`dimensions`	Numbers per vector. Must match the embedding model.
`embed`	`Embed(model, *fields)` fills the vector in each time the record is saved, from those text fields. Leave it out to send your own vectors.

An index on a vector uses method="hnsw" with a metric: cosine (default), l2 or ip.

Names

A field name starts with a letter or underscore, then letters, digits and underscores. Duplicates in one table are refused by validate.

Changing fields later

Add the field and pawabase deploy. Adding is safe; making a field required on a table with rows needs a value for old rows first (add nullable, backfill, then require). See Migrations and history.

Relations and indexes

Connect and speed up tables.

Schemas

Reuse shapes with Ref.

Overview

Infrastructure as code

Define your backend

Logic and events

Files and mail

Ship it

Reference

SDK clients

Types

Options for every field

Vectors

Names

Changing fields later

Relations and indexes

Schemas

​Types

​Options for every field

​Vectors

​Names

​Changing fields later

Relations and indexes

Schemas

Types

Options for every field

Vectors

Names

Changing fields later