Class Xmf\Database\Migrate

Xmf\Database\Migrate

For a given module, compare the existing tables with a defined target schema and build a work queue of DDL/SQL to transform the existing tables to the target definitions.

Typically, Migrate will be extended by a module specific class that will supply custom logic (see preSyncActions() method.)

Located at class\libraries\vendor\xoops\xmf\src\Database\Migrate.php

Methods


					
	public

__construct(string $dirname)

Migrate constructor

Parameters

$dirname

module directory name that defines the tables to be migrated

Throws

`InvalidArgumentException`
`RuntimeException`


					
	public

getCurrentSchema(): array

get the current definitions


					
	public

getTargetDefinitions(): array|bool

Return the target database condition

Returns

table structure or false on error

Throws

RuntimeException


					
	public

synchronizeSchema(bool $force = true): bool

Execute synchronization to transform current schema to target

Parameters

$force

true to force updates even if this is a 'GET' request

Returns

true if no errors, false if errors encountered


					
	public

getSynchronizeDDL(): string[]

Compare target and current schema, building work queue in $this->migrate to synchronized

Returns

array of DDL/SQL statements to transform current to target schema


					
	protected

preSyncActions(): void

Perform any upfront actions before synchronizing the schema.

The schema comparison cannot recognize changes such as renamed columns or renamed tables. By overriding this method, an implementation can provide the logic to accomplish these types of changes, and leave the other details to be handled by synchronizeSchema().

An suitable implementation should be provided by a module by extending Migrate to define any required actions.

Some typical uses include:

table and column renames
data conversions
move column data


					
	protected

addMissingTable(string $tableName): void

Add table create DDL to the work queue

Parameters

$tableName

table to add


					
	protected

synchronizeTable(string $tableName): void

Build any DDL required to synchronize an existing table to match the target schema

Parameters

$tableName

table to synchronize


					
	protected

targetHasColumn(string $tableName, string $columnName): bool

determine if a column on a table exists in the target definitions

Parameters

`$tableName`	table containing the column
`$columnName`	column to check

Returns

true if table and column combination is defined, otherwise false


					
	protected

targetHasTable(string $tableName): bool

determine if a table exists in the target definitions

Parameters

$tableName

table containing the column

Returns

true if table is defined, otherwise false


					
	public

getLastError(): string

Return message from last error encountered

Returns

last error message


					
	public

getLastErrNo(): int

Return code from last error encountered

Returns

last error number

Properties
`protected`	`false\|Helper\|HelperAbstract`	`$helper`	#
`protected`	`string[]`	`$moduleTables` table names used by module table names used by module	#
`protected`	`Tables`	`$tableHandler`	#
`protected`	`string`	`$tableDefinitionFile` yaml definition file yaml definition file	#
`protected`	`array`	`$targetDefinitions` target table definitions in Xmf\Database\Tables::dumpTables() format target table definitions in Xmf\Database\Tables::dumpTables() format	#

Namespaces

Classes

Class Xmf\Database\Migrate

Parameters

Throws

Returns

Throws

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns