View

Represents a database view for migration actions.

class View extends \Hazaar\DBI\Manager\Migration\Action\BaseAction

Encapsulates view attributes such as name, body, and dropFirst flag. Provides methods for creating, altering, dropping, applying, and diffing views in migration processes.

Properties

name

The name of the view.

public string $name

body

The SQL body of the view definition.

public string $body

dropFirst

Whether to drop the view before altering it.

public bool $dropFirst

Methods

create

Creates the view in the database.

public create(Adapter $dbi): bool

Throws an exception if the view body is not set.

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

alter

public alter(Adapter $dbi): bool

Parameters

Parameter	Type	Description
$dbi	Adapter

drop

public drop(Adapter $dbi): bool

Parameters

Parameter	Type	Description
$dbi	Adapter

apply

Apply an ALTER action to the BaseAction.

public apply(BaseAction $action): bool

Parameters

Parameter	Type	Description
$action	BaseAction

diff

Find the difference between two BaseActions.

public diff(BaseAction $action): ?BaseAction

Parameters

Parameter	Type	Description
$action	BaseAction

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000