IndexDefinition class

Framework\Database\Definition\Table\Indexes\IndexDefinition

Class IndexDefinition.

Extends Framework\Database\Definition\Table\DefinitionPart

Defined in libraries/database/src/Definition/Table/Indexes/IndexDefinition.php

Properties #

$database
-
$name
-
$index
-

$database

protected \Framework\Database\Database $database

$name

protected ?string $name

$index

protected ?\Framework\Database\Definition\Table\Indexes\Index $index = NULL

Methods #

__construct()
-
foreignKey()
-
fulltextKey()
-
key()
-
primaryKey()
-
spatialKey()
-
uniqueKey()
-
sql()
-

__construct()

public function __construct(\Framework\Database\Database $database, ?string $name = NULL)
Parameters
  • \Framework\Database\Database $database
  • ?string $name

foreignKey()

public function foreignKey(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\ForeignKey
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\ForeignKey

fulltextKey()

public function fulltextKey(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\FulltextKey
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\FulltextKey

key()

public function key(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\Key
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\Key

primaryKey()

public function primaryKey(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\PrimaryKey
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\PrimaryKey

spatialKey()

public function spatialKey(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\SpatialKey
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\SpatialKey

uniqueKey()

public function uniqueKey(string $column, string ...$columns): \Framework\Database\Definition\Table\Indexes\Keys\UniqueKey
Parameters
  • string $column
  • string $columns
Returns \Framework\Database\Definition\Table\Indexes\Keys\UniqueKey

sql()

protected function sql(): string
Returns string

Inherited methods #