Phials developer documentation
User guide
AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0

PluginColumnDefinition

Column definition for a plugin database table

Signature

interface PluginColumnDefinition {
    name: string;
    type: PluginColumnType;
    primaryKey?: boolean;
    autoIncrement?: boolean;
    notNull?: boolean;
    unique?: boolean;
    default?: unknown;
}

Members

NameTypeRequiredDescription
namestringyesColumn name
typePluginColumnTypeyesSQLite data type
primaryKeybooleannoWhether this column is the primary key
autoIncrementbooleannoWhether this column auto-increments (only for INTEGER PRIMARY KEY)
notNullbooleannoWhether NULL values are disallowed
uniquebooleannoWhether values must be unique
defaultunknownnoDefault value for the column