Python wrappers aroung the WiredTiger C API. More...

Classes
class	wiredtiger.Cursor
	Python wrapper around C WT_CURSOR. More...

class	wiredtiger.Session
	Python wrapper around C WT_SESSION. More...

class	wiredtiger.Connection
	Python wrapper around C WT_CONNECTION. More...

class	wiredtiger.stat
	keys for statistics cursors More...

Functions
def	wiredtiger.wiredtiger_open
	wiredtiger_open(home, config) -> int More...

def	wiredtiger.wiredtiger_strerror
	wiredtiger_strerror(err) -> string More...

def	wiredtiger.wiredtiger_version
	wiredtiger_version() -> string More...

Variables
	wiredtiger.WiredTigerError

	wiredtiger.WIREDTIGER_VERSION_MAJOR

	wiredtiger.WIREDTIGER_VERSION_MINOR

	wiredtiger.WIREDTIGER_VERSION_PATCH

	wiredtiger.WIREDTIGER_VERSION_STRING

	wiredtiger.Cursor_swigregister

	wiredtiger.Session_swigregister

	wiredtiger.Connection_swigregister

	wiredtiger.WT_DEADLOCK

	wiredtiger.WT_DUPLICATE_KEY

	wiredtiger.WT_ERROR

	wiredtiger.WT_NOTFOUND

	wiredtiger.WT_PANIC

	wiredtiger.WT_RESTART

	wiredtiger.WT_STAT_CONN_BLOCK_BYTE_MAP_READ

	wiredtiger.WT_STAT_CONN_BLOCK_BYTE_READ

	wiredtiger.WT_STAT_CONN_BLOCK_BYTE_WRITE

	wiredtiger.WT_STAT_CONN_BLOCK_MAP_READ

	wiredtiger.WT_STAT_CONN_BLOCK_PRELOAD

	wiredtiger.WT_STAT_CONN_BLOCK_READ

	wiredtiger.WT_STAT_CONN_BLOCK_WRITE

	wiredtiger.WT_STAT_CONN_CACHE_BYTES_DIRTY

	wiredtiger.WT_STAT_CONN_CACHE_BYTES_INUSE

	wiredtiger.WT_STAT_CONN_CACHE_BYTES_MAX

	wiredtiger.WT_STAT_CONN_CACHE_BYTES_READ

	wiredtiger.WT_STAT_CONN_CACHE_BYTES_WRITE

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_CHECKPOINT

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_CLEAN

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_DIRTY

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_FAIL

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_HAZARD

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_INTERNAL

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_MERGE

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_MERGE_FAIL

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_MERGE_LEVELS

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_SLOW

	wiredtiger.WT_STAT_CONN_CACHE_EVICTION_WALK

	wiredtiger.WT_STAT_CONN_CACHE_PAGES_DIRTY

	wiredtiger.WT_STAT_CONN_CACHE_PAGES_INUSE

	wiredtiger.WT_STAT_CONN_CACHE_READ

	wiredtiger.WT_STAT_CONN_CACHE_WRITE

	wiredtiger.WT_STAT_CONN_COND_WAIT

	wiredtiger.WT_STAT_CONN_CURSOR_CREATE

	wiredtiger.WT_STAT_CONN_CURSOR_INSERT

	wiredtiger.WT_STAT_CONN_CURSOR_NEXT

	wiredtiger.WT_STAT_CONN_CURSOR_PREV

	wiredtiger.WT_STAT_CONN_CURSOR_REMOVE

	wiredtiger.WT_STAT_CONN_CURSOR_RESET

	wiredtiger.WT_STAT_CONN_CURSOR_SEARCH

	wiredtiger.WT_STAT_CONN_CURSOR_SEARCH_NEAR

	wiredtiger.WT_STAT_CONN_CURSOR_UPDATE

	wiredtiger.WT_STAT_CONN_FILE_OPEN

	wiredtiger.WT_STAT_CONN_LSM_ROWS_MERGED

	wiredtiger.WT_STAT_CONN_MEMORY_ALLOCATION

	wiredtiger.WT_STAT_CONN_MEMORY_FREE

	wiredtiger.WT_STAT_CONN_MEMORY_GROW

	wiredtiger.WT_STAT_CONN_READ_IO

	wiredtiger.WT_STAT_CONN_REC_PAGES

	wiredtiger.WT_STAT_CONN_REC_PAGES_EVICTION

	wiredtiger.WT_STAT_CONN_REC_SKIPPED_UPDATE

	wiredtiger.WT_STAT_CONN_RWLOCK_READ

	wiredtiger.WT_STAT_CONN_RWLOCK_WRITE

	wiredtiger.WT_STAT_CONN_SESSION_CURSOR_OPEN

	wiredtiger.WT_STAT_CONN_TXN_BEGIN

	wiredtiger.WT_STAT_CONN_TXN_CHECKPOINT

	wiredtiger.WT_STAT_CONN_TXN_COMMIT

	wiredtiger.WT_STAT_CONN_TXN_FAIL_CACHE

	wiredtiger.WT_STAT_CONN_TXN_ROLLBACK

	wiredtiger.WT_STAT_CONN_WRITE_IO

	wiredtiger.WT_STAT_DSRC_BLOCK_ALLOC

	wiredtiger.WT_STAT_DSRC_BLOCK_ALLOCSIZE

	wiredtiger.WT_STAT_DSRC_BLOCK_CHECKPOINT_SIZE

	wiredtiger.WT_STAT_DSRC_BLOCK_EXTENSION

	wiredtiger.WT_STAT_DSRC_BLOCK_FREE

	wiredtiger.WT_STAT_DSRC_BLOCK_MAGIC

	wiredtiger.WT_STAT_DSRC_BLOCK_MAJOR

	wiredtiger.WT_STAT_DSRC_BLOCK_MINOR

	wiredtiger.WT_STAT_DSRC_BLOCK_SIZE

	wiredtiger.WT_STAT_DSRC_BLOOM_COUNT

	wiredtiger.WT_STAT_DSRC_BLOOM_FALSE_POSITIVE

	wiredtiger.WT_STAT_DSRC_BLOOM_HIT

	wiredtiger.WT_STAT_DSRC_BLOOM_MISS

	wiredtiger.WT_STAT_DSRC_BLOOM_PAGE_EVICT

	wiredtiger.WT_STAT_DSRC_BLOOM_PAGE_READ

	wiredtiger.WT_STAT_DSRC_BLOOM_SIZE

	wiredtiger.WT_STAT_DSRC_BTREE_COLUMN_DELETED

	wiredtiger.WT_STAT_DSRC_BTREE_COLUMN_FIX

	wiredtiger.WT_STAT_DSRC_BTREE_COLUMN_INTERNAL

	wiredtiger.WT_STAT_DSRC_BTREE_COLUMN_VARIABLE

	wiredtiger.WT_STAT_DSRC_BTREE_COMPACT_REWRITE

	wiredtiger.WT_STAT_DSRC_BTREE_ENTRIES

	wiredtiger.WT_STAT_DSRC_BTREE_FIXED_LEN

	wiredtiger.WT_STAT_DSRC_BTREE_MAXIMUM_DEPTH

	wiredtiger.WT_STAT_DSRC_BTREE_MAXINTLITEM

	wiredtiger.WT_STAT_DSRC_BTREE_MAXINTLPAGE

	wiredtiger.WT_STAT_DSRC_BTREE_MAXLEAFITEM

	wiredtiger.WT_STAT_DSRC_BTREE_MAXLEAFPAGE

	wiredtiger.WT_STAT_DSRC_BTREE_OVERFLOW

	wiredtiger.WT_STAT_DSRC_BTREE_ROW_INTERNAL

	wiredtiger.WT_STAT_DSRC_BTREE_ROW_LEAF

	wiredtiger.WT_STAT_DSRC_CACHE_BYTES_READ

	wiredtiger.WT_STAT_DSRC_CACHE_BYTES_WRITE

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_CHECKPOINT

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_CLEAN

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_DIRTY

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_FAIL

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_HAZARD

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_INTERNAL

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_MERGE

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_MERGE_FAIL

	wiredtiger.WT_STAT_DSRC_CACHE_EVICTION_MERGE_LEVELS

	wiredtiger.WT_STAT_DSRC_CACHE_OVERFLOW_VALUE

	wiredtiger.WT_STAT_DSRC_CACHE_READ

	wiredtiger.WT_STAT_DSRC_CACHE_READ_OVERFLOW

	wiredtiger.WT_STAT_DSRC_CACHE_WRITE

	wiredtiger.WT_STAT_DSRC_COMPRESS_RAW_FAIL

	wiredtiger.WT_STAT_DSRC_COMPRESS_RAW_FAIL_TEMPORARY

	wiredtiger.WT_STAT_DSRC_COMPRESS_RAW_OK

	wiredtiger.WT_STAT_DSRC_COMPRESS_READ

	wiredtiger.WT_STAT_DSRC_COMPRESS_WRITE

	wiredtiger.WT_STAT_DSRC_COMPRESS_WRITE_FAIL

	wiredtiger.WT_STAT_DSRC_COMPRESS_WRITE_TOO_SMALL

	wiredtiger.WT_STAT_DSRC_CURSOR_CREATE

	wiredtiger.WT_STAT_DSRC_CURSOR_INSERT

	wiredtiger.WT_STAT_DSRC_CURSOR_INSERT_BULK

	wiredtiger.WT_STAT_DSRC_CURSOR_INSERT_BYTES

	wiredtiger.WT_STAT_DSRC_CURSOR_NEXT

	wiredtiger.WT_STAT_DSRC_CURSOR_PREV

	wiredtiger.WT_STAT_DSRC_CURSOR_REMOVE

	wiredtiger.WT_STAT_DSRC_CURSOR_REMOVE_BYTES

	wiredtiger.WT_STAT_DSRC_CURSOR_RESET

	wiredtiger.WT_STAT_DSRC_CURSOR_SEARCH

	wiredtiger.WT_STAT_DSRC_CURSOR_SEARCH_NEAR

	wiredtiger.WT_STAT_DSRC_CURSOR_UPDATE

	wiredtiger.WT_STAT_DSRC_CURSOR_UPDATE_BYTES

	wiredtiger.WT_STAT_DSRC_LSM_CHUNK_COUNT

	wiredtiger.WT_STAT_DSRC_LSM_GENERATION_MAX

	wiredtiger.WT_STAT_DSRC_LSM_LOOKUP_NO_BLOOM

	wiredtiger.WT_STAT_DSRC_REC_DICTIONARY

	wiredtiger.WT_STAT_DSRC_REC_OVFL_KEY

	wiredtiger.WT_STAT_DSRC_REC_OVFL_VALUE

	wiredtiger.WT_STAT_DSRC_REC_PAGE_DELETE

	wiredtiger.WT_STAT_DSRC_REC_PAGE_MERGE

	wiredtiger.WT_STAT_DSRC_REC_PAGES

	wiredtiger.WT_STAT_DSRC_REC_PAGES_EVICTION

	wiredtiger.WT_STAT_DSRC_REC_SKIPPED_UPDATE

	wiredtiger.WT_STAT_DSRC_REC_SPLIT_INTL

	wiredtiger.WT_STAT_DSRC_REC_SPLIT_LEAF

	wiredtiger.WT_STAT_DSRC_REC_SPLIT_MAX

	wiredtiger.WT_STAT_DSRC_SESSION_COMPACT

	wiredtiger.WT_STAT_DSRC_SESSION_CURSOR_OPEN

	wiredtiger.WT_STAT_DSRC_TXN_UPDATE_CONFLICT

	wiredtiger.WT_STAT_DSRC_TXN_WRITE_CONFLICT

