Camel.DB¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`camel_mir_free` (record)
class	`error_quark` ()
class	`free_sqlized_string` (string)
class	`get_column_ident` (hash, index, col_names)
class	`get_column_name` (raw_name)
class	`new` (filename)
class	`release_cache_memory` ()
class	`sqlize_string` (string)
	`abort_transaction` ()
	`add_to_transaction` (query)
	`begin_transaction` ()
	`clear_folder_summary` (folder_name)
	`command` (stmt)
	`count_deleted_message_info` (table_name)
	`count_junk_message_info` (table_name)
	`count_junk_not_deleted_message_info` (table_name, count)
	`count_message_info` (query)
	`count_total_message_info` (table_name)
	`count_unread_message_info` (table_name)
	`count_visible_message_info` (table_name)
	`count_visible_unread_message_info` (table_name)
	`create_folders_table` ()
	`delete_folder` (folder_name)
	`delete_uid` (folder_name, uid)
	`delete_uids` (folder_name, uids)
	`end_transaction` ()
	`flush_in_memory_transactions` (folder_name)
	`get_filename` ()
	`get_folder_deleted_uids` (folder_name)
	`get_folder_junk_uids` (folder_name)
	`get_folder_uids` (folder_name, sort_by, collate, hash)
	`maybe_run_maintenance` ()
	`prepare_message_info_table` (folder_name)
	`read_folder_info_record` (folder_name)
	`read_message_info_record_with_uid` (folder_name, uid, user_data, callback)
	`read_message_info_records` (folder_name, user_data, callback)
	`rename_folder` (old_folder_name, new_folder_name)
	`reset_folder_version` (folder_name, reset_version)
	`select` (stmt, callback, *user_data)
	`set_collate` (col, collate, func)
	`start_in_memory_transactions` ()
	`transaction_command` (qry_list)
	`write_folder_info_record` (record)
	`write_message_info_record` (folder_name, record)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Camel.DB(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Camel.DBClass

New in version 2.24.

classmethod camel_mir_free(record)¶

Parameters:: record (Camel.MIRecord or None) – a Camel.MIRecord

Frees the record and all of its associated data.

New in version 2.24.

classmethod error_quark()¶

Return type:: int

classmethod free_sqlized_string(string)¶

Parameters:: string (str or None) – a string to free

Frees a string previosuly returned by Camel.DB.sqlize_string().

New in version 2.24.

classmethod get_column_ident(hash, index, col_names)¶

Parameters:

hash ({object: object}) – a GLib.HashTable
index (int) – an index to start with, between 0 and ncols
col_names ([str]) – column names to traverse

Returns:

hash:: a GLib.HashTable

Return type:

(Camel.DBKnownColumnNames, hash: {object: object})

Traverses column name from index index into an enum Camel.DBKnownColumnNames value. The col_names contains ncols columns. First time this is called is created the hash from col_names indexes into the enum, and this is reused for every other call. The function expects that column names are returned always in the same order. When all rows are read the hash table can be freed with GLib.HashTable.destroy().

New in version 3.4.

classmethod get_column_name(raw_name)¶

Parameters:: raw_name (str) – raw name to find the column name for
Returns:: A corresponding column name in the message info table for the raw_name, or None, when there is no corresponding column in the summary.
Return type:: str or None

New in version 2.24.

classmethod new(filename)¶

Parameters:: filename (str) – A filename with the database to open/create
Raises:: GLib.Error
Returns:: A new Camel.DB with filename as its database file. Free it with GObject.Object.unref() when no longer needed.
Return type:: Camel.DB

New in version 3.24.

classmethod release_cache_memory()¶: Instructs sqlite to release its memory, if possible. This can be avoided when CAMEL_SQLITE_FREE_CACHE environment variable is set.

New in version 3.24.

classmethod sqlize_string(string)¶

Parameters:: string (str) – a string to “sqlize”
Returns:: A newly allocated sqlized string. The returned value should be freed with Camel.DB.sqlize_string(), when no longer needed.
Return type:: str

Converts the string to be usable in the SQLite statements.

New in version 2.24.

abort_transaction()¶

Raises:: GLib.Error
Returns:: 0 on success, -1 on error
Return type:: int

Ends an ongoing transaction by ignoring the changes.

New in version 2.24.

add_to_transaction(query)¶

Parameters:: query (str) – an SQL (SQLite) statement
Raises:: GLib.Error
Returns:: 0 on success, -1 on error
Return type:: int

Adds a statement to an ongoing transaction.

New in version 2.24.

begin_transaction()¶

Raises:: GLib.Error
Returns:: 0 on success, -1 on error
Return type:: int

Begins transaction. End it with Camel.DB.end_transaction() or Camel.DB.abort_transaction().

New in version 2.24.

clear_folder_summary(folder_name)¶

Parameters:: folder_name (str) – full name of the folder
Raises:: GLib.Error
Returns:: 0 on success, -1 on error
Return type:: int

Deletes the given folder from the ‘folders’ table and empties its message info table.

New in version 2.24.

command(stmt)¶

Parameters:: stmt (str) – an SQL (SQLite) statement to execute
Raises:: GLib.Error
Returns:: 0 on success, -1 on error
Return type:: int

Executes an SQLite command.

New in version 2.24.

count_deleted_message_info(table_name)¶

Parameters:

table_name (str) – name of the table

Raises: