Arango PHP ODM

IndexInterface extends JsonSerializable
in

Interface IndexInterface

Tags
author

Lucas S. Vieira

Table of Contents

Methods

getCollection()  : Collection|null
Returns the collection where the index belongs to
getCreateData()  : array<string|int, mixed>
Return data for create index on server
getId()  : string
Returns the index id
getName()  : string
Returns the index name
getType()  : string
Returns the index type
isNew()  : bool
If the index is a new one
isSparse()  : bool
If index is sparse
isUnique()  : bool
If index was set to use 'unique' constraint

Methods

getCollection()

Returns the collection where the index belongs 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>

getId()

Returns the index id

public getId() : string
Return values
string

getName()

Returns the index name

public getName() : string
Return values
string

getType()

Returns the index type

public getType() : string
Return values
string

isNew()

If the index is a new one

public isNew() : bool
Return values
bool —

True for new one index. False for a existing index.

isSparse()

If index is sparse

public isSparse() : bool
Return values
bool

isUnique()

If index was set to use 'unique' constraint

public isUnique() : bool
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results