Arango PHP ODM

TTLIndex extends Index
in package

FinalYes

Represents a TTL index on a collection

Tags
author

Lucas S. Vieira

Table of Contents

Methods

__construct()  : mixed
TTLIndex constructor.
__toString()  : mixed
String representation of index
expireAfter()  : int
Return time (in seconds) to expire documents on index
getCollection()  : Collection|null
Returns the collection where index belong to
getCreateData()  : array<string|int, mixed>
Return data for create index on server
getFields()  : array<string|int, mixed>
Returns index fields
getId()  : string
Index Id
getName()  : string
Returns index name
getType()  : string
Returns index type
isNew()  : bool
If the index is a new one
isSparse()  : bool
If the index is sparse
isUnique()  : bool
If index has 'unique' constraint
jsonSerialize()  : mixed
setCollection()  : void
Set the collection where the index belongs to
toArray()  : array<string|int, mixed>
Returns a array representation of index

Methods

__construct()

TTLIndex constructor.

public __construct(array<string|int, mixed> $fields[, int $expireAfter = 60 ][, array<string|int, mixed> $attributes = [] ]) : mixed
Parameters
$fields : array<string|int, mixed>

An array of attribute names.

$expireAfter : int = 60

Time (in seconds) to expire a document

$attributes : array<string|int, mixed> = []
Tags
throws
InvalidParameterException

__toString()

String representation of index

public __toString() : mixed

expireAfter()

Return time (in seconds) to expire documents on index

public expireAfter() : int
Return values
int

getCollection()

Returns the collection where index belong to

public getCollection() : Collection|null
Return values
Collection|null —

A collection object or null if the index was not set to an collection yet

getCreateData()

Return data for create index on server

public getCreateData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFields()

Returns index fields

public getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getId()

Index Id

public getId() : string
Return values
string

getName()

Returns index name

public getName() : string
Return values
string

getType()

Returns index type

public getType() : string
Return values
string

isNew()

If the index is a new one

public isNew() : bool
Tags
see
EntityInterface::isNew()
Return values
bool —

True if is a new object. False otherwise.

isSparse()

If the index is sparse

public isSparse() : bool
Return values
bool

isUnique()

If index has 'unique' constraint

public isUnique() : bool
Return values
bool

jsonSerialize()

public jsonSerialize() : mixed
Tags
see
JsonSerializable::jsonSerialize()

setCollection()

Set the collection where the index belongs to

public setCollection(Collection $collection) : void
Parameters
$collection : Collection

toArray()

Returns a array representation of index

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results