Python wrapper around C WT_CONNECTION. More...

Inherits object.

Public Member Functions
def	__init__

def	close
	close(self, config) -> int More...

def	reconfigure
	reconfigure(self, config) -> int More...

def	get_home
	get_home(self) -> string More...

def	configure_method
	configure_method(self, method, uri, config, type, check) -> int More...

def	is_new
	is_new(self) -> int More...

def	open_session
	open_session(self, config) -> int More...

def	load_extension
	load_extension(self, path, config) -> int More...

Public Attributes
	this

Static Public Attributes
tuple	thisown

Detailed Description

Python wrapper around C WT_CONNECTION.

Member Function Documentation

def wiredtiger.Connection.close	(	self,
		args
	)

close(self, config) -> int

Close a connection.

Any open sessions will be closed.

ret = conn->close(conn, NULL);

Parameters

connection	the connection handle
config	Configuration string, see Configuration Strings. No values currently permitted.

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

def wiredtiger.Connection.configure_method	(	self,
		args
	)

configure_method(self, method, uri, config, type, check) -> int

Add configuration options for a method.

See Creating data-specific configuration strings for more information.

        /*
         * Applications opening a cursor for the data-source object "my_data"
         * have an additional configuration option "entries", which is an
         * integer type, defaults to 5, and must be an integer between 1 and 10.
         */
        ret = conn->configure_method(conn,
            "session.open_cursor",
            "my_data:", "entries=5", "int", "min=1,max=10");
        /*
         * Applications opening a cursor for the data-source object "my_data"
         * have an additional configuration option "devices", which is a list
         * of strings.
         */
        ret = conn->configure_method(conn,
            "session.open_cursor", "my_data:", "devices", "list", NULL);

Parameters

connection	the connection handle
method	the name of the method
uri	the object type or NULL for all object types
config	the additional configuration's name and default value
type	the additional configuration's type (must be one of `"boolean"\`, `"int"`, `"list"` or `"string"`)
check	the additional configuration check string, or NULL if none

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

def wiredtiger.Connection.get_home	(	self,
		args
	)

get_home(self) -> string

The home directory of the connection.

printf("The database home is %s\n", conn->get_home(conn));

Parameters

connection the connection handle

Returns: a pointer to a string naming the home directory

def wiredtiger.Connection.is_new	(	self,
		args
	)

is_new(self) -> int

Return if opening this handle created the database.

        if (conn->is_new(conn)) {
                /* First time initialization. */
        }

Parameters

connection the connection handle

Returns: false (zero) if the connection existed before the call to wiredtiger_open, true (non-zero) if it was created by opening this handle.

def wiredtiger.Connection.load_extension	(	self,
		args
	)

load_extension(self, path, config) -> int

Load an extension.

ret = conn->load_extension(conn, "my_extension.dll", NULL);

Parameters

connection the connection handle

path the filename of the extension module

config

Configuration string, see Configuration Strings. Permitted values:

Name	Effect	Values
`entry`	the entry point of the extension, called to initialize the extension when it is loaded. The signature of the function must match wiredtiger_extension_init.	a string; default `wiredtiger_extension_init`.
`prefix`	a prefix for all names registered by this extension (e.g., to make namespaces distinct or during upgrades).	a string; default empty.
`terminate`	a optional function in the extension that is called before the extension is unloaded during WT_CONNECTION::close. The signature of the function must match wiredtiger_extension_terminate.	a string; default `wiredtiger_extension_terminate`.

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

def wiredtiger.Connection.open_session	(	self,
		args
	)

open_session(self, config) -> int

Open a session.

WT_SESSION *session;

ret = conn->open_session(conn, NULL, NULL, &session);

Parameters

connection the connection handle

errhandler An error handler. If NULL, the connection's error handler is used

config

Configuration string, see Configuration Strings. Permitted values:

Name	Effect	Values
`isolation`	the default isolation level for operations in this session.	a string, chosen from the following options: `"read-uncommitted"`, `"read-committed"`, `"snapshot"`; default `read-committed`.

[out] sessionp the new session handle

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

def wiredtiger.Connection.reconfigure	(	self,
		args
	)

reconfigure(self, config) -> int

Reconfigure a connection handle.

ret = conn->reconfigure(conn, "eviction_target=75");

Parameters

connection the connection handle

config

Configuration string, see Configuration Strings. Permitted values:

Name	Effect	Values
`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`.
`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`.
`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`.
`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.

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

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation