Generic SQL interface: PostgreSQL backend. More...

#include "sql.h"
#include <assert.h>
#include <endian.h>
#include <errno.h>
#include <arpa/inet.h>
#include <glib.h>
#include <inttypes.h>
#include <netinet/in.h>
#include <libpq-fe.h>
#include <stdlib.h>
#include <string.h>
#include <gvm/base/array.h>
#include <execinfo.h>

Data Structures
struct	sql_stmt
	An SQL statement. More...

Macros
#define	G_LOG_DOMAIN "md manage"
	GLib log domain.

#define	BA_SIZE 100
	Maximum number of frames in backtrace. More...

Functions
int	sql_x (char , va_list args, sql_stmt_t *)
	Get a particular cell from a SQL query. More...

const char *	sql_schema ()
	Get main schema name. More...

const char *	sql_greatest ()
	Get keyword for "greatest" SQL function. More...

const char *	sql_select_limit (int max)
	Setup a LIMIT argument. More...

static void	sql_stmt_init (sql_stmt_t *stmt)
	Init statement, preserving SQL. More...

const char *	sql_ilike_op ()
	Get case insensitive LIKE operator. More...

const char *	sql_regexp_op ()
	Get regular expression operator. More...

int	sql_is_open ()
	Check whether the database is open. More...

static void	log_notice (void arg, const PGresult result)
	Log a NOTICE message. More...

const char *	sql_database ()
	Return name of current database. More...

const char *	sql_default_database ()
	Return name of default database. More...

int	sql_open (const db_conn_info_t *database)
	Open the database. More...

void	sql_close ()
	Close the database.

void	sql_close_fork ()
	Close the database in a forked process.

int	sql_changes ()
	Return 0. More...

resource_t	sql_last_insert_id ()
	Get the ID of the last inserted row. More...

int	sql_prepare_internal (int retry, int log, const char sql, va_list args, sql_stmt_t *stmt)
	Prepare a statement. More...

int	sql_exec_internal (int retry, sql_stmt_t *stmt)
	Execute a statement. More...

void	sql_begin_immediate ()
	Begin an immediate transaction.

int	sql_begin_immediate_giveup ()
	Begin an immediate transaction. More...

void	sql_commit ()
	Commit a transaction.

void	sql_rollback ()
	Roll a transaction back.

int	iterator_null (iterator_t *iterator, int col)
	Get whether a column is NULL. More...

void	iterator_rewind (iterator_t *iterator)
	Rewind an iterator to the beginning. More...

void	sql_finalize (sql_stmt_t *stmt)
	Free a statement. More...

double	sql_column_double (sql_stmt_t *stmt, int position)
	Return a column as a double from a statement. More...

const char *	sql_column_text (sql_stmt_t *stmt, int position)
	Return a column as text from a statement. More...

int	sql_column_int (sql_stmt_t *stmt, int position)
	Return a column as an integer from a statement. More...

long long int	sql_column_int64 (sql_stmt_t *stmt, int position)
	Return a column as an int64 from a statement. More...

gchar **	sql_column_array (sql_stmt_t *stmt, int position)
	Return a column as text from a statement. More...

int	sql_cancel_internal ()
	Cancels the current SQL statement. More...

Variables
int	log_errors
	Whether to log errors. More...

static PGconn *	conn = NULL
	Handle on the database.

Detailed Description

Generic SQL interface: PostgreSQL backend.

PostreSQL backend of the SQL interface.

Macro Definition Documentation

◆ BA_SIZE

#define BA_SIZE 100

Maximum number of frames in backtrace.

For debugging backtrace in log_notice.

Function Documentation

◆ iterator_null()

int iterator_null	(	iterator_t *	iterator,
		int	col
	)

Get whether a column is NULL.

Parameters

[in]	iterator	Iterator.
[in]	col	Column offset.

Returns: 1 if NULL, else 0.

◆ iterator_rewind()

void iterator_rewind ( iterator_t * iterator )

Rewind an iterator to the beginning.

This lets the caller iterate over the data again.

Parameters

[in] iterator Iterator.

◆ log_notice()

static void log_notice	(	void *	arg,
		const PGresult *	result
	)

static

Log a NOTICE message.

Parameters

[in]	arg	Dummy arg.
[in]	result	Arg.

◆ sql_begin_immediate_giveup()

int sql_begin_immediate_giveup ( )

Begin an immediate transaction.

Returns: 0 got lock, 1 gave up, -1 error.

◆ sql_cancel_internal()

int sql_cancel_internal ( )

Cancels the current SQL statement.

Returns: 0 on success, -1 on error.

◆ sql_changes()

int sql_changes ( )

Return 0.

Returns: 0.

◆ sql_column_array()

gchar** sql_column_array	(	sql_stmt_t *	stmt,
		int	position
	)

Return a column as text from a statement.

It's up to the caller to ensure that there is a row available.

Parameters

[in]	stmt	Statement.
[in]	position	Column position.

Returns: Column value. NULL if column is NULL.

◆ sql_column_double()

double sql_column_double	(	sql_stmt_t *	stmt,
		int	position
	)

