FulltextIndex implements IndexDefinition
Read onlyYes
Legacy fulltext index definition.
Deprecated since ArangoDB 3.10 in favour of InvertedIndex / ArangoSearch views, but still kept here because a lot of existing code relies on it. Avoid for new schemas.
Tags
Table of Contents
Interfaces
- IndexDefinition
- Common contract for every index definition consumable by {@see \oihana\arango\clients\collection\Collection::createIndex()}.
Properties
- $fields : array<string|int, mixed>
- $inBackground : bool|null
- $minLength : int|null
- $name : string|null
Methods
- __construct() : mixed
- toArray() : array<string, mixed>
- Returns the request body for `POST /_api/index` corresponding to this index definition.
Properties
$fields
public
array<string|int, mixed>
$fields
$inBackground
public
bool|null
$inBackground
= null
$minLength
public
int|null
$minLength
= null
$name
public
string|null
$name
= null
Methods
__construct()
public
__construct(array<int, string> $fields[, int|null $minLength = null ][, string|null $name = null ][, bool|null $inBackground = null ]) : mixed
Parameters
- $fields : array<int, string>
-
Exactly one field path holding the text payload.
- $minLength : int|null = null
-
Minimum word length to index, in characters.
- $name : string|null = null
-
Optional human-readable index name.
- $inBackground : bool|null = null
-
Build the index in the background.
toArray()
Returns the request body for `POST /_api/index` corresponding to this index definition.
public
toArray() : array<string, mixed>