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

PluginDatabaseSchemaOperations

Since Plugin API: 1.0.0

Signature

interface PluginDatabaseSchemaOperations {
    createTable(table: PluginTableDefinition): Promise<void>;
    addColumn(table: string, column: PluginColumnDefinition): Promise<void>;
    renameColumn(table: string, from: string, to: string): Promise<void>;
    dropColumn(table: string, column: string): Promise<void>;
    createIndex(table: string, index: PluginIndexDefinition): Promise<void>;
    dropIndex(table: string, index: string): Promise<void>;
}

Members

Name	Type	Required	Description
`createTable`	`(table:PluginTableDefinition) => Promise<void>`	yes	-
`addColumn`	`(table: string, column:PluginColumnDefinition) => Promise<void>`	yes	-
`renameColumn`	`(table: string, from: string, to: string) => Promise<void>`	yes	-
`dropColumn`	`(table: string, column: string) => Promise<void>`	yes	-
`createIndex`	`(table: string, index:PluginIndexDefinition) => Promise<void>`	yes	-
`dropIndex`	`(table: string, index: string) => Promise<void>`	yes	-