Detailed Description

Python wrappers aroung the WiredTiger C API.

Class Documentation

class wiredtiger::stat

keys for statistics cursors

Function Documentation

def wiredtiger.wiredtiger_open ( args)

wiredtiger_open(home, config) -> int

Open a connection to a database.

ret = wiredtiger_open(home, NULL, "create,cache_size=500M", &conn);

Parameters

home The path to the database home directory. See Database Home Directory for more information.

errhandler An error handler. If NULL, a builtin error handler is installed that writes error messages to stderr

config

Configuration string, see Configuration Strings. Permitted values:

Name	Effect	Values
`buffer_alignment`	in-memory alignment (in bytes) for buffers used for I/O. The default value of -1 indicates a platform-specific alignment value should be used (4KB on Linux systems, zero elsewhere).	an integer between -1 and 1MB; default `-1`.
`cache_size`	maximum heap memory to allocate for the cache. A database should configure either a cache_size or a shared_cache not both.	an integer between 1MB and 10TB; default `100MB`.
`checkpoint = (`	periodically checkpoint the database.	a set of related configuration options defined below.
`name`	the checkpoint name.	a string; default `"WiredTigerCheckpoint"`.
`wait`	seconds to wait between each checkpoint; setting this value configures periodic checkpoints.	an integer between 1 and 100000; default `0`.
`)`
`create`	create the database if it does not exist.	a boolean flag; default `false`.
`direct_io`	Use `O_DIRECT` to access files. Options are given as a list, such as `"direct_io=[data]"`. Configuring `direct_io` requires care, see Direct I/O for important warnings.	a list, with values chosen from the following options: `"data"`, `"log"`; default empty.
`error_prefix`	prefix string for error messages.	a string; default empty.
`eviction_dirty_target`	continue evicting until the cache has less dirty pages than this (as a percentage). Dirty pages will only be evicted if the cache is full enough to trigger eviction.	an integer between 10 and 99; default `80`.
`eviction_target`	continue evicting until the cache becomes less full than this (as a percentage). Must be less than `eviction_trigger`.	an integer between 10 and 99; default `80`.
`eviction_trigger`	trigger eviction when the cache becomes this full (as a percentage).	an integer between 10 and 99; default `95`.
`extensions`	list of shared library extensions to load (using dlopen). Optional values are passed as the `config` parameter to WT_CONNECTION::load_extension. For example, `extensions=(/path/ext.so={entry=my_entry})`.	a list of strings; default empty.
`file_extend`	file extension configuration. If set, extend files of the set type in allocations of the set size, instead of a block at a time as each new block is written. For example, `file_extend=(data=16MB)`.	a list, with values chosen from the following options: `"data"`, `"log"`; default empty.
`hazard_max`	maximum number of simultaneous hazard pointers per session handle.	an integer greater than or equal to 15; default `1000`.
`logging`	enable logging.	a boolean flag; default `false`.
`lsm_merge`	merge LSM chunks where possible.	a boolean flag; default `true`.
`mmap`	Use memory mapping to access files when possible.	a boolean flag; default `true`.
`multiprocess`	permit sharing between processes (will automatically start an RPC server for primary processes and use RPC for secondary processes). Not yet supported in WiredTiger.	a boolean flag; default `false`.
`session_max`	maximum expected number of sessions (including server threads).	an integer greater than or equal to 1; default `50`.
`shared_cache = (`	shared cache configuration options. A database should configure either a cache_size or a shared_cache not both.	a set of related configuration options defined below.
`enable`	whether the connection is using a shared cache.	a boolean flag; default `false`.
`chunk`	the granularity that a shared cache is redistributed.	an integer between 1MB and 10TB; default `10MB`.
`reserve`	amount of cache this database is guaranteed to have available from the shared cache. This setting is per database. Defaults to the chunk size.	an integer; default `0`.
`name`	name of a cache that is shared between databases.	a string; default `pool`.
`size`	maximum memory to allocate for the shared cache. Setting this will update the value if one is already set.	an integer between 1MB and 10TB; default `500MB`.
`)`
`statistics`	Maintain database statistics that may impact performance.	a boolean flag; default `false`.
`statistics_log = (`	log database connection statistics to a file (implies setting the `statistics` configuration value to true). See Statistics logging for more information.	a set of related configuration options defined below.
`clear`	reset statistics counters after each set of log records are written.	a boolean flag; default `true`.
`path`	the pathname to a file into which the log records are written, may contain strftime conversion specifications. If the value is not an absolute path name, the file is created relative to the database home.	a string; default `"WiredTigerStat.%H"`.
`sources`	if non-empty, include statistics for the list of data source URIs, if they are open at the time of the statistics logging. The list may include URIs matching a single data source ("table:mytable"), or a URI matching all data sources of a particular type ("table:"). No statistics that require the traversal of a tree are reported, as if the `statistics_fast` configuration string were set.	a list of strings; default empty.
`timestamp`	a timestamp prepended to each log record, may contain strftime conversion specifications.	a string; default `"%b %d %H:%M:%S"`.
`wait`	seconds to wait between each write of the log records; setting this value configures `statistics` and statistics logging.	an integer between 1 and 100000; default `0`.
`)`
`sync`	flush files to stable storage when closing or writing checkpoints.	a boolean flag; default `true`.
`use_environment_priv`	use the `WIREDTIGER_CONFIG` and `WIREDTIGER_HOME` environment variables regardless of whether or not the process is running with special privileges. See Database Home Directory for more information.	a boolean flag; default `false`.
`verbose`	enable messages for various events. Options are given as a list, such as `"verbose=[evictserver,read]"`.	a list, with values chosen from the following options: `"block"`, `"shared_cache"`, `"ckpt"`, `"evict"`, `"evictserver"`, `"fileops"`, `"hazard"`, `"lsm"`, `"mutex"`, `"read"`, `"readserver"`, `"reconcile"`, `"salvage"`, `"verify"`, `"version"`, `"write"`; default empty.

