xapian-core  1.4.21
Macros | Typedefs
chert_types.h File Reference

Types used by chert backend and the Btree manager. More...

#include "internaltypes.h"
+ Include dependency graph for chert_types.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CHERT_DEFAULT_BLOCK_SIZE   8192
 The default block size to use in a B-tree table. More...
 
#define CHERT_MAX_DOCID   Xapian::docid(0xffffffff)
 The largest docid value supported by chert. More...
 

Typedefs

typedef unsigned int chert_blocksize_t
 
typedef unsigned int chert_revision_number_t
 A type used to store a revision number for a table. More...
 
typedef unsigned long long chert_tablesize_t
 A type used to store the number of entries in a table. More...
 
typedef unsigned int chert_doclen_t
 An integer type for storing the length of a document - ie, the sum of the wdfs of the terms in the document. More...
 

Detailed Description

Types used by chert backend and the Btree manager.

Definition in file chert_types.h.

Macro Definition Documentation

◆ CHERT_DEFAULT_BLOCK_SIZE

#define CHERT_DEFAULT_BLOCK_SIZE   8192

The default block size to use in a B-tree table.

If this is changed, be sure to update the API documentation correspondingly.

Definition at line 57 of file chert_types.h.

Referenced by ChertDatabase::compact(), and ChertTable::set_block_size().

◆ CHERT_MAX_DOCID

#define CHERT_MAX_DOCID   Xapian::docid(0xffffffff)

The largest docid value supported by chert.

Definition at line 60 of file chert_types.h.

Referenced by ChertWritableDatabase::add_document(), check_db_dir(), check_db_table(), ChertPostListTable::get_used_docid_range(), and ValueUpdater::update().

Typedef Documentation

◆ chert_blocksize_t

typedef unsigned int chert_blocksize_t

Definition at line 28 of file chert_types.h.

◆ chert_doclen_t

typedef unsigned int chert_doclen_t

An integer type for storing the length of a document - ie, the sum of the wdfs of the terms in the document.

Definition at line 51 of file chert_types.h.

◆ chert_revision_number_t

typedef unsigned int chert_revision_number_t

A type used to store a revision number for a table.

A table's revision number increases monotonically, incrementing by one each time a modification is applied to the table.

FIXME: ensure that this is of a suitable minimum size - 32 bits is satisfactory in most cases, but in extreme cases could cause the revision number to roll over after a few years. It would be better to use 64 bits (and / or to ensure that rolling over causes no problem).

Definition at line 40 of file chert_types.h.

◆ chert_tablesize_t

typedef unsigned long long chert_tablesize_t

A type used to store the number of entries in a table.

Again, this must be of suitable minimum size.

Definition at line 46 of file chert_types.h.