Index

Represents a database index for migration actions.

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

Encapsulates index attributes such as name, table, columns, uniqueness, and index method. Provides methods for creating, altering, and dropping indexes in migration processes.

Properties

name

The name of the index.

public string $name

table

The name of the table the index applies to.

public string $table

columns

The columns included in the index.

public array $columns

unique

Whether the index is unique.

public bool $unique

using

The index method/algorithm (e.g., BTREE, HASH).

public string $using

Methods

create

Creates the index in the database.

public create(Adapter $dbi): bool

Validates required properties and logs errors if missing.

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

alter

Alters the index in the database.

public alter(Adapter $dbi): bool

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

drop

Drops the index from the database.

public drop(Adapter $dbi): bool

Iterates over the drop list and attempts to drop each index.

Parameters

Parameter	Type	Description
$dbi	Adapter	the database adapter instance

---

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