SqliteConnector Class Reference

File adapter for Sqlite files. More...

#include <OpenMS/FORMAT/SqliteConnector.h>

Collaboration diagram for SqliteConnector:

Public Types
enum class	SqlOpenMode { READ_ONLY , READONLY = READ_ONLY , READWRITE , READWRITE_OR_CREATE }
	how an sqlite db should be opened More...

Public Member Functions
	SqliteConnector ()=delete
	Default constructor.
	SqliteConnector (const std::string &filename, const SqlOpenMode mode=SqlOpenMode::READWRITE_OR_CREATE)
	~SqliteConnector ()
	Destructor.
bool	tableExists (const std::string &tablename)
	Checks whether the given table exists.
Size	countTableRows (const std::string &table_name)
bool	columnExists (const std::string &tablename, const std::string &colname)
	Checks whether the given table contains a certain column.
void	executeStatement (const std::string &statement)
	Executes a given SQL statement (insert statement)
void	executeBindStatement (const std::string &prepare_statement, const std::vector< std::string > &data)
	Executes raw data SQL statements (insert statements)

Protected Member Functions
void	openDatabase_ (const std::string &filename, const SqlOpenMode mode)
	Opens a new SQLite database.

Protected Attributes
void *	db_ = nullptr

Friends
struct	Internal::SqliteConnectorFriend

Detailed Description

File adapter for Sqlite files.

This class contains certain helper functions to deal with Sqlite files.

Note

This is the public, SQLite-free interface. The raw SQLite C API (sqlite3*/sqlite3_stmt* handling and the Internal::SqliteHelper statement helpers) lives in the non-installed implementation header <OpenMS/FORMAT/SqliteConnector_impl.h>, which must only be included from .cpp files inside libOpenMS. Keeping the SQLite types out of this header is what allows SQLite to be a fully private dependency of OpenMS.

Member Enumeration Documentation

SqlOpenMode

enum class SqlOpenMode

strong

how an sqlite db should be opened

Enumerator
READ_ONLY	the DB must exist and is read-only
READONLY	compatibility alias for READ_ONLY
READWRITE	the DB is readable and writable, but must exist when opening it
READWRITE_OR_CREATE	the DB readable and writable and is created new if not present already

Constructor & Destructor Documentation

SqliteConnector() [1/2]

SqliteConnector ( )

delete

Default constructor.

SqliteConnector() [2/2]

SqliteConnector ( const std::string &  filename, const SqlOpenMode  mode = SqlOpenMode::READWRITE_OR_CREATE  )

explicit

Constructor which opens a connection to filename

Exceptions

Exception::SqlOperationFailed

if the file does not exist/cannot be created (depending on mode)

~SqliteConnector()

~SqliteConnector

(

)

Destructor.

Member Function Documentation

columnExists()

bool columnExists	(	const std::string &	tablename,
		const std::string &	colname
	)

Checks whether the given table contains a certain column.

tablename The name of the table (needs to exist) colname The name of the column to be checked

Returns

Whether the column exists or not

countTableRows()

Size countTableRows

(

const std::string &

table_name

)

Counts the number of entries in SQL table table_name

Exceptions

Exception::SqlOperationFailed

if table is unknown

executeBindStatement()

void executeBindStatement	(	const std::string &	prepare_statement,
		const std::vector< std::string > &	data
	)

Executes raw data SQL statements (insert statements)

This is useful for a case where raw data should be inserted into sqlite databases, and the raw data needs to be passed separately as it cannot be part of a true SQL statement

INSERT INTO TBL (ID, DATA) VALUES (100, ?1), (101, ?2), (102, ?3)"

See also https://www.sqlite.org/c3ref/bind_blob.html

prepare_statement The SQL statement data The data to bind

Exceptions

Exception::IllegalArgument

is thrown if the SQL command fails.

executeStatement()

void executeStatement

(

const std::string &

statement

)

Executes a given SQL statement (insert statement)

This is useful for writing a single row of data

statement The SQL statement

Exceptions

Exception::IllegalArgument

is thrown if the SQL command fails.

openDatabase_()

void openDatabase_ ( const std::string &  filename, const SqlOpenMode  mode  )

protected

Opens a new SQLite database.

Parameters

[in]	filename	Filename of the database
[in]	mode	See SqlOpenMode

Note

Call this only once!

tableExists()

bool tableExists

(

const std::string &

tablename

)

Checks whether the given table exists.

tablename The name of the table to be checked

Returns

Whether the table exists or not

Friends And Related Symbol Documentation

Internal::SqliteConnectorFriend

friend struct Internal::SqliteConnectorFriend

friend

Member Data Documentation

db_

void* db_ = nullptr

protected

Opaque native SQLite handle (really an sqlite3*), stored as void* so that this installed header names no SQLite type. The raw handle is only reachable from the non-installed SqliteConnector_impl.h via Internal::SqliteConnectorFriend.

Referenced by SqliteConnectorFriend::handle().