Skip to content

PluginColumnDefinition

Since Plugin API: 1.0.0

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

Name Type Required Description
name string yes Column name
type PluginColumnType yes SQLite data type
primaryKey boolean no Whether this column is the primary key
autoIncrement boolean no Whether this column auto-increments (only for INTEGER PRIMARY KEY)
notNull boolean no Whether NULL values are disallowed
unique boolean no Whether values must be unique
default unknown no Default value for the column

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.