DatabaseTask

Execute application-defined database maintenance and seed operations.

Configure the shared config service's deployment section or override the task's public instruction arrays. Only listed tables/models are processed; an unconfigured task performs no database queries. Execution requires db for SQL operations and the normal model services for seed records.

• Full name: \PhalconKit\Modules\Cli\Tasks\DatabaseTask
• Parent class: \PhalconKit\Modules\Cli\Task

Properties

cliDoc

public string $cliDoc

Methods

initialize

Load explicit deployment instructions and grant CLI access to seed models.

public initialize(): void

Values in config.deployment replace the matching task property in full. Omitted keys preserve subclass defaults, including values set before parent::initialize(). An explicit empty array disables that operation. Requires the shared config and acl services; no database is opened here. The CLI time and memory limits are removed before running maintenance.

Throws:

When deployment configuration cannot be read. - Exception

Inherited methods

beforeExecuteRoute

public beforeExecuteRoute(): void

helpAction

public helpAction(): void

mainAction

Default action

public mainAction(): ?array

afterExecuteRoute

Handle rest response automagically

public afterExecuteRoute(\Phalcon\Cli\Dispatcher $dispatcher): void

Parameters:

Throws:

• CliException

normalizeCliPayload

Normalize values before CLI output serializers see them.

protected normalizeCliPayload(mixed $payload): mixed

Phalcon message objects are useful inside the framework but are opaque for JSON automation. This helper recursively converts them into scalar arrays while leaving other payload values unchanged.

Parameters:

normalizeCliMessages

Normalize a list of model messages and optionally add a fallback entry.

protected normalizeCliMessages(iterable $messages, ?string $fallbackMessage = null): list<array{message: string, field: string|null, type: string|null, code: int|null}>

Parameters:

resetAction

The resetAction method is responsible for resetting the state of the application by performing the following actions:

public resetAction(): array

1. Truncate database tables using the truncateAction method.
2. Insert initial data into the database using the insertAction method.

Use Case:

This method can be used when you need to reset the state of the application to its initial state. It is commonly used for testing or when you want to re-populate the database with initial data.

Throws:

• CliException

truncateAction

The truncateAction method is responsible for truncating (emptying) database tables specified in the $this->truncate array. Truncating a table removes all of its data, effectively resetting it to an empty state. This method iterates through a list of table names and executes an SQL TRUNCATE TABLE command for each of them.

public truncateAction(): array

Use Case: This method is often used when you need to reset the data in database tables without deleting the table itself. Truncating tables is a quicker alternative to deleting all rows one by one.

dropAction

Permanently drop every table listed in the configured $drop array.

public dropAction(): array<string,bool>

IF EXISTS suppresses errors for absent tables; an existing table and its data are still removed. Table identifiers are escaped through the shared db service.

Return Value:

Execution result keyed by configured table name.

Throws:

When the adapter rejects a statement. - Exception When the database rejects a statement. - PDOException

fixEngineAction

The fixEngineAction method is responsible for fixing or changing the storage engine for database tables specified in the $this->engine array. A storage engine determines how data is stored and managed within a database table. This method iterates through a list of table names and their corresponding desired storage engines and executes SQL ALTER TABLE commands to make the necessary changes.

public fixEngineAction(): array

Use Case: This method is useful when you need to adjust the storage engine of database tables to optimize performance, compatibility, or for other specific requirements. Different storage engines have different characteristics, and choosing the right one can impact table performance and functionality.

insertAction

Insert records

public insertAction(?string $models = null): array

Parameters:

Throws:

• CliException

optimizeAction

The optimizeAction method is responsible for optimizing database tables specified in the $this->optimize array. Database table optimization is a maintenance task aimed at improving the performance and storage efficiency of database tables. This method iterates through a list of table names and executes an SQL OPTIMIZE TABLE command for each of them.

public optimizeAction(): array

Use Case: This method is typically used in the context of database maintenance and optimization routines. It allows you to automate the process of optimizing database tables, which can help reclaim storage space and improve query performance by reorganizing table data and indexes.

analyzeAction

This method is responsible for analyzing database tables specified in the $this->analyse array.

public analyzeAction(): array

Table analysis is an essential database maintenance task that helps optimize the performance of database queries. Analyzing a table refreshes statistics and metadata about the table's structure, which can lead to improved query execution plans.

Use Case: This method can be used in the context of database optimization and maintenance scripts. It allows you to automate the process of analyzing database tables, ensuring that the database's query optimizer has up-to-date statistics to make informed decisions about query execution plans.

addModelsPermissions

public addModelsPermissions(?array $tables = null): void

Parameters:

Throws:

When permission configuration cannot be merged. - Exception