IndexDefinition :: large - LARGE option
The option marks an index as large index, which causes the database storing key values in a B*-tree rather than in a list. Usually, collection indexes are stored as list, which becomes rather inefficient in case of large collections. When more than 1000 entries are expected for a collection, the large option should be set.
For later versions, this feature becomes obsolete, since the database recognizes when a list needs to turned into a tree. Nevertheless, this option can be specified in future as well in order to indicate, that the index should be created as large index from the beginning.
The value is true when the function was executed successfully. Otherwise the value is set to false.
Implementation details
If the function is not called with a valid index definition it throws an exception.