You are here: C++ API > Structs, Records, Enums > dtsIndexInfo Structure
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtsIndexInfo Structure

File: dtsearch.h

Syntax
C++
struct dtsIndexInfo { long structSize; long docCount; long wordCount; long dirCount; long fragmentation; long obsoleteCount; char name[IndexNameLen]; struct dtsFileDate created; struct dtsFileDate updated; struct dtsFileDate compressed; dtsIndexInfoFlags flags; long indexSize; __int64 indexSize64; long percentFull; __int64 wordCount64; long structureVersion; long canResumeUpdate; long indexFlags; long fieldCount; long startingDocId; long lastDocId; __int64 totalDataSize; __int64 totalFileSize; __int64 fileCountNotDocCount; };
Members
Description
long structSize;
Initialize to sizeof(dtsIndexInfo).
long docCount;
Number of documents in the index
long wordCount;
Number of unique words in the index
long dirCount;
Number of directories indexed
long fragmentation;
Measures the extent to which an index is fragmented by being built in multiple indexing jobs. Compressing an index eliminates fragmentation. Fragmentation of an index increases the size of the index and slows searching, but the effect is generally not noticeable unless the fragmentation is severe. Indexing documents in very small batches can produce a severely fragmented index, but otherwise index fragmentation can be disregarded.
long obsoleteCount;
When a document is indexed, modified, then indexed again, information about the document in the index is marked as obsolete and new information about the document is appended to the index. obsoleteCount is the number of documents for which obsolete information is stored in the index. Compressing an index removes all obsolete information.
char name[IndexNameLen];
The name of the index that was supplied when the index was created.
struct dtsFileDate created;
When index was created
struct dtsFileDate updated;
When index was last updated
struct dtsFileDate compressed;
When index was last created
dtsIndexInfoFlags flags;
Indicates whether the index is case-sensitive, accent-sensitive, or uses relative paths
long indexSize;
Size of the index, in bytes. Deprecated: use indexSize64 instead.
__int64 indexSize64;
Size of the index, in bytes
long percentFull;
Indicates how much of the maximum capacity of the index has been used (This is a percentage of the maximum index capacity and does not consider the amount of disk space actually available.
__int64 wordCount64;
Number of unique words in the index
long structureVersion;
Index structure version. Values currently supported:
600 - dtSearch 6.x index format. 700 - dtSearch 7 index format (2004 beta versions) 701 - dtSearch 7 index format
long canResumeUpdate;
If true, an index update was halted before it completed, and the indexer saved information that can be used to resume the index update
long indexFlags;
Flags indicating the index type (see IndexingFlags)
long fieldCount;
Number of fields in the index
long startingDocId;
First document id assigned in this index
long lastDocId;
Last document id assigned in this index
__int64 totalDataSize;
The total size of all documents added to this index (including documents indexed multiple times) The difference between totalFileSize and totalDataSize is in the way containers are handled. totalFileSize includes the size of container files such as ZIP files, but not their contents. totalDataSize includes the size of the contents of container files, but not the size of the container.
__int64 totalFileSize;
The total size of all files added to this index (including documents indexed multiple times). The difference between totalFileSize and totalDataSize is in the way containers are handled. totalFileSize includes the size of container files such as ZIP files, but not their contents. totalDataSize includes the size of the contents of container files, but not the size of the container. totalFileSize is supported only in indexes created with dtSearch versions 7.94 and later.
__int64 fileCountNotDocCount;
The total number of files added to this index (including documents indexed multiple times). The difference between fileCountNotDocCount and docCount is in the way containers are handled. fileCountNotDocCount counts each container such as a ZIP as one file, while docCount counts the number of items in a container such as a ZIP file. fileCountNotDocCount is supported only in indexes created with dtSearch versions 7.96 and later.

Holds information about an index supplied by dtssGetIndexInfo.

Copyright (c) 1995-2021 dtSearch Corp. All rights reserved.