Version 1.4.2
wiredtiger.Connection Class Reference

Python wrapper around C WT_CONNECTION. More...

Inherits object.

Public Member Functions

def __init__
 
def close
 close(self, config) -> int
 
def reconfigure
 reconfigure(self, config) -> int
 
def get_home
 get_home(self) -> string
 
def is_new
 is_new(self) -> int
 
def open_session
 open_session(self, config) -> int
 
def load_extension
 load_extension(self, path, config) -> int
 

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
connectionthe connection handle
configConfiguration 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.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
connectionthe 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
connectionthe 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
connectionthe connection handle
paththe filename of the extension module
configConfiguration string, see Configuration Strings. Permitted values:
NameEffectValues
entrythe entry point of the extension.a string; default wiredtiger_extension_init.
prefixa prefix for all names registered by this extension (e.g., to make namespaces distinct or during upgrades.a string; default empty.
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
connectionthe connection handle
errhandlerAn error handler. If NULL, the connection's error handler is used
configConfiguration string, see Configuration Strings. Permitted values:
NameEffectValues
isolationthe default isolation level for operations in this session.a string, chosen from the following options: "read-uncommitted", "read-committed", "snapshot"; default read-committed.
sessionpthe 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
connectionthe connection handle
configConfiguration string, see Configuration Strings. Permitted values:
NameEffectValues
cache_sizemaximum 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_prefixprefix string for error messages.a string; default empty.
eviction_dirty_targetcontinue 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_targetcontinue 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_triggertrigger 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.
    chunkthe granularity that a shared cache is redistributed.an integer between 1MB and 10TB; default 10MB.
    minminimum amount of cache a database in a shared cache can have.an integer between 10MB and 10TB; default 50MB.
    namename of a cache that is shared between databases.a string; default empty.
    sizemaximum 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.
)
verboseenable 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", "write"; default empty.
Returns
zero on success and a non-zero error code on failure. See Error Returns for details.