Indexes
extends Endpoint
in package
FinalYes
Table of Contents
Constants
- PATH : mixed = '/indexes'
Properties
Methods
- __construct() : mixed
- all() : IndexesResults
-
allRaw()
: array{results: list
- create() : Task
- renameIndex() : Task
- Rename an index instead of swapping it.
- swapIndexes() : Task
Constants
PATH
protected
mixed
PATH
= '/indexes'
Properties
$http
protected
Http
$http
Methods
__construct()
public
__construct(Http $http) : mixed
Parameters
- $http : Http
all()
public
all([IndexesQuery|null $options = null ]) : IndexesResults
Parameters
- $options : IndexesQuery|null = null
Return values
IndexesResultsallRaw()
public
allRaw([array{offset?: int, limit?: int} $options = [] ]) : array{results: list, offset: int, limit: int, total: int}
Parameters
- $options : array{offset?: int, limit?: int} = []
Return values
array{results: listcreate()
public
create(string $uid[, array{primaryKey?: string|null} $options = [] ]) : Task
Parameters
- $uid : string
- $options : array{primaryKey?: string|null} = []
Tags
Return values
TaskrenameIndex()
Rename an index instead of swapping it.
public
renameIndex(non-empty-string $fromUid, non-empty-string $toUid) : Task
Parameters
- $fromUid : non-empty-string
- $toUid : non-empty-string
Tags
Return values
TaskswapIndexes()
public
swapIndexes(array<int, array{non-empty-string, non-empty-string}> $indexes) : Task
Parameters
- $indexes : array<int, array{non-empty-string, non-empty-string}>