1<?xml version="1.0" encoding="iso-8859-1"?> 2<!DOCTYPE html 3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 7<head> 8 <title>Class: SQLRCursor</title> 9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> 10 <meta http-equiv="Content-Script-Type" content="text/javascript" /> 11 <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> 12 <script type="text/javascript"> 13 // <![CDATA[ 14 15 function popupCode( url ) { 16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") 17 } 18 19 function toggleCode( id ) { 20 if ( document.getElementById ) 21 elem = document.getElementById( id ); 22 else if ( document.all ) 23 elem = eval( "document.all." + id ); 24 else 25 return false; 26 27 elemStyle = elem.style; 28 29 if ( elemStyle.display != "block" ) { 30 elemStyle.display = "block" 31 } else { 32 elemStyle.display = "none" 33 } 34 35 return true; 36 } 37 38 // Make codeblocks hidden by default 39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) 40 41 // ]]> 42 </script> 43 44</head> 45<body> 46 47 48 49 <div id="classHeader"> 50 <table class="header-table"> 51 <tr class="top-aligned-row"> 52 <td><strong>Class</strong></td> 53 <td class="class-name-in-header">SQLRCursor</td> 54 </tr> 55 <tr class="top-aligned-row"> 56 <td><strong>In:</strong></td> 57 <td> 58 <a href="../files/sqlrelay_cpp.html"> 59 sqlrelay.cpp 60 </a> 61 <br /> 62 </td> 63 </tr> 64 65 <tr class="top-aligned-row"> 66 <td><strong>Parent:</strong></td> 67 <td> 68 Object 69 </td> 70 </tr> 71 </table> 72 </div> 73 <!-- banner header --> 74 75 <div id="bodyContent"> 76 77 78 79 <div id="contextContent"> 80 81 82 83 </div> 84 85 <div id="method-list"> 86 <h3 class="section-bar">Methods</h3> 87 88 <div class="name-list"> 89 <a href="#M000051">affectedRows</a> 90 <a href="#M000012">cacheOff</a> 91 <a href="#M000009">cacheToFile</a> 92 <a href="#M000022">clearBinds</a> 93 <a href="#M000085">closeResultSet</a> 94 <a href="#M000048">colCount</a> 95 <a href="#M000023">countBindVariables</a> 96 <a href="#M000031">defineOutputBindBlob</a> 97 <a href="#M000032">defineOutputBindClob</a> 98 <a href="#M000033">defineOutputBindCursor</a> 99 <a href="#M000030">defineOutputBindDouble</a> 100 <a href="#M000029">defineOutputBindInteger</a> 101 <a href="#M000028">defineOutputBindString</a> 102 <a href="#M000004">dontGetColumnInfo</a> 103 <a href="#M000053">endOfResultSet</a> 104 <a href="#M000054">errorMessage</a> 105 <a href="#M000055">errorNumber</a> 106 <a href="#M000038">executeQuery</a> 107 <a href="#M000039">fetchFromBindCursor</a> 108 <a href="#M000052">firstRowIndex</a> 109 <a href="#M000011">getCacheFileName</a> 110 <a href="#M000005">getColumnInfo</a> 111 <a href="#M000079">getColumnIsAutoIncrement</a> 112 <a href="#M000078">getColumnIsBinary</a> 113 <a href="#M000072">getColumnIsNullable</a> 114 <a href="#M000075">getColumnIsPartOfKey</a> 115 <a href="#M000073">getColumnIsPrimaryKey</a> 116 <a href="#M000074">getColumnIsUnique</a> 117 <a href="#M000076">getColumnIsUnsigned</a> 118 <a href="#M000077">getColumnIsZeroFilled</a> 119 <a href="#M000069">getColumnLength</a> 120 <a href="#M000015">getColumnList</a> 121 <a href="#M000067">getColumnName</a> 122 <a href="#M000066">getColumnNames</a> 123 <a href="#M000070">getColumnPrecision</a> 124 <a href="#M000071">getColumnScale</a> 125 <a href="#M000068">getColumnType</a> 126 <a href="#M000013">getDatabaseList</a> 127 <a href="#M000058">getField</a> 128 <a href="#M000060">getFieldAsDouble</a> 129 <a href="#M000059">getFieldAsInteger</a> 130 <a href="#M000061">getFieldLength</a> 131 <a href="#M000080">getLongest</a> 132 <a href="#M000056">getNullsAsEmptyStrings</a> 133 <a href="#M000057">getNullsAsNils</a> 134 <a href="#M000041">getOutputBindBlob</a> 135 <a href="#M000042">getOutputBindClob</a> 136 <a href="#M000046">getOutputBindCursor</a> 137 <a href="#M000044">getOutputBindDouble</a> 138 <a href="#M000043">getOutputBindInteger</a> 139 <a href="#M000045">getOutputBindLength</a> 140 <a href="#M000040">getOutputBindString</a> 141 <a href="#M000003">getResultSetBufferSize</a> 142 <a href="#M000081">getResultSetId</a> 143 <a href="#M000062">getRow</a> 144 <a href="#M000063">getRowHash</a> 145 <a href="#M000064">getRowLengths</a> 146 <a href="#M000065">getRowLengthsHash</a> 147 <a href="#M000014">getTableList</a> 148 <a href="#M000025">inputBind</a> 149 <a href="#M000026">inputBindBlob</a> 150 <a href="#M000027">inputBindClob</a> 151 <a href="#M000035">inputBinds</a> 152 <a href="#M000008">lowerCaseColumnNames</a> 153 <a href="#M000006">mixedCaseColumnNames</a> 154 <a href="#M000001">new</a> 155 <a href="#M000047">openCachedResultSet</a> 156 <a href="#M000021">prepareFileQuery</a> 157 <a href="#M000019">prepareQuery</a> 158 <a href="#M000020">prepareQueryWithLength</a> 159 <a href="#M000084">resumeCachedResultSet</a> 160 <a href="#M000083">resumeResultSet</a> 161 <a href="#M000049">rowCount</a> 162 <a href="#M000018">sendFileQuery</a> 163 <a href="#M000016">sendQuery</a> 164 <a href="#M000017">sendQueryWithLength</a> 165 <a href="#M000010">setCacheTtl</a> 166 <a href="#M000002">setResultSetBufferSize</a> 167 <a href="#M000024">substitution</a> 168 <a href="#M000034">substitutions</a> 169 <a href="#M000082">suspendResultSet</a> 170 <a href="#M000050">totalRows</a> 171 <a href="#M000007">upperCaseColumnNames</a> 172 <a href="#M000037">validBind</a> 173 <a href="#M000036">validateBinds</a> 174 </div> 175 </div> 176 177 </div> 178 179 180 <!-- if includes --> 181 182 <div id="section"> 183 184 185 186 187 188 189 190 191 <!-- if method_list --> 192 <div id="methods"> 193 <h3 class="section-bar">Public Class methods</h3> 194 195 <div id="method-M000001" class="method-detail"> 196 <a name="M000001"></a> 197 198 <div class="method-heading"> 199 <a href="SQLRCursor.src/M000001.html" target="Code" class="method-signature" 200 onclick="popupCode('SQLRCursor.src/M000001.html');return false;"> 201 <span class="method-name">new(connection)<br /> 202</span> 203 </a> 204 </div> 205 206 <div class="method-description"> 207 <p> 208Creates a cursor to run queries and fetch result sets using connection 209"connection" 210</p> 211 </div> 212 </div> 213 214 <h3 class="section-bar">Public Instance methods</h3> 215 216 <div id="method-M000051" class="method-detail"> 217 <a name="M000051"></a> 218 219 <div class="method-heading"> 220 <a href="SQLRCursor.src/M000051.html" target="Code" class="method-signature" 221 onclick="popupCode('SQLRCursor.src/M000051.html');return false;"> 222 <span class="method-name">affectedRows</span><span class="method-args">()</span> 223 </a> 224 </div> 225 226 <div class="method-description"> 227 <p> 228Returns the number of rows that were updated, inserted or deleted by the 229query. Not all databases support this call. Don‘t use it for 230applications which are designed to be portable across databases. -1 is 231returned by databases which don‘t support this option. 232</p> 233 </div> 234 </div> 235 236 <div id="method-M000012" class="method-detail"> 237 <a name="M000012"></a> 238 239 <div class="method-heading"> 240 <a href="SQLRCursor.src/M000012.html" target="Code" class="method-signature" 241 onclick="popupCode('SQLRCursor.src/M000012.html');return false;"> 242 <span class="method-name">cacheOff</span><span class="method-args">()</span> 243 </a> 244 </div> 245 246 <div class="method-description"> 247 <p> 248Sets query caching off. 249</p> 250 </div> 251 </div> 252 253 <div id="method-M000009" class="method-detail"> 254 <a name="M000009"></a> 255 256 <div class="method-heading"> 257 <a href="SQLRCursor.src/M000009.html" target="Code" class="method-signature" 258 onclick="popupCode('SQLRCursor.src/M000009.html');return false;"> 259 <span class="method-name">cacheToFile(filename)<br /> 260</span> 261 </a> 262 </div> 263 264 <div class="method-description"> 265 <p> 266Sets query caching on. Future queries will be cached to the file 267"filename". 268</p> 269<p> 270A default time-to-live of 10 minutes is also set. 271</p> 272<p> 273Note that once <a href="SQLRCursor.html#M000009">cacheToFile</a>() is 274called, the result sets of all future queries will be cached to that file 275until another call to <a href="SQLRCursor.html#M000009">cacheToFile</a>() 276changes which file to cache to or a call to <a 277href="SQLRCursor.html#M000012">cacheOff</a>() turns off caching. 278</p> 279 </div> 280 </div> 281 282 <div id="method-M000022" class="method-detail"> 283 <a name="M000022"></a> 284 285 <div class="method-heading"> 286 <a href="SQLRCursor.src/M000022.html" target="Code" class="method-signature" 287 onclick="popupCode('SQLRCursor.src/M000022.html');return false;"> 288 <span class="method-name">clearBinds</span><span class="method-args">()</span> 289 </a> 290 </div> 291 292 <div class="method-description"> 293 <p> 294Clears all bind variables. 295</p> 296 </div> 297 </div> 298 299 <div id="method-M000085" class="method-detail"> 300 <a name="M000085"></a> 301 302 <div class="method-heading"> 303 <a href="SQLRCursor.src/M000085.html" target="Code" class="method-signature" 304 onclick="popupCode('SQLRCursor.src/M000085.html');return false;"> 305 <span class="method-name">closeResultSet</span><span class="method-args">()</span> 306 </a> 307 </div> 308 309 <div class="method-description"> 310 <p> 311Closes the current result set, if one is open. Data that has been fetched 312already is still available but no more data may be fetched. Server side 313resources for the result set are freed as well. 314</p> 315 </div> 316 </div> 317 318 <div id="method-M000048" class="method-detail"> 319 <a name="M000048"></a> 320 321 <div class="method-heading"> 322 <a href="SQLRCursor.src/M000048.html" target="Code" class="method-signature" 323 onclick="popupCode('SQLRCursor.src/M000048.html');return false;"> 324 <span class="method-name">colCount</span><span class="method-args">()</span> 325 </a> 326 </div> 327 328 <div class="method-description"> 329 <p> 330Returns the number of columns in the current result set. 331</p> 332 </div> 333 </div> 334 335 <div id="method-M000023" class="method-detail"> 336 <a name="M000023"></a> 337 338 <div class="method-heading"> 339 <a href="SQLRCursor.src/M000023.html" target="Code" class="method-signature" 340 onclick="popupCode('SQLRCursor.src/M000023.html');return false;"> 341 <span class="method-name">countBindVariables</span><span class="method-args">()</span> 342 </a> 343 </div> 344 345 <div class="method-description"> 346 <p> 347Parses the previously prepared query, counts the number of bind variables 348defined in it and returns that number. 349</p> 350 </div> 351 </div> 352 353 <div id="method-M000031" class="method-detail"> 354 <a name="M000031"></a> 355 356 <div class="method-heading"> 357 <a href="SQLRCursor.src/M000031.html" target="Code" class="method-signature" 358 onclick="popupCode('SQLRCursor.src/M000031.html');return false;"> 359 <span class="method-name">defineOuptutBindBlob(variable)<br /> 360</span> 361 </a> 362 </div> 363 364 <div class="method-description"> 365 <p> 366Defines a binary lob output bind variable 367</p> 368 </div> 369 </div> 370 371 <div id="method-M000032" class="method-detail"> 372 <a name="M000032"></a> 373 374 <div class="method-heading"> 375 <a href="SQLRCursor.src/M000032.html" target="Code" class="method-signature" 376 onclick="popupCode('SQLRCursor.src/M000032.html');return false;"> 377 <span class="method-name">defineOutputBindClob(variable)<br /> 378</span> 379 </a> 380 </div> 381 382 <div class="method-description"> 383 <p> 384Defines a character lob output bind variable 385</p> 386 </div> 387 </div> 388 389 <div id="method-M000033" class="method-detail"> 390 <a name="M000033"></a> 391 392 <div class="method-heading"> 393 <a href="SQLRCursor.src/M000033.html" target="Code" class="method-signature" 394 onclick="popupCode('SQLRCursor.src/M000033.html');return false;"> 395 <span class="method-name">defineOutputBindCursor(variable)<br /> 396</span> 397 </a> 398 </div> 399 400 <div class="method-description"> 401 <p> 402Defines a cursor output bind variable 403</p> 404 </div> 405 </div> 406 407 <div id="method-M000030" class="method-detail"> 408 <a name="M000030"></a> 409 410 <div class="method-heading"> 411 <a href="SQLRCursor.src/M000030.html" target="Code" class="method-signature" 412 onclick="popupCode('SQLRCursor.src/M000030.html');return false;"> 413 <span class="method-name">defineOutputBindDouble(variable)<br /> 414</span> 415 </a> 416 </div> 417 418 <div class="method-description"> 419 <p> 420Defines an decimal output bind variable. 421</p> 422 </div> 423 </div> 424 425 <div id="method-M000029" class="method-detail"> 426 <a name="M000029"></a> 427 428 <div class="method-heading"> 429 <a href="SQLRCursor.src/M000029.html" target="Code" class="method-signature" 430 onclick="popupCode('SQLRCursor.src/M000029.html');return false;"> 431 <span class="method-name">defineOutputBindInteger(variable)<br /> 432</span> 433 </a> 434 </div> 435 436 <div class="method-description"> 437 <p> 438Defines an integer output bind variable. 439</p> 440 </div> 441 </div> 442 443 <div id="method-M000028" class="method-detail"> 444 <a name="M000028"></a> 445 446 <div class="method-heading"> 447 <a href="SQLRCursor.src/M000028.html" target="Code" class="method-signature" 448 onclick="popupCode('SQLRCursor.src/M000028.html');return false;"> 449 <span class="method-name">defineOutputBindString(variable,length)<br /> 450</span> 451 </a> 452 </div> 453 454 <div class="method-description"> 455 <p> 456Defines a string output bind variable. "length" bytes will be 457reserved to store the value. 458</p> 459 </div> 460 </div> 461 462 <div id="method-M000004" class="method-detail"> 463 <a name="M000004"></a> 464 465 <div class="method-heading"> 466 <a href="SQLRCursor.src/M000004.html" target="Code" class="method-signature" 467 onclick="popupCode('SQLRCursor.src/M000004.html');return false;"> 468 <span class="method-name">dontGetColumnInfo</span><span class="method-args">()</span> 469 </a> 470 </div> 471 472 <div class="method-description"> 473 <p> 474Tells the server not to send any column info (names, types, sizes). If you 475don‘t need that info, you should call this function to improve 476performance. 477</p> 478 </div> 479 </div> 480 481 <div id="method-M000053" class="method-detail"> 482 <a name="M000053"></a> 483 484 <div class="method-heading"> 485 <a href="SQLRCursor.src/M000053.html" target="Code" class="method-signature" 486 onclick="popupCode('SQLRCursor.src/M000053.html');return false;"> 487 <span class="method-name">endOfResultSet</span><span class="method-args">()</span> 488 </a> 489 </div> 490 491 <div class="method-description"> 492 <p> 493Returns 0 if part of the result set is still pending on the server and 1 if 494not. This function can only return 0 if <a 495href="SQLRCursor.html#M000002">setResultSetBufferSize</a>() has been called 496with a parameter other than 0. 497</p> 498 </div> 499 </div> 500 501 <div id="method-M000054" class="method-detail"> 502 <a name="M000054"></a> 503 504 <div class="method-heading"> 505 <a href="SQLRCursor.src/M000054.html" target="Code" class="method-signature" 506 onclick="popupCode('SQLRCursor.src/M000054.html');return false;"> 507 <span class="method-name">errorMessage</span><span class="method-args">()</span> 508 </a> 509 </div> 510 511 <div class="method-description"> 512 <p> 513If a query failed and generated an error, the error message is available 514here. If the query succeeded then this function returns a nil. 515</p> 516 </div> 517 </div> 518 519 <div id="method-M000055" class="method-detail"> 520 <a name="M000055"></a> 521 522 <div class="method-heading"> 523 <a href="SQLRCursor.src/M000055.html" target="Code" class="method-signature" 524 onclick="popupCode('SQLRCursor.src/M000055.html');return false;"> 525 <span class="method-name">errorNumber</span><span class="method-args">()</span> 526 </a> 527 </div> 528 529 <div class="method-description"> 530 <p> 531If a query failed and generated an error, the error number is available 532here. If there is no error then this method returns 0. 533</p> 534 </div> 535 </div> 536 537 <div id="method-M000038" class="method-detail"> 538 <a name="M000038"></a> 539 540 <div class="method-heading"> 541 <a href="SQLRCursor.src/M000038.html" target="Code" class="method-signature" 542 onclick="popupCode('SQLRCursor.src/M000038.html');return false;"> 543 <span class="method-name">executeQuery</span><span class="method-args">()</span> 544 </a> 545 </div> 546 547 <div class="method-description"> 548 <p> 549Execute the query that was previously prepared and bound. 550</p> 551 </div> 552 </div> 553 554 <div id="method-M000039" class="method-detail"> 555 <a name="M000039"></a> 556 557 <div class="method-heading"> 558 <a href="SQLRCursor.src/M000039.html" target="Code" class="method-signature" 559 onclick="popupCode('SQLRCursor.src/M000039.html');return false;"> 560 <span class="method-name">fetchFromBindCursor</span><span class="method-args">()</span> 561 </a> 562 </div> 563 564 <div class="method-description"> 565 <p> 566Fetch from a cursor that was returned as an output bind variable. 567</p> 568 </div> 569 </div> 570 571 <div id="method-M000052" class="method-detail"> 572 <a name="M000052"></a> 573 574 <div class="method-heading"> 575 <a href="SQLRCursor.src/M000052.html" target="Code" class="method-signature" 576 onclick="popupCode('SQLRCursor.src/M000052.html');return false;"> 577 <span class="method-name">firstRowIndex</span><span class="method-args">()</span> 578 </a> 579 </div> 580 581 <div class="method-description"> 582 <p> 583Returns the index of the first buffered row. This is useful when buffering 584only part of the result set at a time. 585</p> 586 </div> 587 </div> 588 589 <div id="method-M000011" class="method-detail"> 590 <a name="M000011"></a> 591 592 <div class="method-heading"> 593 <a href="SQLRCursor.src/M000011.html" target="Code" class="method-signature" 594 onclick="popupCode('SQLRCursor.src/M000011.html');return false;"> 595 <span class="method-name">getCacheFileName</span><span class="method-args">()</span> 596 </a> 597 </div> 598 599 <div class="method-description"> 600 <p> 601Returns the name of the file containing the most recently cached result 602set. 603</p> 604 </div> 605 </div> 606 607 <div id="method-M000005" class="method-detail"> 608 <a name="M000005"></a> 609 610 <div class="method-heading"> 611 <a href="SQLRCursor.src/M000005.html" target="Code" class="method-signature" 612 onclick="popupCode('SQLRCursor.src/M000005.html');return false;"> 613 <span class="method-name">getColumnInfo</span><span class="method-args">()</span> 614 </a> 615 </div> 616 617 <div class="method-description"> 618 <p> 619Tells the server to send column info. 620</p> 621 </div> 622 </div> 623 624 <div id="method-M000079" class="method-detail"> 625 <a name="M000079"></a> 626 627 <div class="method-heading"> 628 <a href="SQLRCursor.src/M000079.html" target="Code" class="method-signature" 629 onclick="popupCode('SQLRCursor.src/M000079.html');return false;"> 630 <span class="method-name">getColumnIsAutoIncrement(col)<br /> 631</span> 632 </a> 633 </div> 634 635 <div class="method-description"> 636 <p> 637Returns 1 if the specified column auto-increments and 0 otherwise. 638"col" may be specified as the column name or number. 639</p> 640 </div> 641 </div> 642 643 <div id="method-M000078" class="method-detail"> 644 <a name="M000078"></a> 645 646 <div class="method-heading"> 647 <a href="SQLRCursor.src/M000078.html" target="Code" class="method-signature" 648 onclick="popupCode('SQLRCursor.src/M000078.html');return false;"> 649 <span class="method-name">getColumnIsBinary(col)<br /> 650</span> 651 </a> 652 </div> 653 654 <div class="method-description"> 655 <p> 656Returns 1 if the specified column contains binary data and 0 otherwise. 657"col" may be specified as the column name or number. 658</p> 659 </div> 660 </div> 661 662 <div id="method-M000072" class="method-detail"> 663 <a name="M000072"></a> 664 665 <div class="method-heading"> 666 <a href="SQLRCursor.src/M000072.html" target="Code" class="method-signature" 667 onclick="popupCode('SQLRCursor.src/M000072.html');return false;"> 668 <span class="method-name">getColumnIsNullable(col)<br /> 669</span> 670 </a> 671 </div> 672 673 <div class="method-description"> 674 <p> 675Returns 1 if the specified column can contain nulls and 0 otherwise. 676"col" may be specified as the colum name or number. 677</p> 678 </div> 679 </div> 680 681 <div id="method-M000075" class="method-detail"> 682 <a name="M000075"></a> 683 684 <div class="method-heading"> 685 <a href="SQLRCursor.src/M000075.html" target="Code" class="method-signature" 686 onclick="popupCode('SQLRCursor.src/M000075.html');return false;"> 687 <span class="method-name">getColumnIsPartOfKey(col)<br /> 688</span> 689 </a> 690 </div> 691 692 <div class="method-description"> 693 <p> 694Returns 1 if the specified column is part of a composite key and 0 695otherwise. "col" may be specified as the column name or number. 696</p> 697 </div> 698 </div> 699 700 <div id="method-M000073" class="method-detail"> 701 <a name="M000073"></a> 702 703 <div class="method-heading"> 704 <a href="SQLRCursor.src/M000073.html" target="Code" class="method-signature" 705 onclick="popupCode('SQLRCursor.src/M000073.html');return false;"> 706 <span class="method-name">getColumnIsPrimaryKey(col)<br /> 707</span> 708 </a> 709 </div> 710 711 <div class="method-description"> 712 <p> 713Returns 1 if the specified column is a primary key and 0 otherwise. 714"col" may be specified as the column name or number. 715</p> 716 </div> 717 </div> 718 719 <div id="method-M000074" class="method-detail"> 720 <a name="M000074"></a> 721 722 <div class="method-heading"> 723 <a href="SQLRCursor.src/M000074.html" target="Code" class="method-signature" 724 onclick="popupCode('SQLRCursor.src/M000074.html');return false;"> 725 <span class="method-name">getColumnIsUnique(col)<br /> 726</span> 727 </a> 728 </div> 729 730 <div class="method-description"> 731 <p> 732Returns 1 if the specified column is unique and 0 otherwise. 733"col" may be specified as the column name or number. 734</p> 735 </div> 736 </div> 737 738 <div id="method-M000076" class="method-detail"> 739 <a name="M000076"></a> 740 741 <div class="method-heading"> 742 <a href="SQLRCursor.src/M000076.html" target="Code" class="method-signature" 743 onclick="popupCode('SQLRCursor.src/M000076.html');return false;"> 744 <span class="method-name">getColumnIsUnsigned(col)<br /> 745</span> 746 </a> 747 </div> 748 749 <div class="method-description"> 750 <p> 751Returns 1 if the specified column is an unsigned number and 0 otherwise. 752"col" may be specified as the column name or number. 753</p> 754 </div> 755 </div> 756 757 <div id="method-M000077" class="method-detail"> 758 <a name="M000077"></a> 759 760 <div class="method-heading"> 761 <a href="SQLRCursor.src/M000077.html" target="Code" class="method-signature" 762 onclick="popupCode('SQLRCursor.src/M000077.html');return false;"> 763 <span class="method-name">getColumnIsZeroFilled(col)<br /> 764</span> 765 </a> 766 </div> 767 768 <div class="method-description"> 769 <p> 770Returns 1 if the specified column was created with the zero-fill flag and 0 771otherwise. "col" may be specified as the column name or number. 772</p> 773 </div> 774 </div> 775 776 <div id="method-M000069" class="method-detail"> 777 <a name="M000069"></a> 778 779 <div class="method-heading"> 780 <a href="SQLRCursor.src/M000069.html" target="Code" class="method-signature" 781 onclick="popupCode('SQLRCursor.src/M000069.html');return false;"> 782 <span class="method-name">getColumnLength(col)<br /> 783</span> 784 </a> 785 </div> 786 787 <div class="method-description"> 788 <p> 789Returns the length of the specified column. "col" may be 790specified as the column name or number. 791</p> 792 </div> 793 </div> 794 795 <div id="method-M000015" class="method-detail"> 796 <a name="M000015"></a> 797 798 <div class="method-heading"> 799 <a href="SQLRCursor.src/M000015.html" target="Code" class="method-signature" 800 onclick="popupCode('SQLRCursor.src/M000015.html');return false;"> 801 <span class="method-name">getColumnList(table,wild)<br /> 802</span> 803 </a> 804 </div> 805 806 <div class="method-description"> 807 <p> 808Sends a query that returns a list of columns in the table specified by the 809"table" parameter matching "wild". If wild is empty or 810nil then a list of all columns will be returned. 811</p> 812 </div> 813 </div> 814 815 <div id="method-M000067" class="method-detail"> 816 <a name="M000067"></a> 817 818 <div class="method-heading"> 819 <a href="SQLRCursor.src/M000067.html" target="Code" class="method-signature" 820 onclick="popupCode('SQLRCursor.src/M000067.html');return false;"> 821 <span class="method-name">getColumnName(col)<br /> 822</span> 823 </a> 824 </div> 825 826 <div class="method-description"> 827 <p> 828Returns the name of the specified column. 829</p> 830 </div> 831 </div> 832 833 <div id="method-M000066" class="method-detail"> 834 <a name="M000066"></a> 835 836 <div class="method-heading"> 837 <a href="SQLRCursor.src/M000066.html" target="Code" class="method-signature" 838 onclick="popupCode('SQLRCursor.src/M000066.html');return false;"> 839 <span class="method-name">getColumnNames</span><span class="method-args">()</span> 840 </a> 841 </div> 842 843 <div class="method-description"> 844 <p> 845Returns an array of the column names of the current result set. 846</p> 847 </div> 848 </div> 849 850 <div id="method-M000070" class="method-detail"> 851 <a name="M000070"></a> 852 853 <div class="method-heading"> 854 <a href="SQLRCursor.src/M000070.html" target="Code" class="method-signature" 855 onclick="popupCode('SQLRCursor.src/M000070.html');return false;"> 856 <span class="method-name">getColumnPrecision(col)<br /> 857</span> 858 </a> 859 </div> 860 861 <div class="method-description"> 862 <p> 863Returns the precision of the specified column. Precision is the total 864number of digits in a number. eg: 123.45 has a precision of 5. For 865non-numeric types, it‘s the number of characters in the string. 866"col" may be specified as the column name or number. 867</p> 868 </div> 869 </div> 870 871 <div id="method-M000071" class="method-detail"> 872 <a name="M000071"></a> 873 874 <div class="method-heading"> 875 <a href="SQLRCursor.src/M000071.html" target="Code" class="method-signature" 876 onclick="popupCode('SQLRCursor.src/M000071.html');return false;"> 877 <span class="method-name">getColumnScale(col)<br /> 878</span> 879 </a> 880 </div> 881 882 <div class="method-description"> 883 <p> 884Returns the scale of the specified column. Scale is the total number of 885digits to the right of the decimal point in a number. eg: 123.45 has a 886scale of 2. "col" may be specified as the column name or number. 887</p> 888 </div> 889 </div> 890 891 <div id="method-M000068" class="method-detail"> 892 <a name="M000068"></a> 893 894 <div class="method-heading"> 895 <a href="SQLRCursor.src/M000068.html" target="Code" class="method-signature" 896 onclick="popupCode('SQLRCursor.src/M000068.html');return false;"> 897 <span class="method-name">getColumnType(col)<br /> 898</span> 899 </a> 900 </div> 901 902 <div class="method-description"> 903 <p> 904Returns the type of the specified column. "col" may be specified 905as the column name or number. 906</p> 907 </div> 908 </div> 909 910 <div id="method-M000013" class="method-detail"> 911 <a name="M000013"></a> 912 913 <div class="method-heading"> 914 <a href="SQLRCursor.src/M000013.html" target="Code" class="method-signature" 915 onclick="popupCode('SQLRCursor.src/M000013.html');return false;"> 916 <span class="method-name">getDatabaseList(wild)<br /> 917</span> 918 </a> 919 </div> 920 921 <div class="method-description"> 922 <p> 923Sends a query that returns a list of databases/schemas matching 924"wild". If wild is empty or nil then a list of all 925databases/schemas will be returned. 926</p> 927 </div> 928 </div> 929 930 <div id="method-M000058" class="method-detail"> 931 <a name="M000058"></a> 932 933 <div class="method-heading"> 934 <a href="SQLRCursor.src/M000058.html" target="Code" class="method-signature" 935 onclick="popupCode('SQLRCursor.src/M000058.html');return false;"> 936 <span class="method-name">getField(row,col)<br /> 937</span> 938 </a> 939 </div> 940 941 <div class="method-description"> 942 <p> 943Returns the specified field as a string. "col" may be specified 944as the column name or number. 945</p> 946 </div> 947 </div> 948 949 <div id="method-M000060" class="method-detail"> 950 <a name="M000060"></a> 951 952 <div class="method-heading"> 953 <a href="SQLRCursor.src/M000060.html" target="Code" class="method-signature" 954 onclick="popupCode('SQLRCursor.src/M000060.html');return false;"> 955 <span class="method-name">getFieldAsDouble(row,col)<br /> 956</span> 957 </a> 958 </div> 959 960 <div class="method-description"> 961 <p> 962Returns the specified field as an decimal. "col" may be specified 963as the column name or number. 964</p> 965 </div> 966 </div> 967 968 <div id="method-M000059" class="method-detail"> 969 <a name="M000059"></a> 970 971 <div class="method-heading"> 972 <a href="SQLRCursor.src/M000059.html" target="Code" class="method-signature" 973 onclick="popupCode('SQLRCursor.src/M000059.html');return false;"> 974 <span class="method-name">getFieldAsInteger(row,col)<br /> 975</span> 976 </a> 977 </div> 978 979 <div class="method-description"> 980 <p> 981Returns the specified field as an integer. "col" may be specified 982as the column name or number. 983</p> 984 </div> 985 </div> 986 987 <div id="method-M000061" class="method-detail"> 988 <a name="M000061"></a> 989 990 <div class="method-heading"> 991 <a href="SQLRCursor.src/M000061.html" target="Code" class="method-signature" 992 onclick="popupCode('SQLRCursor.src/M000061.html');return false;"> 993 <span class="method-name">getFieldLength(row,col)<br /> 994</span> 995 </a> 996 </div> 997 998 <div class="method-description"> 999 <p> 1000Returns the length of the specified row and column. "col" may be 1001specified as the column name or number. 1002</p> 1003 </div> 1004 </div> 1005 1006 <div id="method-M000080" class="method-detail"> 1007 <a name="M000080"></a> 1008 1009 <div class="method-heading"> 1010 <a href="SQLRCursor.src/M000080.html" target="Code" class="method-signature" 1011 onclick="popupCode('SQLRCursor.src/M000080.html');return false;"> 1012 <span class="method-name">getLongest(col)<br /> 1013</span> 1014 </a> 1015 </div> 1016 1017 <div class="method-description"> 1018 <p> 1019Returns the length of the longest field in the specified column. 1020"col" may be specified as the column name or number. 1021</p> 1022 </div> 1023 </div> 1024 1025 <div id="method-M000056" class="method-detail"> 1026 <a name="M000056"></a> 1027 1028 <div class="method-heading"> 1029 <a href="SQLRCursor.src/M000056.html" target="Code" class="method-signature" 1030 onclick="popupCode('SQLRCursor.src/M000056.html');return false;"> 1031 <span class="method-name">getNullsAsEmptyStrings</span><span class="method-args">()</span> 1032 </a> 1033 </div> 1034 1035 <div class="method-description"> 1036 <p> 1037Tells the connection to return NULL fields and output bind variables as 1038empty strings. This is the default. 1039</p> 1040 </div> 1041 </div> 1042 1043 <div id="method-M000057" class="method-detail"> 1044 <a name="M000057"></a> 1045 1046 <div class="method-heading"> 1047 <a href="SQLRCursor.src/M000057.html" target="Code" class="method-signature" 1048 onclick="popupCode('SQLRCursor.src/M000057.html');return false;"> 1049 <span class="method-name">getNullsAsNils</span><span class="method-args">()</span> 1050 </a> 1051 </div> 1052 1053 <div class="method-description"> 1054 <p> 1055Tells the connection to return NULL fields and output bind variables as 1056nil‘s. 1057</p> 1058 </div> 1059 </div> 1060 1061 <div id="method-M000041" class="method-detail"> 1062 <a name="M000041"></a> 1063 1064 <div class="method-heading"> 1065 <a href="SQLRCursor.src/M000041.html" target="Code" class="method-signature" 1066 onclick="popupCode('SQLRCursor.src/M000041.html');return false;"> 1067 <span class="method-name">getOutputBindBlob(variable)<br /> 1068</span> 1069 </a> 1070 </div> 1071 1072 <div class="method-description"> 1073 <p> 1074Get the value stored in a previously defined binary lob output bind 1075variable. 1076</p> 1077 </div> 1078 </div> 1079 1080 <div id="method-M000042" class="method-detail"> 1081 <a name="M000042"></a> 1082 1083 <div class="method-heading"> 1084 <a href="SQLRCursor.src/M000042.html" target="Code" class="method-signature" 1085 onclick="popupCode('SQLRCursor.src/M000042.html');return false;"> 1086 <span class="method-name">getOutputBindClob(variable)<br /> 1087</span> 1088 </a> 1089 </div> 1090 1091 <div class="method-description"> 1092 <p> 1093Get the value stored in a previously defined character lob output bind 1094variable. 1095</p> 1096 </div> 1097 </div> 1098 1099 <div id="method-M000046" class="method-detail"> 1100 <a name="M000046"></a> 1101 1102 <div class="method-heading"> 1103 <a href="SQLRCursor.src/M000046.html" target="Code" class="method-signature" 1104 onclick="popupCode('SQLRCursor.src/M000046.html');return false;"> 1105 <span class="method-name">getOutputBindCursor(variable)<br /> 1106</span> 1107 </a> 1108 </div> 1109 1110 <div class="method-description"> 1111 <p> 1112Get the cursor associated with a previously defined output bind variable. 1113</p> 1114 </div> 1115 </div> 1116 1117 <div id="method-M000044" class="method-detail"> 1118 <a name="M000044"></a> 1119 1120 <div class="method-heading"> 1121 <a href="SQLRCursor.src/M000044.html" target="Code" class="method-signature" 1122 onclick="popupCode('SQLRCursor.src/M000044.html');return false;"> 1123 <span class="method-name">getOutputBindDouble(variable)<br /> 1124</span> 1125 </a> 1126 </div> 1127 1128 <div class="method-description"> 1129 <p> 1130Get the value stored in a previously defined decimal output bind variable. 1131</p> 1132 </div> 1133 </div> 1134 1135 <div id="method-M000043" class="method-detail"> 1136 <a name="M000043"></a> 1137 1138 <div class="method-heading"> 1139 <a href="SQLRCursor.src/M000043.html" target="Code" class="method-signature" 1140 onclick="popupCode('SQLRCursor.src/M000043.html');return false;"> 1141 <span class="method-name">getOutputBindInteger(variable)<br /> 1142</span> 1143 </a> 1144 </div> 1145 1146 <div class="method-description"> 1147 <p> 1148Get the value stored in a previously defined integer output bind variable. 1149</p> 1150 </div> 1151 </div> 1152 1153 <div id="method-M000045" class="method-detail"> 1154 <a name="M000045"></a> 1155 1156 <div class="method-heading"> 1157 <a href="SQLRCursor.src/M000045.html" target="Code" class="method-signature" 1158 onclick="popupCode('SQLRCursor.src/M000045.html');return false;"> 1159 <span class="method-name">getOutputBindLength(variable)<br /> 1160</span> 1161 </a> 1162 </div> 1163 1164 <div class="method-description"> 1165 <p> 1166Get the length of the value stored in a previously defined output bind 1167variable. 1168</p> 1169 </div> 1170 </div> 1171 1172 <div id="method-M000040" class="method-detail"> 1173 <a name="M000040"></a> 1174 1175 <div class="method-heading"> 1176 <a href="SQLRCursor.src/M000040.html" target="Code" class="method-signature" 1177 onclick="popupCode('SQLRCursor.src/M000040.html');return false;"> 1178 <span class="method-name">getOutputBindString(variable)<br /> 1179</span> 1180 </a> 1181 </div> 1182 1183 <div class="method-description"> 1184 <p> 1185Get the value stored in a previously defined string output bind variable. 1186</p> 1187 </div> 1188 </div> 1189 1190 <div id="method-M000003" class="method-detail"> 1191 <a name="M000003"></a> 1192 1193 <div class="method-heading"> 1194 <a href="SQLRCursor.src/M000003.html" target="Code" class="method-signature" 1195 onclick="popupCode('SQLRCursor.src/M000003.html');return false;"> 1196 <span class="method-name">getResultSetBufferSize</span><span class="method-args">()</span> 1197 </a> 1198 </div> 1199 1200 <div class="method-description"> 1201 <p> 1202Returns the number of result set rows that will be buffered at a time or 0 1203for the entire result set. 1204</p> 1205 </div> 1206 </div> 1207 1208 <div id="method-M000081" class="method-detail"> 1209 <a name="M000081"></a> 1210 1211 <div class="method-heading"> 1212 <a href="SQLRCursor.src/M000081.html" target="Code" class="method-signature" 1213 onclick="popupCode('SQLRCursor.src/M000081.html');return false;"> 1214 <span class="method-name">getResultSetId</span><span class="method-args">()</span> 1215 </a> 1216 </div> 1217 1218 <div class="method-description"> 1219 <p> 1220Returns the internal ID of this result set. This parameter may be passed to 1221another statement for use in the <a 1222href="SQLRCursor.html#M000083">resumeResultSet</a>() function. Note: The 1223value this function returns is only valid after a call to <a 1224href="SQLRCursor.html#M000082">suspendResultSet</a>(). 1225</p> 1226 </div> 1227 </div> 1228 1229 <div id="method-M000062" class="method-detail"> 1230 <a name="M000062"></a> 1231 1232 <div class="method-heading"> 1233 <a href="SQLRCursor.src/M000062.html" target="Code" class="method-signature" 1234 onclick="popupCode('SQLRCursor.src/M000062.html');return false;"> 1235 <span class="method-name">getRow(row)<br /> 1236</span> 1237 </a> 1238 </div> 1239 1240 <div class="method-description"> 1241 <p> 1242Returns an array of the values of the fields in the specified row. 1243</p> 1244 </div> 1245 </div> 1246 1247 <div id="method-M000063" class="method-detail"> 1248 <a name="M000063"></a> 1249 1250 <div class="method-heading"> 1251 <a href="SQLRCursor.src/M000063.html" target="Code" class="method-signature" 1252 onclick="popupCode('SQLRCursor.src/M000063.html');return false;"> 1253 <span class="method-name">getRowHash(row)<br /> 1254</span> 1255 </a> 1256 </div> 1257 1258 <div class="method-description"> 1259 <p> 1260Returns a hash of the values of the fields in the specified row. 1261</p> 1262 </div> 1263 </div> 1264 1265 <div id="method-M000064" class="method-detail"> 1266 <a name="M000064"></a> 1267 1268 <div class="method-heading"> 1269 <a href="SQLRCursor.src/M000064.html" target="Code" class="method-signature" 1270 onclick="popupCode('SQLRCursor.src/M000064.html');return false;"> 1271 <span class="method-name">getRowLengths(row)<br /> 1272</span> 1273 </a> 1274 </div> 1275 1276 <div class="method-description"> 1277 <p> 1278Returns an array of the lengths of the fields in the specified row. 1279</p> 1280 </div> 1281 </div> 1282 1283 <div id="method-M000065" class="method-detail"> 1284 <a name="M000065"></a> 1285 1286 <div class="method-heading"> 1287 <a href="SQLRCursor.src/M000065.html" target="Code" class="method-signature" 1288 onclick="popupCode('SQLRCursor.src/M000065.html');return false;"> 1289 <span class="method-name">getRowLengthsHash(row)<br /> 1290</span> 1291 </a> 1292 </div> 1293 1294 <div class="method-description"> 1295 <p> 1296Returns a hash of the lengths of the fields in the specified row. 1297</p> 1298 </div> 1299 </div> 1300 1301 <div id="method-M000014" class="method-detail"> 1302 <a name="M000014"></a> 1303 1304 <div class="method-heading"> 1305 <a href="SQLRCursor.src/M000014.html" target="Code" class="method-signature" 1306 onclick="popupCode('SQLRCursor.src/M000014.html');return false;"> 1307 <span class="method-name">getTableList(wild)<br /> 1308</span> 1309 </a> 1310 </div> 1311 1312 <div class="method-description"> 1313 <p> 1314Sends a query that returns a list of tables matching "wild". If 1315wild is empty or nil then a list of all tables will be returned. 1316</p> 1317 </div> 1318 </div> 1319 1320 <div id="method-M000025" class="method-detail"> 1321 <a name="M000025"></a> 1322 1323 <div class="method-heading"> 1324 <a href="SQLRCursor.src/M000025.html" target="Code" class="method-signature" 1325 onclick="popupCode('SQLRCursor.src/M000025.html');return false;"> 1326 <span class="method-name">inputBind(variable,value,(precision),(scale))<br /> 1327</span> 1328 </a> 1329 </div> 1330 1331 <div class="method-description"> 1332 <p> 1333Defines am input bind variable. The value may be a string, integer or 1334decimal. If it is a decimal then the precision and scale may be specified. 1335If you don‘t have the precision and scale then set them both to 0. 1336However in that case you may get unexpected rounding behavior if the server 1337is faking binds. 1338</p> 1339 </div> 1340 </div> 1341 1342 <div id="method-M000026" class="method-detail"> 1343 <a name="M000026"></a> 1344 1345 <div class="method-heading"> 1346 <a href="SQLRCursor.src/M000026.html" target="Code" class="method-signature" 1347 onclick="popupCode('SQLRCursor.src/M000026.html');return false;"> 1348 <span class="method-name">inputBindBlob(variable,value,size)<br /> 1349</span> 1350 </a> 1351 </div> 1352 1353 <div class="method-description"> 1354 <p> 1355Defines a binary lob input bind variable. 1356</p> 1357 </div> 1358 </div> 1359 1360 <div id="method-M000027" class="method-detail"> 1361 <a name="M000027"></a> 1362 1363 <div class="method-heading"> 1364 <a href="SQLRCursor.src/M000027.html" target="Code" class="method-signature" 1365 onclick="popupCode('SQLRCursor.src/M000027.html');return false;"> 1366 <span class="method-name">inputBindClob(variable,value,size)<br /> 1367</span> 1368 </a> 1369 </div> 1370 1371 <div class="method-description"> 1372 <p> 1373Defines a character lob input bind variable. 1374</p> 1375 </div> 1376 </div> 1377 1378 <div id="method-M000035" class="method-detail"> 1379 <a name="M000035"></a> 1380 1381 <div class="method-heading"> 1382 <a href="SQLRCursor.src/M000035.html" target="Code" class="method-signature" 1383 onclick="popupCode('SQLRCursor.src/M000035.html');return false;"> 1384 <span class="method-name">inputBinds(variables,values,(precisions),(scales))<br /> 1385</span> 1386 </a> 1387 </div> 1388 1389 <div class="method-description"> 1390 <p> 1391Defines an array of input bind variables. The values may be strings, 1392integers or decimals. If they are decimals then the precisions and scales 1393may also be specified. 1394</p> 1395 </div> 1396 </div> 1397 1398 <div id="method-M000008" class="method-detail"> 1399 <a name="M000008"></a> 1400 1401 <div class="method-heading"> 1402 <a href="SQLRCursor.src/M000008.html" target="Code" class="method-signature" 1403 onclick="popupCode('SQLRCursor.src/M000008.html');return false;"> 1404 <span class="method-name">lowerCaseColumnNames</span><span class="method-args">()</span> 1405 </a> 1406 </div> 1407 1408 <div class="method-description"> 1409 <p> 1410Columns names are converted to lower case. 1411</p> 1412 </div> 1413 </div> 1414 1415 <div id="method-M000006" class="method-detail"> 1416 <a name="M000006"></a> 1417 1418 <div class="method-heading"> 1419 <a href="SQLRCursor.src/M000006.html" target="Code" class="method-signature" 1420 onclick="popupCode('SQLRCursor.src/M000006.html');return false;"> 1421 <span class="method-name">mixedCaseColumnNames</span><span class="method-args">()</span> 1422 </a> 1423 </div> 1424 1425 <div class="method-description"> 1426 <p> 1427Columns names are returned in the same case as they are defined in the 1428database. This is the default. 1429</p> 1430 </div> 1431 </div> 1432 1433 <div id="method-M000047" class="method-detail"> 1434 <a name="M000047"></a> 1435 1436 <div class="method-heading"> 1437 <a href="SQLRCursor.src/M000047.html" target="Code" class="method-signature" 1438 onclick="popupCode('SQLRCursor.src/M000047.html');return false;"> 1439 <span class="method-name">openCachedResultSet(filename)<br /> 1440</span> 1441 </a> 1442 </div> 1443 1444 <div class="method-description"> 1445 <p> 1446Opens a cached result set. Returns 1 on success and 0 on failure. 1447</p> 1448 </div> 1449 </div> 1450 1451 <div id="method-M000021" class="method-detail"> 1452 <a name="M000021"></a> 1453 1454 <div class="method-heading"> 1455 <a href="SQLRCursor.src/M000021.html" target="Code" class="method-signature" 1456 onclick="popupCode('SQLRCursor.src/M000021.html');return false;"> 1457 <span class="method-name">prepareFileQuery(path,filename)<br /> 1458</span> 1459 </a> 1460 </div> 1461 1462 <div class="method-description"> 1463 <p> 1464Prepare to execute the contents of "path"/"filename". 1465</p> 1466 </div> 1467 </div> 1468 1469 <div id="method-M000019" class="method-detail"> 1470 <a name="M000019"></a> 1471 1472 <div class="method-heading"> 1473 <a href="SQLRCursor.src/M000019.html" target="Code" class="method-signature" 1474 onclick="popupCode('SQLRCursor.src/M000019.html');return false;"> 1475 <span class="method-name">prepareQuery(query)<br /> 1476</span> 1477 </a> 1478 </div> 1479 1480 <div class="method-description"> 1481 <p> 1482Prepare to execute "query". 1483</p> 1484 </div> 1485 </div> 1486 1487 <div id="method-M000020" class="method-detail"> 1488 <a name="M000020"></a> 1489 1490 <div class="method-heading"> 1491 <a href="SQLRCursor.src/M000020.html" target="Code" class="method-signature" 1492 onclick="popupCode('SQLRCursor.src/M000020.html');return false;"> 1493 <span class="method-name">prepareQuery(query,length)<br /> 1494</span> 1495 </a> 1496 </div> 1497 1498 <div class="method-description"> 1499 <p> 1500Prepare to execute "query" with length "length". This 1501function must be used if the query contains binary data. 1502</p> 1503 </div> 1504 </div> 1505 1506 <div id="method-M000084" class="method-detail"> 1507 <a name="M000084"></a> 1508 1509 <div class="method-heading"> 1510 <a href="SQLRCursor.src/M000084.html" target="Code" class="method-signature" 1511 onclick="popupCode('SQLRCursor.src/M000084.html');return false;"> 1512 <span class="method-name">resumeCachedResultSet(id,filename)<br /> 1513</span> 1514 </a> 1515 </div> 1516 1517 <div class="method-description"> 1518 <p> 1519Resumes a result set previously left open using suspendSession() and 1520continues caching the result set to "filename". Returns 1 on 1521success and 0 on failure. 1522</p> 1523 </div> 1524 </div> 1525 1526 <div id="method-M000083" class="method-detail"> 1527 <a name="M000083"></a> 1528 1529 <div class="method-heading"> 1530 <a href="SQLRCursor.src/M000083.html" target="Code" class="method-signature" 1531 onclick="popupCode('SQLRCursor.src/M000083.html');return false;"> 1532 <span class="method-name">resumeResultSet(id)<br /> 1533</span> 1534 </a> 1535 </div> 1536 1537 <div class="method-description"> 1538 <p> 1539Resumes a result set previously left open using suspendSession(). Returns 1 1540on success and 0 on failure. 1541</p> 1542 </div> 1543 </div> 1544 1545 <div id="method-M000049" class="method-detail"> 1546 <a name="M000049"></a> 1547 1548 <div class="method-heading"> 1549 <a href="SQLRCursor.src/M000049.html" target="Code" class="method-signature" 1550 onclick="popupCode('SQLRCursor.src/M000049.html');return false;"> 1551 <span class="method-name">rowCount</span><span class="method-args">()</span> 1552 </a> 1553 </div> 1554 1555 <div class="method-description"> 1556 <p> 1557Returns the number of rows in the current result set. 1558</p> 1559 </div> 1560 </div> 1561 1562 <div id="method-M000018" class="method-detail"> 1563 <a name="M000018"></a> 1564 1565 <div class="method-heading"> 1566 <a href="SQLRCursor.src/M000018.html" target="Code" class="method-signature" 1567 onclick="popupCode('SQLRCursor.src/M000018.html');return false;"> 1568 <span class="method-name">sendFileQuery(path,filename)<br /> 1569</span> 1570 </a> 1571 </div> 1572 1573 <div class="method-description"> 1574 <p> 1575Sends the query in file "path"/"filename" and gets a 1576result set. 1577</p> 1578 </div> 1579 </div> 1580 1581 <div id="method-M000016" class="method-detail"> 1582 <a name="M000016"></a> 1583 1584 <div class="method-heading"> 1585 <a href="SQLRCursor.src/M000016.html" target="Code" class="method-signature" 1586 onclick="popupCode('SQLRCursor.src/M000016.html');return false;"> 1587 <span class="method-name">sendQuery(query)<br /> 1588</span> 1589 </a> 1590 </div> 1591 1592 <div class="method-description"> 1593 <p> 1594Sends "query" directly and gets a result set. 1595</p> 1596 </div> 1597 </div> 1598 1599 <div id="method-M000017" class="method-detail"> 1600 <a name="M000017"></a> 1601 1602 <div class="method-heading"> 1603 <a href="SQLRCursor.src/M000017.html" target="Code" class="method-signature" 1604 onclick="popupCode('SQLRCursor.src/M000017.html');return false;"> 1605 <span class="method-name">sendQueryWithLength(query,length)<br /> 1606</span> 1607 </a> 1608 </div> 1609 1610 <div class="method-description"> 1611 <p> 1612Sends "query" with length "length" directly and gets a 1613result set. This function must be used if the query contains binary data. 1614</p> 1615 </div> 1616 </div> 1617 1618 <div id="method-M000010" class="method-detail"> 1619 <a name="M000010"></a> 1620 1621 <div class="method-heading"> 1622 <a href="SQLRCursor.src/M000010.html" target="Code" class="method-signature" 1623 onclick="popupCode('SQLRCursor.src/M000010.html');return false;"> 1624 <span class="method-name">setCacheTtl(ttl)<br /> 1625</span> 1626 </a> 1627 </div> 1628 1629 <div class="method-description"> 1630 <p> 1631Sets the time-to-live for cached result sets. The sqlr-cachemanger will 1632remove each cached result set "ttl" seconds after it‘s 1633created, provided it‘s scanning the directory containing the cache 1634files. 1635</p> 1636 </div> 1637 </div> 1638 1639 <div id="method-M000002" class="method-detail"> 1640 <a name="M000002"></a> 1641 1642 <div class="method-heading"> 1643 <a href="SQLRCursor.src/M000002.html" target="Code" class="method-signature" 1644 onclick="popupCode('SQLRCursor.src/M000002.html');return false;"> 1645 <span class="method-name">setResultSetBufferSize(rows)<br /> 1646</span> 1647 </a> 1648 </div> 1649 1650 <div class="method-description"> 1651 <p> 1652Sets the number of rows of the result set to buffer at a time. 0 (the 1653default) means buffer the entire result set. 1654</p> 1655 </div> 1656 </div> 1657 1658 <div id="method-M000024" class="method-detail"> 1659 <a name="M000024"></a> 1660 1661 <div class="method-heading"> 1662 <a href="SQLRCursor.src/M000024.html" target="Code" class="method-signature" 1663 onclick="popupCode('SQLRCursor.src/M000024.html');return false;"> 1664 <span class="method-name">substitution(variable,value,(precision),(scale))<br /> 1665</span> 1666 </a> 1667 </div> 1668 1669 <div class="method-description"> 1670 <p> 1671Defines a <a href="SQLRCursor.html#M000024">substitution</a> variable. The 1672value may be a string, integer or decimal. If it is a decimal then the 1673precision and scale may be specified. 1674</p> 1675 </div> 1676 </div> 1677 1678 <div id="method-M000034" class="method-detail"> 1679 <a name="M000034"></a> 1680 1681 <div class="method-heading"> 1682 <a href="SQLRCursor.src/M000034.html" target="Code" class="method-signature" 1683 onclick="popupCode('SQLRCursor.src/M000034.html');return false;"> 1684 <span class="method-name">substitutions(variables,values,(precisions),(scales))<br /> 1685</span> 1686 </a> 1687 </div> 1688 1689 <div class="method-description"> 1690 <p> 1691Defines an array of <a href="SQLRCursor.html#M000024">substitution</a> 1692variables. The values may be strings, integers or decimals. If they are 1693decimals then the precisions and scales may also be specified. 1694</p> 1695 </div> 1696 </div> 1697 1698 <div id="method-M000082" class="method-detail"> 1699 <a name="M000082"></a> 1700 1701 <div class="method-heading"> 1702 <a href="SQLRCursor.src/M000082.html" target="Code" class="method-signature" 1703 onclick="popupCode('SQLRCursor.src/M000082.html');return false;"> 1704 <span class="method-name">suspendResultSet</span><span class="method-args">()</span> 1705 </a> 1706 </div> 1707 1708 <div class="method-description"> 1709 <p> 1710Tells the server to leave this result set open when the connection calls 1711suspendSession() so that another connection can connect to it using <a 1712href="SQLRCursor.html#M000083">resumeResultSet</a>() after it calls 1713resumeSession(). 1714</p> 1715 </div> 1716 </div> 1717 1718 <div id="method-M000050" class="method-detail"> 1719 <a name="M000050"></a> 1720 1721 <div class="method-heading"> 1722 <a href="SQLRCursor.src/M000050.html" target="Code" class="method-signature" 1723 onclick="popupCode('SQLRCursor.src/M000050.html');return false;"> 1724 <span class="method-name">totalRows</span><span class="method-args">()</span> 1725 </a> 1726 </div> 1727 1728 <div class="method-description"> 1729 <p> 1730Returns the total number of rows that will be returned in the result set. 1731Not all databases support this call. Don‘t use it for applications 1732which are designed to be portable across databases. -1 is returned by 1733databases which don‘t support this option. 1734</p> 1735 </div> 1736 </div> 1737 1738 <div id="method-M000007" class="method-detail"> 1739 <a name="M000007"></a> 1740 1741 <div class="method-heading"> 1742 <a href="SQLRCursor.src/M000007.html" target="Code" class="method-signature" 1743 onclick="popupCode('SQLRCursor.src/M000007.html');return false;"> 1744 <span class="method-name">upperCaseColumnNames</span><span class="method-args">()</span> 1745 </a> 1746 </div> 1747 1748 <div class="method-description"> 1749 <p> 1750Columns names are converted to upper case. 1751</p> 1752 </div> 1753 </div> 1754 1755 <div id="method-M000037" class="method-detail"> 1756 <a name="M000037"></a> 1757 1758 <div class="method-heading"> 1759 <a href="SQLRCursor.src/M000037.html" target="Code" class="method-signature" 1760 onclick="popupCode('SQLRCursor.src/M000037.html');return false;"> 1761 <span class="method-name">validBind(variable)<br /> 1762</span> 1763 </a> 1764 </div> 1765 1766 <div class="method-description"> 1767 <p> 1768Returns true if "variable" was a valid bind variable of the 1769query. 1770</p> 1771 </div> 1772 </div> 1773 1774 <div id="method-M000036" class="method-detail"> 1775 <a name="M000036"></a> 1776 1777 <div class="method-heading"> 1778 <a href="SQLRCursor.src/M000036.html" target="Code" class="method-signature" 1779 onclick="popupCode('SQLRCursor.src/M000036.html');return false;"> 1780 <span class="method-name">validateBinds</span><span class="method-args">()</span> 1781 </a> 1782 </div> 1783 1784 <div class="method-description"> 1785 <p> 1786If you are binding to any variables that might not actually be in your 1787query, call this to ensure that the database won‘t try to bind them 1788unless they really are in the query. There is a performance penalty for 1789calling this function 1790</p> 1791 </div> 1792 </div> 1793 1794 1795 </div> 1796 1797 1798 </div> 1799 1800 1801<div id="validator-badges"> 1802 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> 1803</div> 1804 1805</body> 1806</html>