doc/gvmd-doc/sql_8h_source.html

/* Copyright (C) 2012-2022 Greenbone Networks GmbH

 *

 * SPDX-License-Identifier: AGPL-3.0-or-later

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Affero General Public License as

 * published by the Free Software Foundation, either version 3 of the

 * License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU Affero General Public License for more details.

 *

 * You should have received a copy of the GNU Affero General Public License

 * along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */


/*

 * @file sql.h

 * @brief Headers for Greenbone Vulnerability Manager: the SQL library.

 */


#ifndef _GVMD_SQL_H

#define _GVMD_SQL_H


#include "iterator.h"

#include "manage.h"


#include <glib.h>


/* Helpers. */


const char *

sql_schema ();


const char *

sql_greatest ();


const char *

sql_select_limit (int);


const char *

sql_regexp_op ();


const char *

sql_ilike_op ();


const char *

sql_database ();


const char *

sql_default_database ();


void

sql_recursive_triggers_off ();


int

sql_is_open ();


int

sql_open (const db_conn_info_t *);


void

sql_close ();


void

sql_close_fork ();


int

sql_changes ();


resource_t

sql_last_insert_id ();


gchar *

sql_nquote (const char *, size_t);


gchar *

sql_quote (const char *);


gchar *

sql_ascii_escape_and_quote (const char *);


gchar *

sql_insert (const char *);


void

sql (char *sql, ...);


int

sql_error (char *sql, ...);


int

sql_giveup (char *sql, ...);


void

sql_quiet (char *sql, ...);


double

sql_double (char *sql, ...);


int

sql_int (char *, ...);


char *

sql_string (char *, ...);


int

sql_int64 (long long int *ret, char *, ...);


long long int

sql_int64_0 (char *sql, ...);


void

sql_rename_column (const char *, const char *, const char *, const char *);


int

sql_cancel_internal ();


/* Transactions. */


void

sql_begin_immediate ();


int

sql_begin_immediate_giveup ();


void

sql_commit ();


void

sql_rollback ();


/* Iterators. */


/* These functions are for "internal" use.  They may only be accessed by code

 * that is allowed to run SQL statements directly. */


void

init_iterator (iterator_t *, const char *, ...);


void

iterator_rewind (iterator_t *iterator);


double

iterator_double (iterator_t *, int);


int

iterator_int (iterator_t *, int);


long long int

iterator_int64 (iterator_t *, int);


int

iterator_null (iterator_t *, int);


const char *

iterator_string (iterator_t *, int);


gchar **

iterator_array (iterator_t *, int);


const char *

iterator_column_name (iterator_t *, int);


int

iterator_column_count (iterator_t *);


#endif /* not _GVMD_SQL_H */

iterator.h
Headers for Iterators.

resource_t
long long int resource_t
A resource, like a task or target.
Definition: iterator.h:39

sql_rename_column
void sql_rename_column(const char *old_table, const char *new_table, const char *old_name, const char *new_name)
Move data from a table to a new table, heeding column rename.
Definition: manage_pg.c:140

iterator_double
double iterator_double(iterator_t *iterator, int col)
Get a double column from an iterator.
Definition: sql.c:621

sql_insert
gchar * sql_insert(const char *string)
Get the SQL insert expression for a string.
Definition: sql.c:198

sql_giveup
int sql_giveup(char *sql,...)
Perform an SQL statement, giving up if database is busy or locked.
Definition: sql.c:342

sql_int64_0
long long int sql_int64_0(char *sql,...)
Get a first column of first row from a SQL query, as an int64.
Definition: sql.c:562

iterator_int
int iterator_int(iterator_t *iterator, int col)
Get a int column from an iterator.
Definition: sql.c:636

init_iterator
void init_iterator(iterator_t *iterator, const char *sql,...)
Initialise an iterator.
Definition: sql.c:592

sql_quote
gchar * sql_quote(const char *string)
Quotes a string to be passed to sql statements.
Definition: sql.c:146

sql_error
int sql_error(char *sql,...)
Perform an SQL statement, retrying if database is busy or locked.
Definition: sql.c:310

iterator_string
const char * iterator_string(iterator_t *iterator, int col)
Get a string column from an iterator.
Definition: sql.c:666

sql_int64
int sql_int64(long long int *ret, char *sql,...)
Get a particular cell from a SQL query, as an int64.
Definition: sql.c:521

iterator_array
gchar ** iterator_array(iterator_t *iterator, int col)
Get a string column from an iterator.
Definition: sql.c:685

sql_nquote
gchar * sql_nquote(const char *string, size_t length)
Quotes a string of a known length to be passed to sql statements.
Definition: sql.c:101

sql_string
char * sql_string(char *sql,...)
Get a particular cell from a SQL query, as an string.
Definition: sql.c:489

sql
void sql(char *sql,...)
Perform an SQL statement, retrying if database is busy or locked.
Definition: sql.c:269

sql_int
int sql_int(char *sql,...)
Get a particular cell from a SQL query, as an int.
Definition: sql.c:458

iterator_int64
long long int iterator_int64(iterator_t *iterator, int col)
Get an integer column from an iterator.
Definition: sql.c:651

sql_double
double sql_double(char *sql,...)
Get the first value from a SQL query, as a double.
Definition: sql.c:424

sql_ascii_escape_and_quote
gchar * sql_ascii_escape_and_quote(const char *string)
Quotes a string for use in SQL statements, also ASCII escaping it if it is not valid UTF-8.
Definition: sql.c:161

db_conn_info_t
Data structure for info used to connect to the database.
Definition: manage.h:47

iterator
A generic SQL iterator structure.
Definition: iterator.h:50