Return a column as a double from a statement.

It's up to the caller to ensure that there is a row available.

Parameters

[in]	stmt	Statement.
[in]	position	Column position.

Returns: 0 success, -1 error.

◆ sql_column_int()

int sql_column_int	(	sql_stmt_t *	stmt,
		int	position
	)

Return a column as an integer from a statement.

It's up to the caller to ensure that there is a row available.

Parameters

[in]	stmt	Statement.
[in]	position	Column position.

Returns: Column value. 0 if column is NULL or false. 1 if column true.

◆ sql_column_int64()

long long int sql_column_int64	(	sql_stmt_t *	stmt,
		int	position
	)

Return a column as an int64 from a statement.

It's up to the caller to ensure that there is a row available.

Parameters

[in]	stmt	Statement.
[in]	position	Column position.

Returns: Column value. 0 if column is NULL or false. 1 if column true.

◆ sql_column_text()

const char* sql_column_text	(	sql_stmt_t *	stmt,
		int	position
	)

Return a column as text from a statement.

It's up to the caller to ensure that there is a row available.

Parameters

[in]	stmt	Statement.
[in]	position	Column position.

Returns: Column value. NULL if column is NULL.

◆ sql_database()

const char* sql_database ( )

Return name of current database.

Returns: Name of database.

◆ sql_default_database()

const char* sql_default_database ( )

Return name of default database.

Returns: Name.

◆ sql_exec_internal()

int sql_exec_internal	(	int	retry,
		sql_stmt_t *	stmt
	)

Execute a statement.

Parameters

[in]	retry	Whether to keep retrying while database is busy or locked.
[in]	stmt	Statement.

Returns: 0 complete, 1 row available in results, -1 error, -2 gave up, -3 lock unavailable, -4 unique constraint violation.

◆ sql_finalize()

void sql_finalize ( sql_stmt_t * stmt )

Free a statement.

Parameters

[in] stmt Statement.

◆ sql_greatest()

const char* sql_greatest ( )

Get keyword for "greatest" SQL function.

Returns: Keyword.

◆ sql_ilike_op()

const char* sql_ilike_op ( )

Get case insensitive LIKE operator.

Returns: Like operator.

◆ sql_is_open()

int sql_is_open ( )

Check whether the database is open.

Returns: 1 if open, else 0.

◆ sql_last_insert_id()

resource_t sql_last_insert_id ( )

Get the ID of the last inserted row.

Returns: Resource.

◆ sql_open()

int sql_open ( const db_conn_info_t * database )

Open the database.

Parameters

[in] database Database, or NULL for default.

Returns: 0 success, -1 error.

◆ sql_prepare_internal()

int sql_prepare_internal	(	int	retry,
		int	log,
		const char *	sql,
		va_list	args,
		sql_stmt_t **	stmt
	)

Prepare a statement.

Parameters

[in]	retry	Whether to keep retrying while database is busy or locked.
[in]	log	Whether to keep retrying while database is busy or locked.
[in]	sql	Format string for SQL statement.
[in]	args	Arguments for format string.
[out]	stmt	Statement return.

Returns: 0 success, 1 gave up, -1 error.

◆ sql_regexp_op()

const char* sql_regexp_op ( )

Get regular expression operator.

Returns: Regexp operator.

◆ sql_schema()

const char* sql_schema ( )

Get main schema name.

Returns: Schema name.

◆ sql_select_limit()

const char* sql_select_limit ( int max )

Setup a LIMIT argument.

Parameters

[in] max Max.

Returns: Argument for LIMIT as a static string.

◆ sql_stmt_init()

static void sql_stmt_init ( sql_stmt_t * stmt )

static

Init statement, preserving SQL.

Parameters

[in] stmt Statement.

◆ sql_x()

int sql_x	(	char *	sql,
		va_list	args,
		sql_stmt_t **	stmt_return
	)

Get a particular cell from a SQL query.

Parameters

[in]	sql	Format string for SQL query.
[in]	args	Arguments for format string.
[out]	stmt_return	Return from statement.

Returns: 0 success, 1 too few rows, -1 error.

Variable Documentation

◆ log_errors

int log_errors

extern

Whether to log errors.

Used to turn off logging when cancelling statements on exit. Defined in sql.c.

Used to turn off logging when cancelling statements on exit.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BA_SIZE

Function Documentation

◆ iterator_null()

◆ iterator_rewind()

◆ log_notice()

◆ sql_begin_immediate_giveup()

◆ sql_cancel_internal()

◆ sql_changes()

◆ sql_column_array()

◆ sql_column_double()

◆ sql_column_int()

◆ sql_column_int64()

◆ sql_column_text()

◆ sql_database()

◆ sql_default_database()

◆ sql_exec_internal()

◆ sql_finalize()

◆ sql_greatest()

◆ sql_ilike_op()

◆ sql_is_open()

◆ sql_last_insert_id()

◆ sql_open()

◆ sql_prepare_internal()

◆ sql_regexp_op()

◆ sql_schema()

◆ sql_select_limit()

◆ sql_stmt_init()

◆ sql_x()

Variable Documentation

◆ log_errors