pycross.dbapi.Sqlitedb Class Reference

SQLite database driver implementation wrapping the standard Python sqlite3 methods. More...

Public Member Functions
def	__init__ (self, dbname=None, fullpath=False, recreate=False, connect=True)
	Constructor initializes DB driver connection. More...
def	__del__ (self)
	Destructor disconnects from DB. More...
def	setpath (self, dbname, fullpath=False, recreate=False, connect=True)
	Initializes the path to the DB file and establishes a connection if required. More...
def	connect (self)
	Connects to the DB file (Sqlitedb::dbpath). More...
def	disconnect (self, commit_trailing=True)
	Disconnects from the currently open DB. More...
def	create_db (self, overwrite=False)
	Creates the DB in Sqlitedb::dbpath, optionally overwriting the existing file. More...
def	create_tables (self)
	Creates the default table structure in the DB. More...
def	get_words (self)
def	get_pos (self)

Public Attributes
	dbpath
	str full path to the DB More...
	conn
	internal DB connection object (SQLite driver) More...

Detailed Description

SQLite database driver implementation wrapping the standard Python sqlite3 methods.

Some handy methods are added to connect / disconnect to / from the DB, create / recreate the DB with the default set of tables (to use as a word source), and import Hunspell dictionary data.

Constructor & Destructor Documentation

__init__()

def pycross.dbapi.Sqlitedb.__init__	(		self,
			dbname = None,
			fullpath = False,
			recreate = False,
			connect = True
	)

Constructor initializes DB driver connection.

Parameters

dbname

str path to database file (*.db) or an abbreviated language name for preinstalled DB files stored in 'assets/dic', e.g. 'en' (='assets/dic/en.db')

__del__()

def pycross.dbapi.Sqlitedb.__del__

(

self

)

Destructor disconnects from DB.

Member Function Documentation

connect()

def pycross.dbapi.Sqlitedb.connect

(

self

)

Connects to the DB file (Sqlitedb::dbpath).

Returns

bool True on success, False on failure

create_db()

def pycross.dbapi.Sqlitedb.create_db	(		self,
			overwrite = False
	)

Creates the DB in Sqlitedb::dbpath, optionally overwriting the existing file.

Parameters

overwrite

bool True to overwrite the existing file (default = False)

Warning

If set to True, all data in the DB file (if present) will be lost!

Returns

bool True on success, False on failure

create_tables()

def pycross.dbapi.Sqlitedb.create_tables

(

self

)

Creates the default table structure in the DB.

Returns

bool True on success, False on failure

See also

utils::globalvars::SQL_TABLES

disconnect()

def pycross.dbapi.Sqlitedb.disconnect	(		self,
			commit_trailing = True
	)

Disconnects from the currently open DB.

Parameters

commit_trailing

bool True (default) to commit all pending changes to the DB before disconnecting

get_pos()

def pycross.dbapi.Sqlitedb.get_pos

(

self

)

get_words()

def pycross.dbapi.Sqlitedb.get_words

(

self

)

setpath()

def pycross.dbapi.Sqlitedb.setpath	(		self,
			dbname,
			fullpath = False,
			recreate = False,
			connect = True
	)

Initializes the path to the DB file and establishes a connection if required.

Parameters

dbname	str path to database file (*.db) or an abbreviated language name - see init()
fullpath	bool True to indicate that the 'dbname' argument is the full file path (default = False)
recreate	bool True to recreate the database file with the default table structure (default = False).

Warning

If set to True, all data in the DB file (if present) will be lost!

Parameters

connect

bool True (default) to attempt connecting to the DB immediately

Returns

bool True on success, False on failure

Member Data Documentation

conn

pycross.dbapi.Sqlitedb.conn

internal DB connection object (SQLite driver)

dbpath

pycross.dbapi.Sqlitedb.dbpath

str full path to the DB

---

The documentation for this class was generated from the following file:

• pycross/dbapi.py