Aplus Framework Docs
IndexDefinition
extends DefinitionPart
in package
Class IndexDefinition.
Tags
Table of Contents
Properties
Methods
- __call() : mixed
- __construct() : mixed
- foreignKey() : ForeignKey
- fulltextKey() : FulltextKey
- key() : Key
- primaryKey() : PrimaryKey
- spatialKey() : SpatialKey
- uniqueKey() : UniqueKey
- sql() : string
Properties
$database
protected
Database
$database
$index
protected
Index|null
$index
= null
$name
protected
string|null
$name
Methods
__call()
public
__call(string $method, array<int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<int, mixed>
__construct()
public
__construct(Database $database[, string|null $name = null ]) : mixed
Parameters
- $database : Database
- $name : string|null = null
foreignKey()
public
foreignKey(string $column, string ...$columns) : ForeignKey
Parameters
- $column : string
- $columns : string
Return values
ForeignKeyfulltextKey()
public
fulltextKey(string $column, string ...$columns) : FulltextKey
Parameters
- $column : string
- $columns : string
Return values
FulltextKeykey()
public
key(string $column, string ...$columns) : Key
Parameters
- $column : string
- $columns : string
Return values
KeyprimaryKey()
public
primaryKey(string $column, string ...$columns) : PrimaryKey
Parameters
- $column : string
- $columns : string
Return values
PrimaryKeyspatialKey()
public
spatialKey(string $column, string ...$columns) : SpatialKey
Parameters
- $column : string
- $columns : string
Return values
SpatialKeyuniqueKey()
public
uniqueKey(string $column, string ...$columns) : UniqueKey
Parameters
- $column : string
- $columns : string
Return values
UniqueKeysql()
protected
sql() : string