Version 1.6.4
WiredTiger Extension API

The functions and interfaces applications use to customize and extend the behavior of WiredTiger. More...

Classes

struct  WT_COLLATOR
 The interface implemented by applications to provide custom ordering of records. More...
 
struct  WT_COMPRESSOR
 The interface implemented by applications to provide custom compression. More...
 
struct  WT_DATA_SOURCE
 Applications can extend WiredTiger by providing new implementations of the WT_DATA_SOURCE class. More...
 
struct  WT_EXTRACTOR
 The interface implemented by applications to provide custom extraction of index keys or column group values. More...
 
struct  WT_TXN_NOTIFY
 Snapshot isolation level, returned by WT_EXTENSION_API::transaction_isolation_level. More...
 
struct  WT_EXTENSION_API
 Table of WiredTiger extension methods. More...
 
struct  WT_CONFIG_ITEM
 The configuration information returned by the WiredTiger extension function WT_EXTENSION_API::config_get. More...
 

Macros

#define WT_TXN_ISO_READ_COMMITTED
 Read-committed isolation level, returned by WT_EXTENSION_API::transaction_isolation_level.
 
#define WT_TXN_ISO_READ_UNCOMMITTED
 Read-uncommitted isolation level, returned by WT_EXTENSION_API::transaction_isolation_level.
 
#define WT_TXN_ISO_SNAPSHOT
 Snapshot isolation level, returned by WT_EXTENSION_API::transaction_isolation_level.
 

Typedefs

typedef struct WT_CONFIG_ARG WT_CONFIG_ARG
 A configuration object passed to some extension interfaces. More...
 
typedef struct WT_CONFIG_SCAN WT_CONFIG_SCAN
 A handle for a scan through a configuration string. More...
 

Functions

int wiredtiger_extension_init (WT_CONNECTION *connection, WT_CONFIG_ARG *config)
 Entry point to an extension, called when the extension is loaded. More...
 
int wiredtiger_extension_terminate (WT_CONNECTION *connection)
 Optional cleanup function for an extension, called during WT_CONNECTION::close. More...
 

Detailed Description

The functions and interfaces applications use to customize and extend the behavior of WiredTiger.


Class Documentation

struct WT_CONFIG_ITEM

The configuration information returned by the WiredTiger extension function WT_EXTENSION_API::config_get.

Class Members
__unnamed__ Permitted values of the type field.
Class Members
size_t len The number of bytes in the value referenced by str.
const char * str The value of a configuration string.

Regardless of the type of the configuration string (boolean, int, list or string), the str field will reference the value of the configuration string.

The bytes referenced by str are not be nul-terminated, use the len field instead of a terminating nul byte.

enum WT_CONFIG_ITEM type Permitted values of the type field.

The type of value determined by the parser. In all cases, the str and len fields are set.

int64_t val The value of a configuration boolean or integer.

If the configuration string's value is "true" or "false", the val field will be set to 1 (true), or 0 (false).

If the configuration string can be legally interpreted as an integer, using the strtoll function rules as specified in ISO/IEC 9899:1990 ("ISO C90"), that integer will be stored in the val field.

Typedef Documentation

A configuration object passed to some extension interfaces.

This is an opaque type: configuration values can be queried using WT_EXTENSION_API::config_get.

A handle for a scan through a configuration string.

This is an opaque type returned by WT_EXTENSION_API::config_scan_begin. Configuration values can be queried using WT_EXTENSION_API::config_scan_next. Call WT_EXTENSION_API::config_scan_end when finished to release resources.

Function Documentation

int wiredtiger_extension_init ( WT_CONNECTION connection,
WT_CONFIG_ARG config 
)

Entry point to an extension, called when the extension is loaded.

Parameters
connectionthe connection handle
configthe config information passed to WT_CONNECTION::load_extension
Returns
zero on success and a non-zero error code on failure. See Error Returns for details.
int wiredtiger_extension_terminate ( WT_CONNECTION connection)

Optional cleanup function for an extension, called during WT_CONNECTION::close.

Parameters
connectionthe connection handle
Returns
zero on success and a non-zero error code on failure. See Error Returns for details.