Index

Less than 1 minute

Trait providing index management methods for SQL-based DBI drivers.

trait Index

Includes default implementations for listing, creating, dropping, and checking indexes.

Methods

Retrieves a list of indexes for a given table or all tables in the specified schema.

public listIndexes(?string $tableName, false $): void

Parameter	Type	Description
`$tableName`	`string`	The name of the table. If null, all tables in the schema will be considered.
`$`	`false`

Check if an index exists by name for a given table.

public indexExists(string $indexName, ?string $tableName): bool

Parameter	Type	Description
`$indexName`	`string`	the name of the index to check
`$tableName`	`string`	the name of the table (optional)

Attempt to create an index on a table.

public createIndex(string $indexName, string $tableName, mixed $idxInfo): bool

Parameter	Type	Description
`$indexName`	`string`	the name of the index to create
`$tableName`	`string`	the name of the table
`$idxInfo`	`mixed`	Index definition (columns, uniqueness, type, etc.).

Attempt to drop an index by name.

public dropIndex(string $indexName, bool $ifExists): bool

Parameter	Type	Description
`$indexName`	`string`	the name of the index to drop
`$ifExists`	`bool`	if true, do not error if the index does not exist

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