Additionally, if a file named WiredTiger.config appears in the WiredTiger home directory, it is read for configuration values (see WiredTiger.config file for details). Configuration values specified in the config argument to the wiredtiger_open function override configuration values specified in the WiredTiger.config file.

[out] connectionp A pointer to the newly opened connection handle

Returns: zero on success and a non-zero error code on failure. See Error Returns for details.

def wiredtiger.wiredtiger_strerror ( args)

wiredtiger_strerror(err) -> string

Return information about an error as a string; wiredtiger_strerror is a superset of the ISO C99/POSIX 1003.1-2001 function strerror.

        const char *key = "non-existent key";
        cursor->set_key(cursor, key);
        if ((ret = cursor->remove(cursor)) != 0) {
                fprintf(stderr,
                    "cursor.remove: %s\n", wiredtiger_strerror(ret));
                return (ret);
        }

Parameters

err	a return value from a WiredTiger, C library or POSIX function

Returns: a string representation of the error

def wiredtiger.wiredtiger_version ( )

wiredtiger_version() -> string

Get version information.

printf("WiredTiger version %s\n", wiredtiger_version(NULL, NULL, NULL));

        int major, minor, patch;
        (void)wiredtiger_version(&major, &minor, &patch);
        printf("WiredTiger version is %d, %d (patch %d)\n",
            major, minor, patch);

Parameters

majorp	a location where the major version number is returned
minorp	a location where the minor version number is returned
patchp	a location where the patch version number is returned

Returns: a string representation of the version

Classes

Functions

Variables

Detailed Description

Class Documentation

Function Documentation