backends/chert/chert_types.h File Reference

#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.

Defines

#define CHERT_DEFAULT_BLOCK_SIZE   8192
 The default block size to use in a B-tree table.

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.
typedef unsigned long long chert_tablesize_t
 A type used to store the number of entries in a table.
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.


Define Documentation

#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 56 of file chert_types.h.

Referenced by ChertTable::set_block_size().


Typedef Documentation

typedef unsigned int chert_blocksize_t

Definition at line 27 of file chert_types.h.

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 50 of file chert_types.h.

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 39 of file chert_types.h.

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 45 of file chert_types.h.


Documentation for Xapian (version 1.2.13).
Generated on 9 Jan 2013 by Doxygen 1.5.9.