HandlesIndex
Table of Contents
Properties
-
$index
: Indexes
Methods
-
compactIndex()
: Task
-
createIndex()
: Task
-
deleteIndex()
: Task
-
getIndex()
: Index
-
getIndexes()
: IndexesResults
-
getRawIndex()
: array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}
-
index()
: Index
-
updateIndex()
: Task
compactIndex()
public
compactIndex(non-empty-string $uid) : Task
Parameters
-
$uid
: non-empty-string
-
createIndex()
public
createIndex(non-empty-string $uid[, array{primaryKey?: string|null} $options = [] ]) : Task
Parameters
-
$uid
: non-empty-string
-
-
$options
: array{primaryKey?: string|null}
= []
-
deleteIndex()
public
deleteIndex(non-empty-string $uid) : Task
Parameters
-
$uid
: non-empty-string
-
getIndex()
public
getIndex(non-empty-string $uid) : Index
Parameters
-
$uid
: non-empty-string
-
getIndexes()
public
getIndexes([IndexesQuery|null $options = null ]) : IndexesResults
Parameters
-
$options
: IndexesQuery|null
= null
-
getRawIndex()
public
getRawIndex(non-empty-string $uid) : array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}
Parameters
-
$uid
: non-empty-string
-
Return values
array{uid: non-empty-string, primaryKey: string|null, createdAt: non-empty-string, updatedAt: non-empty-string}
index()
public
index(non-empty-string $uid) : Index
Parameters
-
$uid
: non-empty-string
-
updateIndex()
public
updateIndex(non-empty-string $uid[, array{primaryKey?: string|null, uid?: non-empty-string} $options = [] ]) : Task
Parameters
-
$uid
: non-empty-string
-
-
$options
: array{primaryKey?: string|null, uid?: non-empty-string}
= []
-