mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-31 02:37:10 +00:00
odbc: Fix for Doxygen.
ASTERISK-29754 Change-Id: Ia09eb68d283d201d9a6fbeccfc0efe83fe0502a5
This commit is contained in:
Alexander Traud
committed by
George Joseph
George Joseph
parent
f800f23d9c
commit
c37e1ceb5a
@@ -158,13 +158,13 @@ static SQLHSTMT custom_prepare(struct odbc_obj *obj, void *data)
|
||||
* \brief Execute an SQL query and return ast_variable list
|
||||
* \param database
|
||||
* \param table
|
||||
* \param ap list containing one or more field/operator/value set.
|
||||
* \param fields list containing one or more field/operator/value set.
|
||||
*
|
||||
* Select database and preform query on table, prepare the sql statement
|
||||
* Sub-in the values to the prepared statement and execute it. Return results
|
||||
* as a ast_variable list.
|
||||
*
|
||||
* \retval var on success
|
||||
* \return var on success
|
||||
* \retval NULL on failure
|
||||
*/
|
||||
static struct ast_variable *realtime_odbc(const char *database, const char *table, const struct ast_variable *fields)
|
||||
@@ -329,14 +329,14 @@ static struct ast_variable *realtime_odbc(const char *database, const char *tabl
|
||||
* \brief Execute an Select query and return ast_config list
|
||||
* \param database
|
||||
* \param table
|
||||
* \param ap list containing one or more field/operator/value set.
|
||||
* \param fields list containing one or more field/operator/value set.
|
||||
*
|
||||
* Select database and preform query on table, prepare the sql statement
|
||||
* Sub-in the values to the prepared statement and execute it.
|
||||
* Execute this prepared query against several ODBC connected databases.
|
||||
* Return results as an ast_config variable.
|
||||
*
|
||||
* \retval var on success
|
||||
* \return var on success
|
||||
* \retval NULL on failure
|
||||
*/
|
||||
static struct ast_config *realtime_multi_odbc(const char *database, const char *table, const struct ast_variable *fields)
|
||||
@@ -504,13 +504,13 @@ next_sql_fetch:;
|
||||
* \param table
|
||||
* \param keyfield where clause field
|
||||
* \param lookup value of field for where clause
|
||||
* \param ap list containing one or more field/value set(s).
|
||||
* \param fields list containing one or more field/value set(s).
|
||||
*
|
||||
* Update a database table, prepare the sql statement using keyfield and lookup
|
||||
* control the number of records to change. All values to be changed are stored in ap list.
|
||||
* Sub-in the values to the prepared statement and execute it.
|
||||
*
|
||||
* \retval number of rows affected
|
||||
* \return number of rows affected
|
||||
* \retval -1 on failure
|
||||
*/
|
||||
static int update_odbc(const char *database, const char *table, const char *keyfield, const char *lookup, const struct ast_variable *fields)
|
||||
@@ -660,16 +660,15 @@ static SQLHSTMT update2_prepare(struct odbc_obj *obj, void *data)
|
||||
|
||||
/*!
|
||||
* \brief Execute an UPDATE query
|
||||
* \param database
|
||||
* \param table
|
||||
* \param ap list containing one or more field/value set(s).
|
||||
* \param database, table, lookup_fields
|
||||
* \param update_fields list containing one or more field/value set(s).
|
||||
*
|
||||
* Update a database table, preparing the sql statement from a list of
|
||||
* key/value pairs specified in ap. The lookup pairs are specified first
|
||||
* and are separated from the update pairs by a sentinel value.
|
||||
* Sub-in the values to the prepared statement and execute it.
|
||||
*
|
||||
* \retval number of rows affected
|
||||
* \return number of rows affected
|
||||
* \retval -1 on failure
|
||||
*/
|
||||
static int update2_odbc(const char *database, const char *table, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields)
|
||||
@@ -729,13 +728,13 @@ static int update2_odbc(const char *database, const char *table, const struct as
|
||||
* \brief Execute an INSERT query
|
||||
* \param database
|
||||
* \param table
|
||||
* \param ap list containing one or more field/value set(s)
|
||||
* \param fields list containing one or more field/value set(s)
|
||||
*
|
||||
* Insert a new record into database table, prepare the sql statement.
|
||||
* All values to be changed are stored in ap list.
|
||||
* Sub-in the values to the prepared statement and execute it.
|
||||
*
|
||||
* \retval number of rows affected
|
||||
* \return number of rows affected
|
||||
* \retval -1 on failure
|
||||
*/
|
||||
static int store_odbc(const char *database, const char *table, const struct ast_variable *fields)
|
||||
@@ -812,13 +811,13 @@ static int store_odbc(const char *database, const char *table, const struct ast_
|
||||
* \param table
|
||||
* \param keyfield where clause field
|
||||
* \param lookup value of field for where clause
|
||||
* \param ap list containing one or more field/value set(s)
|
||||
* \param fields list containing one or more field/value set(s)
|
||||
*
|
||||
* Delete a row from a database table, prepare the sql statement using keyfield and lookup
|
||||
* control the number of records to change. Additional params to match rows are stored in ap list.
|
||||
* Sub-in the values to the prepared statement and execute it.
|
||||
*
|
||||
* \retval number of rows affected
|
||||
* \return number of rows affected
|
||||
* \retval -1 on failure
|
||||
*/
|
||||
static int destroy_odbc(const char *database, const char *table, const char *keyfield, const char *lookup, const struct ast_variable *fields)
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
* \author Anthony Minessale II <anthmct@yahoo.com>
|
||||
* \author Tilghman Lesher <tilghman@digium.com>
|
||||
*
|
||||
* \arg See also: \ref cdr_odbc
|
||||
* \arg See also: \ref cdr_odbc.c
|
||||
*/
|
||||
|
||||
/*! \li \ref res_odbc.c uses the configuration file \ref res_odbc.conf
|
||||
@@ -215,13 +215,6 @@ static void destroy_table_cache(struct odbc_cache_tables *table)
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Find or create an entry describing the table specified.
|
||||
* \param database Name of an ODBC class on which to query the table
|
||||
* \param tablename Tablename to describe
|
||||
* \retval A structure describing the table layout, or NULL, if the table is not found or another error occurs.
|
||||
* When a structure is returned, the contained columns list will be
|
||||
* rdlock'ed, to ensure that it will be retained in memory.
|
||||
*
|
||||
* XXX This creates a connection and disconnects it. In some situations, the caller of
|
||||
* this function has its own connection and could donate it to this function instead of
|
||||
* needing to create another one.
|
||||
@@ -235,8 +228,6 @@ static void destroy_table_cache(struct odbc_cache_tables *table)
|
||||
* the need to cache tables is questionable. Instead, the table structure can be fetched from
|
||||
* the DB directly each time, resulting in a single owner of the data.
|
||||
* * Make odbc_cache_tables a refcounted object.
|
||||
*
|
||||
* \since 1.6.1
|
||||
*/
|
||||
struct odbc_cache_tables *ast_odbc_find_table(const char *database, const char *tablename)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user