Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes out of scope or is reset. More...

#include <qgssqliteutils.h>

Inheritance diagram for sqlite3_database_unique_ptr:

[legend]

Public Member Functions
QString	errorMessage () const
	Returns the most recent error message encountered by the database. More...

int	exec (const QString &sql, QString &errorMessage) const
	Executes the sql command in the database. More...

int	open (const QString &path)
	Opens the database at the specified file path. More...

int	open_v2 (const QString &path, int flags, const char *zVfs)
	Opens the database at the specified file path. More...

sqlite3_statement_unique_ptr	prepare (const QString &sql, int &resultCode) const
	Prepares a sql statement, returning the result. More...

Detailed Description

Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes out of scope or is reset.

Since: QGIS 3.0

Definition at line 118 of file qgssqliteutils.h.

Member Function Documentation

◆ errorMessage()

QString sqlite3_database_unique_ptr::errorMessage ( ) const

Returns the most recent error message encountered by the database.

Definition at line 94 of file qgssqliteutils.cpp.

◆ exec()

int sqlite3_database_unique_ptr::exec	(	const QString &	sql,
		QString &	errorMessage
	)		const

Executes the sql command in the database.

Multiple sql queries can be run within one single command. Errors are reported to errorMessage. Returns SQLITE_OK in case of success or an sqlite error code.

Since: QGIS 3.6

Definition at line 109 of file qgssqliteutils.cpp.

◆ open()

int sqlite3_database_unique_ptr::open ( const QString & path )

Opens the database at the specified file path.

Returns the sqlite error code, or SQLITE_OK if open was successful.

Definition at line 78 of file qgssqliteutils.cpp.

◆ open_v2()

int sqlite3_database_unique_ptr::open_v2	(	const QString &	path,
		int	flags,
		const char *	zVfs
	)

Opens the database at the specified file path.

Returns the sqlite error code, or SQLITE_OK if open was successful.

Definition at line 86 of file qgssqliteutils.cpp.

◆ prepare()

sqlite3_statement_unique_ptr sqlite3_database_unique_ptr::prepare	(	const QString &	sql,
		int &	resultCode
	)		const

Prepares a sql statement, returning the result.

The resultCode argument will be filled with the sqlite3 result code.

Definition at line 99 of file qgssqliteutils.cpp.

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

/build/qgis-3.22.4+99unstable/src/core/qgssqliteutils.h
/build/qgis-3.22.4+99unstable/src/core/qgssqliteutils.cpp