Phials plugin documentation
User guide
AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

PluginIndexDefinition

Since Plugin API: 1.0.0

Index definition for a plugin database table

Signature

interface PluginIndexDefinition {
    name: string;
    columns: string[];
    unique?: boolean;
}

Members

NameTypeRequiredDescription
namestringyesIndex name (will be prefixed with table name)
columnsstring[]yesColumns to index
uniquebooleannoWhether this is a unique index