company logo

IndexDefinition :: temporary - TEMPORARY option

Temporary or transient indexes can be defined in order to store query results temporarily or to create rarely used indexes for a collection on demand. Temporary indexes are available within the current process, only. A temporary index is created automatically, when activating the index (changeAccessKey()). After creating this index in main storage or in a temporary database it will be removed, when not being used anymore.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation details

bool IndexDefinition  :: temporary (  )

If the function is not called with a valid index definition it throws an exception.