/usr/include/zdb/ResultSet.h is in libzdb-dev 2.11.3-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | /*
* Copyright (C) Tildeslash Ltd. All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
*
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL.
*/
#ifndef RESULTSET_INCLUDED
#define RESULTSET_INCLUDED
/**
* A <b>ResultSet</b> represents a database result set. A ResultSet is
* created by executing a SQL SELECT statement using either
* Connection_executeQuery() or PreparedStatement_executeQuery().
*
* A ResultSet maintains a cursor pointing to its current row of data.
* Initially the cursor is positioned before the first row.
* ResultSet_next() moves the cursor to the next row, and because
* it returns false when there are no more rows in the ResultSet object,
* it can be used in a while loop to iterate through the result set.
* A ResultSet object is not updatable and has a cursor that moves forward
* only. Thus, you can iterate through it only once and only from the first
* row to the last row.
*
* The ResultSet interface provides getter methods for retrieving
* column values from the current row. Values can be retrieved using
* either the index number of the column or the name of the column. In
* general, using the column index will be more efficient. <i>Columns
* are numbered from 1.</i>
*
* Column names used as input to getter methods are case sensitive.
* When a getter method is called with a column name and several
* columns have the same name, the value of the first matching column
* will be returned. The column name option is designed to be used
* when column names are used in the SQL query that generated the
* result set. For columns that are NOT explicitly named in the query,
* it is best to use column indices.
*
* <h3>Example</h3>
* The following examples demonstrate how to obtain a ResultSet and
* how to get values from the set:
* <pre>
* ResultSet_T r = Connection_executeQuery(con, "SELECT ssn, name, picture FROM employees");
* while (ResultSet_next(r))
* {
* int ssn = ResultSet_getIntByName(r, "ssn");
* const char *name = ResultSet_getStringByName(r, "name");
* int pictureSize;
* const void *picture = ResultSet_getBlobByName(r, "picture", &pictureSize);
* [..]
* }
* </pre>
* Here is another example where a generated result is selected and printed:
* <pre>
* ResultSet_T r = Connection_executeQuery(con, "SELECT count(*) FROM users");
* printf("Number of users: %s\n", ResultSet_next(r) ? ResultSet_getString(r, 1) : "no users");
* </pre>
*
* <h3>Automatic type conversions</h3>
* A ResultSet store values internally as bytes and convert values
* on-the-fly to numeric types when requested, such as when ResultSet_getInt()
* or one of the other numeric get-methods are called. In the above example,
* even if <i>count(*)</i> returns a numeric value, we can use
* ResultSet_getString() to get the number as a string or if we choose, we can use
* ResultSet_getInt() to get the value as an integer. In the latter case, note
* that if the column value cannot be converted to a number, an SQLException is thrown.
*
* <i>A ResultSet is reentrant, but not thread-safe and should only be used by one thread (at the time).</i>
*
* @see Connection.h PreparedStatement.h SQLException.h
* @file
*/
#define T ResultSet_T
typedef struct ResultSet_S *T;
/** @name Properties */
//@{
/**
* Returns the number of columns in this ResultSet object.
* @param R A ResultSet object
* @return The number of columns
*/
int ResultSet_getColumnCount(T R);
/**
* Get the designated column's name.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return Column name or NULL if the column does not exist. You
* should use the method ResultSet_getColumnCount() to test for
* the availablity of columns in the result set.
*/
const char *ResultSet_getColumnName(T R, int columnIndex);
/**
* Returns column size in bytes. If the column is a blob then
* this method returns the number of bytes in that blob. No type
* conversions occur. If the result is a string (or a number
* since a number can be converted into a string) then return the
* number of bytes in the resulting string.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return Column data size
* @exception SQLException if columnIndex is outside the valid range
* @see SQLException.h
*/
long ResultSet_getColumnSize(T R, int columnIndex);
//@}
/**
* Moves the cursor down one row from its current position. A
* ResultSet cursor is initially positioned before the first row; the
* first call to this method makes the first row the current row; the
* second call makes the second row the current row, and so on. When
* there are not more available rows false is returned. An empty
* ResultSet will return false on the first call to ResultSet_next().
* @param R A ResultSet object
* @return true if the new current row is valid; false if there are no
* more rows
* @exception SQLException if a database access error occurs
*/
int ResultSet_next(T R);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a C-string. If <code>columnIndex</code>
* is outside the range [1..ResultSet_getColumnCount()] this
* method throws an SQLException. <i>The returned string may only be
* valid until the next call to ResultSet_next() and if you plan to use
* the returned value longer, you must make a copy.</i>
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return The column value; if the value is SQL NULL, the value
* returned is NULL
* @exception SQLException if a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
const char *ResultSet_getString(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a C-string. If <code>columnName</code>
* is not found this method throws an SQLException. <i>The returned string
* may only be valid until the next call to ResultSet_next() and if you plan
* to use the returned value longer, you must make a copy.</i>
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return The column value; if the value is SQL NULL, the value
* returned is NULL
* @exception SQLException if a database access error occurs or
* columnName does not exist
* @see SQLException.h
*/
const char *ResultSet_getStringByName(T R, const char *columnName);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as an int. If <code>columnIndex</code>
* is outside the range [1..ResultSet_getColumnCount()] this
* method throws an SQLException.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return The column value; if the value is SQL NULL, the value
* returned is 0
* @exception SQLException if a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
int ResultSet_getInt(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as an int. If <code>columnName</code> is not
* found this method throws an SQLException.
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return The column value; if the value is SQL NULL, the value
* returned is 0
* @exception SQLException if a database access error occurs or
* columnName does not exist
* @see SQLException.h
*/
int ResultSet_getIntByName(T R, const char *columnName);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a long long. If <code>columnIndex</code>
* is outside the range [1..ResultSet_getColumnCount()] this
* method throws an SQLException.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return The column value; if the value is SQL NULL, the value
* returned is 0
* @exception SQLException if a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
long long int ResultSet_getLLong(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a long long. If <code>columnName</code>
* is not found this method throws an SQLException.
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return The column value; if the value is SQL NULL, the value
* returned is 0
* @exception SQLException if a database access error occurs or
* columnName does not exist
* @see SQLException.h
*/
long long int ResultSet_getLLongByName(T R, const char *columnName);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a double. If <code>columnIndex</code>
* is outside the range [1..ResultSet_getColumnCount()] this
* method throws an SQLException.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return The column value; if the value is SQL NULL, the value
* returned is 0.0
* @exception SQLException if a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
double ResultSet_getDouble(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a double. If <code>columnName</code> is
* not found this method throws an SQLException.
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return The column value; if the value is SQL NULL, the value
* returned is 0.0
* @exception SQLException if a database access error occurs or
* columnName does not exist
* @see SQLException.h
*/
double ResultSet_getDoubleByName(T R, const char *columnName);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a void pointer. If <code>columnIndex</code>
* is outside the range [1..ResultSet_getColumnCount()] this method
* throws an SQLException. <i>The returned blob may only be valid until
* the next call to ResultSet_next() and if you plan to use the returned
* value longer, you must make a copy.</i>
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @param size The number of bytes in the blob is stored in size
* @return The column value; if the value is SQL NULL, the value
* returned is NULL
* @exception SQLException if a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
const void *ResultSet_getBlob(T R, int columnIndex, int *size);
/**
* Retrieves the value of the designated column in the current row of
* this ResultSet object as a void pointer. If <code>columnName</code>
* is not found this method throws an SQLException. <i>The returned
* blob may only be valid until the next call to ResultSet_next() and if
* you plan to use the returned value longer, you must make a copy.</i>
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @param size The number of bytes in the blob is stored in size
* @return The column value; if the value is SQL NULL, the value
* returned is NULL
* @exception SQLException if a database access error occurs or
* columnName does not exist
* @see SQLException.h
*/
const void *ResultSet_getBlobByName(T R, const char *columnName, int *size);
#undef T
#endif
|