/usr/include/zdb/ResultSet.h is in libzdb-dev 3.1-0.2.
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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 | /*
* 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
#include <time.h>
/**
* 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, it can be used in a while
* loop to iterate through the result set. A ResultSet 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 employees");
* printf("Number of employees: %s\n", ResultSet_next(r) ? ResultSet_getString(r, 1) : "none");
* </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.
*
* <h3>Date and Time</h3>
* Result Set provides two principal methods for retrieving temporal column
* values as C types. ResultSet_getTimestamp() converts a SQL timestamp value
* to a <code>time_t</code> and ResultSet_getDateTime() returns a
* <code>tm structure</code> representing a SQL Date, Time, DateTime or Timestamp
* column type. To get a temporal column value as a string, simply use ResultSet_getString()
*
* <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 availability 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);
/** @name Columns */
//@{
/**
* Returns true if the value of the designated column in the current row of
* this ResultSet object is SQL NULL, otherwise false. If the column value is
* SQL NULL, a Result Set returns the NULL pointer for string and blob values
* and 0 for primitive data types. Use this method if you need to differ
* between SQL NULL and the value NULL/0.
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return True if column value is SQL NULL, otherwise false
* @exception SQLException If a database access error occurs or
* columnIndex is outside the valid range
* @see SQLException.h
*/
int ResultSet_isnull(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>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.
* In general, on both 32 and 64 bits architecture, <code>int</code> is 4 bytes
* or 32 bits and <code>long long</code> is 8 bytes or 64 bits. A
* <code>long</code> type is usually equal to <code>int</code> on 32 bits
* architecture and equal to <code>long long</code> on 64 bits architecture.
* However, the width of integer types are architecture and compiler dependent.
* The above is usually true, but not necessarily.
* @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, columnIndex
* is outside the valid range or if the value is NaN
* @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.
* In general, on both 32 and 64 bits architecture, <code>int</code> is 4 bytes
* or 32 bits and <code>long long</code> is 8 bytes or 64 bits. A
* <code>long</code> type is usually equal to <code>int</code> on 32 bits
* architecture and equal to <code>long long</code> on 64 bits architecture.
* However, the width of integer types are architecture and compiler dependent.
* The above is usually true, but not necessarily.
* @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, columnName
* does not exist or if the value is NaN
* @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.
* In general, on both 32 and 64 bits architecture, <code>int</code> is 4 bytes
* or 32 bits and <code>long long</code> is 8 bytes or 64 bits. A
* <code>long</code> type is usually equal to <code>int</code> on 32 bits
* architecture and equal to <code>long long</code> on 64 bits architecture.
* However, the width of integer types are architecture and compiler dependent.
* The above is usually true, but not necessarily.
* @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,
* columnIndex is outside the valid range or if the value is NaN
* @see SQLException.h
*/
long long 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.
* In general, on both 32 and 64 bits architecture, <code>int</code> is 4 bytes
* or 32 bits and <code>long long</code> is 8 bytes or 64 bits. A
* <code>long</code> type is usually equal to <code>int</code> on 32 bits
* architecture and equal to <code>long long</code> on 64 bits architecture.
* However, the width of integer types are architecture and compiler dependent.
* The above is usually true, but not necessarily.
* @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, columnName
* does not exist or if the value is NaN
* @see SQLException.h
*/
long long 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, columnIndex
* is outside the valid range or if the value is NaN
* @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, columnName
* does not exist or if the value is NaN
* @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);
//@}
/** @name Date and Time */
//@{
/**
* Retrieves the value of the designated column in the current row of this
* ResultSet object as a Unix timestamp. The returned value is in Coordinated
* Universal Time (UTC) and represent seconds since the <strong>epoch</strong>
* (January 1, 1970, 00:00:00 GMT).
*
* Even though the underlying database might support timestamp ranges before
* the epoch and after '2038-01-19 03:14:07 UTC' it is safest not to assume or
* use values outside this range. Especially on a 32-bits system.
*
* <i class="textinfo">SQLite</i> does not have temporal SQL data types per se
* and using this method with SQLite assume the column value in the Result Set
* to be either a numerical value representing a Unix Time in UTC which is
* returned as-is or an <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>
* time string which is converted to a time_t value.
* See also PreparedStatement_setTimestamp()
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return The column value as seconds since the epoch in the
* <i class="textinfo">GMT timezone</i>. If the value is SQL NULL, the
* value returned is 0, i.e. January 1, 1970, 00:00:00 GMT
* @exception SQLException If a database access error occurs, if
* <code>columnIndex</code> is outside the range [1..ResultSet_getColumnCount()]
* or if the column value cannot be converted to a valid timestamp
* @see SQLException.h PreparedStatement_setTimestamp
*/
time_t ResultSet_getTimestamp(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of this
* ResultSet object as a Unix timestamp. The returned value is in Coordinated
* Universal Time (UTC) and represent seconds since the <strong>epoch</strong>
* (January 1, 1970, 00:00:00 GMT).
*
* Even though the underlying database might support timestamp ranges before
* the epoch and after '2038-01-19 03:14:07 UTC' it is safest not to assume or
* use values outside this range. Especially on a 32-bits system.
*
* <i class="textinfo">SQLite</i> does not have temporal SQL data types per se
* and using this method with SQLite assume the column value in the Result Set
* to be either a numerical value representing a Unix Time in UTC which is
* returned as-is or an <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>
* time string which is converted to a time_t value.
* See also PreparedStatement_setTimestamp()
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return The column value as seconds since the epoch in the
* <i class="textinfo">GMT timezone</i>. If the value is SQL NULL, the
* value returned is 0, i.e. January 1, 1970, 00:00:00 GMT
* @exception SQLException If a database access error occurs, if
* <code>columnName</code> is not found or if the column value cannot be
* converted to a valid timestamp
* @see SQLException.h PreparedStatement_setTimestamp
*/
time_t ResultSet_getTimestampByName(T R, const char *columnName);
/**
* Retrieves the value of the designated column in the current row of this
* ResultSet object as a Date, Time or DateTime. This method can be used to
* retrieve the value of columns with the SQL data type, Date, Time, DateTime
* or Timestamp. The returned <code>tm</code> structure follows the convention
* for usage with mktime(3) where, tm_hour = hours since midnight [0-23],
* tm_min = minutes after the hour [0-59], tm_sec = seconds after the minute
* [0-60], tm_mday = day of the month [1-31] and tm_mon = months since January
* <b class="textnote">[0-11]</b>. If the column value contains timezone
* information, tm_gmtoff is set to the offset from UTC in seconds, otherwise
* tm_gmtoff is set to 0. <i>On systems without tm_gmtoff, (Solaris), the
* member, tm_wday is set to gmt offset instead as this property is ignored
* by mktime on input.</i> The exception to the above is <b class="textnote">tm_year</b>
* which contains the year literal and <i>not years since 1900</i> which is the
* convention. All other fields in the structure are set to zero. If the
* column type is DateTime or Timestamp all the fields mentioned above are
* set, if it is a Date or Time, only the relevant fields are set.
*
* @param R A ResultSet object
* @param columnIndex The first column is 1, the second is 2, ...
* @return A tm structure with fields for date and time. If the value
* is SQL NULL, a zeroed tm structure is returned
* @exception SQLException If a database access error occurs, if
* <code>columnIndex</code> is outside the range [1..ResultSet_getColumnCount()]
* or if the column value cannot be converted to a valid SQL Date, Time or
* DateTime type
* @see SQLException.h
*/
struct tm ResultSet_getDateTime(T R, int columnIndex);
/**
* Retrieves the value of the designated column in the current row of this
* ResultSet object as a Date, Time or DateTime. This method can be used to
* retrieve the value of columns with the SQL data type, Date, Time, DateTime
* or Timestamp. The returned <code>tm</code> structure follows the convention
* for usage with mktime(3) where, tm_hour = hours since midnight [0-23],
* tm_min = minutes after the hour [0-59], tm_sec = seconds after the minute
* [0-60], tm_mday = day of the month [1-31] and tm_mon = months since January
* <b class="textnote">[0-11]</b>. If the column value contains timezone
* information, tm_gmtoff is set to the offset from UTC in seconds, otherwise
* tm_gmtoff is set to 0. <i>On systems without tm_gmtoff, (Solaris), the
* member, tm_wday is set to gmt offset instead as this property is ignored
* by mktime on input.</i> The exception to the above is <b class="textnote">tm_year</b>
* which contains the year literal and <i>not years since 1900</i> which is the
* convention. All other fields in the structure are set to zero. If the
* column type is DateTime or Timestamp all the fields mentioned above are
* set, if it is a Date or Time, only the relevant fields are set.
*
* @param R A ResultSet object
* @param columnName The SQL name of the column. <i>case-sensitive</i>
* @return A tm structure with fields for date and time. If the value
* is SQL NULL, a zeroed tm structure is returned
* @exception SQLException If a database access error occurs, if
* <code>columnName</code> is not found or if the column value cannot be
* converted to a valid SQL Date, Time or DateTime type
* @see SQLException.h
*/
struct tm ResultSet_getDateTimeByName(T R, const char *columnName);
//@}
#undef T
#endif
|