LoadIntoMemoryCompletely

LoadIntoMemoryCompletely(string)

Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder.

public static Index LoadIntoMemoryCompletely(string indexFolder)
Parameter Type Description
indexFolder String The index folder path.

Return Value

The loaded in-memory index.

Exceptions

exception condition
InvalidOperationException The folder contains an index of a previous version that must be updated with IndexUpdater, an index of a version that cannot be updated, or an index created or changed by a newer version of the library.
InvalidDataException The folder contains a damaged index: a file that the opening of the index reads is damaged, or the index has lost the files that record its changes.
FileNotFoundException The folder contains a damaged index: a file that the opening of the index reads is missing.

Remarks

The errors that occur while an index is opened but do not prevent its opening, for example the damage of a dictionary that then gets its default content, are reported before a handler of the ErrorOccurred event can be added: they are written to the log of the index (see Logger) and are listed in the errors of the next indexing report (see Errors).

See Also


LoadIntoMemoryCompletely(string, IndexSettings)

Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder.

public static Index LoadIntoMemoryCompletely(string indexFolder, IndexSettings settings)
Parameter Type Description
indexFolder String The index folder path.
settings IndexSettings The index settings object.

Return Value

The loaded in-memory index.

Exceptions

exception condition
InvalidOperationException The folder contains an index of a previous version that must be updated with IndexUpdater, an index of a version that cannot be updated, or an index created or changed by a newer version of the library.
InvalidDataException The folder contains a damaged index: a file that the opening of the index reads is damaged, or the index has lost the files that record its changes.
FileNotFoundException The folder contains a damaged index: a file that the opening of the index reads is missing.

Remarks

The errors that occur while an index is opened but do not prevent its opening, for example the damage of a dictionary that then gets its default content, are reported before a handler of the ErrorOccurred event can be added: they are written to the log of the index (see Logger) and are listed in the errors of the next indexing report (see Errors).

See Also