IMigrationStep
in
This interface represents a database migration step.
To implement a migration step, you must extend \OCP\Migration\SimpleMigrationStep
You should additionally add some attributes found in the \OCP\Migration\Attributes namespace to the migration, to describe the change that will be done by the migration step to the admin.
Tags
Table of Contents
Methods
- changeSchema() : null|ISchemaWrapper
- description() : string
- Human-readable description of the migration step
- name() : string
- Human-readable name of the migration step
- postSchemaChange() : mixed
- preSchemaChange() : mixed
Methods
changeSchema()
public
changeSchema(IOutput $output, callable(): ISchemaWrapper $schemaClosure, array{tablePrefix?: string} $options) : null|ISchemaWrapper
Parameters
- $output : IOutput
- $schemaClosure : callable(): ISchemaWrapper
- $options : array{tablePrefix?: string}
Tags
Return values
null|ISchemaWrapperdescription()
Human-readable description of the migration step
public
description() : string
Tags
Return values
stringname()
Human-readable name of the migration step
public
name() : string
Tags
Return values
stringpostSchemaChange()
public
postSchemaChange(IOutput $output, callable(): ISchemaWrapper $schemaClosure, array{tablePrefix?: string} $options) : mixed
Parameters
- $output : IOutput
- $schemaClosure : callable(): ISchemaWrapper
- $options : array{tablePrefix?: string}
Tags
preSchemaChange()
public
preSchemaChange(IOutput $output, callable(): ISchemaWrapper $schemaClosure, array{tablePrefix?: string} $options) : mixed
Parameters
- $output : IOutput
- $schemaClosure : callable(): ISchemaWrapper
- $options : array{tablePrefix?: string}