1<!DOCTYPE html> 2 3<html> 4<head> 5<meta charset="UTF-8"> 6 7<title>Table of Contents - RDoc Documentation</title> 8 9<script type="text/javascript"> 10 var rdoc_rel_prefix = "./"; 11</script> 12 13<script src="./js/jquery.js"></script> 14<script src="./js/darkfish.js"></script> 15 16<link href="./css/fonts.css" rel="stylesheet"> 17<link href="./css/rdoc.css" rel="stylesheet"> 18 19 20 21<body id="top" class="table-of-contents"> 22<main role="main"> 23<h1 class="class">Table of Contents - RDoc Documentation</h1> 24 25 26<h2 id="classes">Classes and Modules</h2> 27<ul> 28 <li class="class"> 29 <a href="SQLRConnection.html">SQLRConnection</a> 30 </li> 31 <li class="class"> 32 <a href="SQLRCursor.html">SQLRCursor</a> 33 </li> 34</ul> 35 36<h2 id="methods">Methods</h2> 37<ul> 38 39 <li class="method"> 40 <a href="SQLRConnection.html#method-c-new">::new</a> 41 — 42 <span class="container">SQLRConnection</span> 43 44 <li class="method"> 45 <a href="SQLRCursor.html#method-c-new">::new</a> 46 — 47 <span class="container">SQLRCursor</span> 48 49 <li class="method"> 50 <a href="SQLRCursor.html#method-i-affectedRows">#affectedRows</a> 51 — 52 <span class="container">SQLRCursor</span> 53 54 <li class="method"> 55 <a href="SQLRConnection.html#method-i-autoCommitOff">#autoCommitOff</a> 56 — 57 <span class="container">SQLRConnection</span> 58 59 <li class="method"> 60 <a href="SQLRConnection.html#method-i-autoCommitOn">#autoCommitOn</a> 61 — 62 <span class="container">SQLRConnection</span> 63 64 <li class="method"> 65 <a href="SQLRConnection.html#method-i-begin">#begin</a> 66 — 67 <span class="container">SQLRConnection</span> 68 69 <li class="method"> 70 <a href="SQLRConnection.html#method-i-bindFormat">#bindFormat</a> 71 — 72 <span class="container">SQLRConnection</span> 73 74 <li class="method"> 75 <a href="SQLRCursor.html#method-i-cacheOff">#cacheOff</a> 76 — 77 <span class="container">SQLRCursor</span> 78 79 <li class="method"> 80 <a href="SQLRCursor.html#method-i-cacheToFile">#cacheToFile</a> 81 — 82 <span class="container">SQLRCursor</span> 83 84 <li class="method"> 85 <a href="SQLRCursor.html#method-i-clearBinds">#clearBinds</a> 86 — 87 <span class="container">SQLRCursor</span> 88 89 <li class="method"> 90 <a href="SQLRConnection.html#method-i-clientVersion">#clientVersion</a> 91 — 92 <span class="container">SQLRConnection</span> 93 94 <li class="method"> 95 <a href="SQLRCursor.html#method-i-closeResultSet">#closeResultSet</a> 96 — 97 <span class="container">SQLRCursor</span> 98 99 <li class="method"> 100 <a href="SQLRCursor.html#method-i-colCount">#colCount</a> 101 — 102 <span class="container">SQLRCursor</span> 103 104 <li class="method"> 105 <a href="SQLRConnection.html#method-i-commit">#commit</a> 106 — 107 <span class="container">SQLRConnection</span> 108 109 <li class="method"> 110 <a href="SQLRCursor.html#method-i-countBindVariables">#countBindVariables</a> 111 — 112 <span class="container">SQLRCursor</span> 113 114 <li class="method"> 115 <a href="SQLRConnection.html#method-i-dbHostName">#dbHostName</a> 116 — 117 <span class="container">SQLRConnection</span> 118 119 <li class="method"> 120 <a href="SQLRConnection.html#method-i-dbIpAddress">#dbIpAddress</a> 121 — 122 <span class="container">SQLRConnection</span> 123 124 <li class="method"> 125 <a href="SQLRConnection.html#method-i-dbVersion">#dbVersion</a> 126 — 127 <span class="container">SQLRConnection</span> 128 129 <li class="method"> 130 <a href="SQLRConnection.html#method-i-debugOff">#debugOff</a> 131 — 132 <span class="container">SQLRConnection</span> 133 134 <li class="method"> 135 <a href="SQLRConnection.html#method-i-debugOn">#debugOn</a> 136 — 137 <span class="container">SQLRConnection</span> 138 139 <li class="method"> 140 <a href="SQLRCursor.html#method-i-defineOutputBindBlob">#defineOutputBindBlob</a> 141 — 142 <span class="container">SQLRCursor</span> 143 144 <li class="method"> 145 <a href="SQLRCursor.html#method-i-defineOutputBindClob">#defineOutputBindClob</a> 146 — 147 <span class="container">SQLRCursor</span> 148 149 <li class="method"> 150 <a href="SQLRCursor.html#method-i-defineOutputBindCursor">#defineOutputBindCursor</a> 151 — 152 <span class="container">SQLRCursor</span> 153 154 <li class="method"> 155 <a href="SQLRCursor.html#method-i-defineOutputBindDouble">#defineOutputBindDouble</a> 156 — 157 <span class="container">SQLRCursor</span> 158 159 <li class="method"> 160 <a href="SQLRCursor.html#method-i-defineOutputBindInteger">#defineOutputBindInteger</a> 161 — 162 <span class="container">SQLRCursor</span> 163 164 <li class="method"> 165 <a href="SQLRCursor.html#method-i-defineOutputBindString">#defineOutputBindString</a> 166 — 167 <span class="container">SQLRCursor</span> 168 169 <li class="method"> 170 <a href="SQLRConnection.html#method-i-disableEncryption">#disableEncryption</a> 171 — 172 <span class="container">SQLRConnection</span> 173 174 <li class="method"> 175 <a href="SQLRCursor.html#method-i-dontGetColumnInfo">#dontGetColumnInfo</a> 176 — 177 <span class="container">SQLRCursor</span> 178 179 <li class="method"> 180 <a href="SQLRConnection.html#method-i-enableKerberos">#enableKerberos</a> 181 — 182 <span class="container">SQLRConnection</span> 183 184 <li class="method"> 185 <a href="SQLRConnection.html#method-i-enableTls">#enableTls</a> 186 — 187 <span class="container">SQLRConnection</span> 188 189 <li class="method"> 190 <a href="SQLRCursor.html#method-i-endOfResultSet">#endOfResultSet</a> 191 — 192 <span class="container">SQLRCursor</span> 193 194 <li class="method"> 195 <a href="SQLRConnection.html#method-i-endSession">#endSession</a> 196 — 197 <span class="container">SQLRConnection</span> 198 199 <li class="method"> 200 <a href="SQLRConnection.html#method-i-errorMessage">#errorMessage</a> 201 — 202 <span class="container">SQLRConnection</span> 203 204 <li class="method"> 205 <a href="SQLRCursor.html#method-i-errorMessage">#errorMessage</a> 206 — 207 <span class="container">SQLRCursor</span> 208 209 <li class="method"> 210 <a href="SQLRConnection.html#method-i-errorNumber">#errorNumber</a> 211 — 212 <span class="container">SQLRConnection</span> 213 214 <li class="method"> 215 <a href="SQLRCursor.html#method-i-errorNumber">#errorNumber</a> 216 — 217 <span class="container">SQLRCursor</span> 218 219 <li class="method"> 220 <a href="SQLRCursor.html#method-i-executeQuery">#executeQuery</a> 221 — 222 <span class="container">SQLRCursor</span> 223 224 <li class="method"> 225 <a href="SQLRCursor.html#method-i-fetchFromBindCursor">#fetchFromBindCursor</a> 226 — 227 <span class="container">SQLRCursor</span> 228 229 <li class="method"> 230 <a href="SQLRCursor.html#method-i-firstRowIndex">#firstRowIndex</a> 231 — 232 <span class="container">SQLRCursor</span> 233 234 <li class="method"> 235 <a href="SQLRCursor.html#method-i-getCacheFileName">#getCacheFileName</a> 236 — 237 <span class="container">SQLRCursor</span> 238 239 <li class="method"> 240 <a href="SQLRConnection.html#method-i-getClientInfo">#getClientInfo</a> 241 — 242 <span class="container">SQLRConnection</span> 243 244 <li class="method"> 245 <a href="SQLRCursor.html#method-i-getColumnInfo">#getColumnInfo</a> 246 — 247 <span class="container">SQLRCursor</span> 248 249 <li class="method"> 250 <a href="SQLRCursor.html#method-i-getColumnIsAutoIncrement">#getColumnIsAutoIncrement</a> 251 — 252 <span class="container">SQLRCursor</span> 253 254 <li class="method"> 255 <a href="SQLRCursor.html#method-i-getColumnIsBinary">#getColumnIsBinary</a> 256 — 257 <span class="container">SQLRCursor</span> 258 259 <li class="method"> 260 <a href="SQLRCursor.html#method-i-getColumnIsNullable">#getColumnIsNullable</a> 261 — 262 <span class="container">SQLRCursor</span> 263 264 <li class="method"> 265 <a href="SQLRCursor.html#method-i-getColumnIsPartOfKey">#getColumnIsPartOfKey</a> 266 — 267 <span class="container">SQLRCursor</span> 268 269 <li class="method"> 270 <a href="SQLRCursor.html#method-i-getColumnIsPrimaryKey">#getColumnIsPrimaryKey</a> 271 — 272 <span class="container">SQLRCursor</span> 273 274 <li class="method"> 275 <a href="SQLRCursor.html#method-i-getColumnIsUnique">#getColumnIsUnique</a> 276 — 277 <span class="container">SQLRCursor</span> 278 279 <li class="method"> 280 <a href="SQLRCursor.html#method-i-getColumnIsUnsigned">#getColumnIsUnsigned</a> 281 — 282 <span class="container">SQLRCursor</span> 283 284 <li class="method"> 285 <a href="SQLRCursor.html#method-i-getColumnIsZeroFilled">#getColumnIsZeroFilled</a> 286 — 287 <span class="container">SQLRCursor</span> 288 289 <li class="method"> 290 <a href="SQLRCursor.html#method-i-getColumnLength">#getColumnLength</a> 291 — 292 <span class="container">SQLRCursor</span> 293 294 <li class="method"> 295 <a href="SQLRCursor.html#method-i-getColumnList">#getColumnList</a> 296 — 297 <span class="container">SQLRCursor</span> 298 299 <li class="method"> 300 <a href="SQLRCursor.html#method-i-getColumnName">#getColumnName</a> 301 — 302 <span class="container">SQLRCursor</span> 303 304 <li class="method"> 305 <a href="SQLRCursor.html#method-i-getColumnNames">#getColumnNames</a> 306 — 307 <span class="container">SQLRCursor</span> 308 309 <li class="method"> 310 <a href="SQLRCursor.html#method-i-getColumnPrecision">#getColumnPrecision</a> 311 — 312 <span class="container">SQLRCursor</span> 313 314 <li class="method"> 315 <a href="SQLRCursor.html#method-i-getColumnScale">#getColumnScale</a> 316 — 317 <span class="container">SQLRCursor</span> 318 319 <li class="method"> 320 <a href="SQLRCursor.html#method-i-getColumnType">#getColumnType</a> 321 — 322 <span class="container">SQLRCursor</span> 323 324 <li class="method"> 325 <a href="SQLRConnection.html#method-i-getConnectionPort">#getConnectionPort</a> 326 — 327 <span class="container">SQLRConnection</span> 328 329 <li class="method"> 330 <a href="SQLRConnection.html#method-i-getConnectionSocket">#getConnectionSocket</a> 331 — 332 <span class="container">SQLRConnection</span> 333 334 <li class="method"> 335 <a href="SQLRConnection.html#method-i-getCurrentDatabase">#getCurrentDatabase</a> 336 — 337 <span class="container">SQLRConnection</span> 338 339 <li class="method"> 340 <a href="SQLRCursor.html#method-i-getDatabaseList">#getDatabaseList</a> 341 — 342 <span class="container">SQLRCursor</span> 343 344 <li class="method"> 345 <a href="SQLRConnection.html#method-i-getDebug">#getDebug</a> 346 — 347 <span class="container">SQLRConnection</span> 348 349 <li class="method"> 350 <a href="SQLRCursor.html#method-i-getField">#getField</a> 351 — 352 <span class="container">SQLRCursor</span> 353 354 <li class="method"> 355 <a href="SQLRCursor.html#method-i-getFieldAsDouble">#getFieldAsDouble</a> 356 — 357 <span class="container">SQLRCursor</span> 358 359 <li class="method"> 360 <a href="SQLRCursor.html#method-i-getFieldAsInteger">#getFieldAsInteger</a> 361 — 362 <span class="container">SQLRCursor</span> 363 364 <li class="method"> 365 <a href="SQLRCursor.html#method-i-getFieldLength">#getFieldLength</a> 366 — 367 <span class="container">SQLRCursor</span> 368 369 <li class="method"> 370 <a href="SQLRConnection.html#method-i-getLastInsertId">#getLastInsertId</a> 371 — 372 <span class="container">SQLRConnection</span> 373 374 <li class="method"> 375 <a href="SQLRCursor.html#method-i-getLongest">#getLongest</a> 376 — 377 <span class="container">SQLRCursor</span> 378 379 <li class="method"> 380 <a href="SQLRCursor.html#method-i-getNullsAsEmptyStrings">#getNullsAsEmptyStrings</a> 381 — 382 <span class="container">SQLRCursor</span> 383 384 <li class="method"> 385 <a href="SQLRCursor.html#method-i-getNullsAsNils">#getNullsAsNils</a> 386 — 387 <span class="container">SQLRCursor</span> 388 389 <li class="method"> 390 <a href="SQLRCursor.html#method-i-getOutputBindBlob">#getOutputBindBlob</a> 391 — 392 <span class="container">SQLRCursor</span> 393 394 <li class="method"> 395 <a href="SQLRCursor.html#method-i-getOutputBindClob">#getOutputBindClob</a> 396 — 397 <span class="container">SQLRCursor</span> 398 399 <li class="method"> 400 <a href="SQLRCursor.html#method-i-getOutputBindCursor">#getOutputBindCursor</a> 401 — 402 <span class="container">SQLRCursor</span> 403 404 <li class="method"> 405 <a href="SQLRCursor.html#method-i-getOutputBindDouble">#getOutputBindDouble</a> 406 — 407 <span class="container">SQLRCursor</span> 408 409 <li class="method"> 410 <a href="SQLRCursor.html#method-i-getOutputBindInteger">#getOutputBindInteger</a> 411 — 412 <span class="container">SQLRCursor</span> 413 414 <li class="method"> 415 <a href="SQLRCursor.html#method-i-getOutputBindLength">#getOutputBindLength</a> 416 — 417 <span class="container">SQLRCursor</span> 418 419 <li class="method"> 420 <a href="SQLRCursor.html#method-i-getOutputBindString">#getOutputBindString</a> 421 — 422 <span class="container">SQLRCursor</span> 423 424 <li class="method"> 425 <a href="SQLRCursor.html#method-i-getResultSetBufferSize">#getResultSetBufferSize</a> 426 — 427 <span class="container">SQLRCursor</span> 428 429 <li class="method"> 430 <a href="SQLRCursor.html#method-i-getResultSetId">#getResultSetId</a> 431 — 432 <span class="container">SQLRCursor</span> 433 434 <li class="method"> 435 <a href="SQLRCursor.html#method-i-getRow">#getRow</a> 436 — 437 <span class="container">SQLRCursor</span> 438 439 <li class="method"> 440 <a href="SQLRCursor.html#method-i-getRowHash">#getRowHash</a> 441 — 442 <span class="container">SQLRCursor</span> 443 444 <li class="method"> 445 <a href="SQLRCursor.html#method-i-getRowLengths">#getRowLengths</a> 446 — 447 <span class="container">SQLRCursor</span> 448 449 <li class="method"> 450 <a href="SQLRCursor.html#method-i-getRowLengthsHash">#getRowLengthsHash</a> 451 — 452 <span class="container">SQLRCursor</span> 453 454 <li class="method"> 455 <a href="SQLRCursor.html#method-i-getTableList">#getTableList</a> 456 — 457 <span class="container">SQLRCursor</span> 458 459 <li class="method"> 460 <a href="SQLRConnection.html#method-i-identify">#identify</a> 461 — 462 <span class="container">SQLRConnection</span> 463 464 <li class="method"> 465 <a href="SQLRCursor.html#method-i-inputBind">#inputBind</a> 466 — 467 <span class="container">SQLRCursor</span> 468 469 <li class="method"> 470 <a href="SQLRCursor.html#method-i-inputBindBlob">#inputBindBlob</a> 471 — 472 <span class="container">SQLRCursor</span> 473 474 <li class="method"> 475 <a href="SQLRCursor.html#method-i-inputBindClob">#inputBindClob</a> 476 — 477 <span class="container">SQLRCursor</span> 478 479 <li class="method"> 480 <a href="SQLRCursor.html#method-i-inputBinds">#inputBinds</a> 481 — 482 <span class="container">SQLRCursor</span> 483 484 <li class="method"> 485 <a href="SQLRCursor.html#method-i-lowerCaseColumnNames">#lowerCaseColumnNames</a> 486 — 487 <span class="container">SQLRCursor</span> 488 489 <li class="method"> 490 <a href="SQLRCursor.html#method-i-mixedCaseColumnNames">#mixedCaseColumnNames</a> 491 — 492 <span class="container">SQLRCursor</span> 493 494 <li class="method"> 495 <a href="SQLRCursor.html#method-i-openCachedResultSet">#openCachedResultSet</a> 496 — 497 <span class="container">SQLRCursor</span> 498 499 <li class="method"> 500 <a href="SQLRConnection.html#method-i-ping">#ping</a> 501 — 502 <span class="container">SQLRConnection</span> 503 504 <li class="method"> 505 <a href="SQLRCursor.html#method-i-prepareFileQuery">#prepareFileQuery</a> 506 — 507 <span class="container">SQLRCursor</span> 508 509 <li class="method"> 510 <a href="SQLRCursor.html#method-i-prepareQuery">#prepareQuery</a> 511 — 512 <span class="container">SQLRCursor</span> 513 514 <li class="method"> 515 <a href="SQLRCursor.html#method-i-prepareQueryWithLength">#prepareQueryWithLength</a> 516 — 517 <span class="container">SQLRCursor</span> 518 519 <li class="method"> 520 <a href="SQLRCursor.html#method-i-resumeCachedResultSet">#resumeCachedResultSet</a> 521 — 522 <span class="container">SQLRCursor</span> 523 524 <li class="method"> 525 <a href="SQLRCursor.html#method-i-resumeResultSet">#resumeResultSet</a> 526 — 527 <span class="container">SQLRCursor</span> 528 529 <li class="method"> 530 <a href="SQLRConnection.html#method-i-resumeSession">#resumeSession</a> 531 — 532 <span class="container">SQLRConnection</span> 533 534 <li class="method"> 535 <a href="SQLRConnection.html#method-i-rollback">#rollback</a> 536 — 537 <span class="container">SQLRConnection</span> 538 539 <li class="method"> 540 <a href="SQLRCursor.html#method-i-rowCount">#rowCount</a> 541 — 542 <span class="container">SQLRCursor</span> 543 544 <li class="method"> 545 <a href="SQLRConnection.html#method-i-selectDatabase">#selectDatabase</a> 546 — 547 <span class="container">SQLRConnection</span> 548 549 <li class="method"> 550 <a href="SQLRCursor.html#method-i-sendFileQuery">#sendFileQuery</a> 551 — 552 <span class="container">SQLRCursor</span> 553 554 <li class="method"> 555 <a href="SQLRCursor.html#method-i-sendQuery">#sendQuery</a> 556 — 557 <span class="container">SQLRCursor</span> 558 559 <li class="method"> 560 <a href="SQLRCursor.html#method-i-sendQueryWithLength">#sendQueryWithLength</a> 561 — 562 <span class="container">SQLRCursor</span> 563 564 <li class="method"> 565 <a href="SQLRConnection.html#method-i-serverVersion">#serverVersion</a> 566 — 567 <span class="container">SQLRConnection</span> 568 569 <li class="method"> 570 <a href="SQLRConnection.html#method-i-setAuthenticationTimeout">#setAuthenticationTimeout</a> 571 — 572 <span class="container">SQLRConnection</span> 573 574 <li class="method"> 575 <a href="SQLRCursor.html#method-i-setCacheTtl">#setCacheTtl</a> 576 — 577 <span class="container">SQLRCursor</span> 578 579 <li class="method"> 580 <a href="SQLRConnection.html#method-i-setClientInfo">#setClientInfo</a> 581 — 582 <span class="container">SQLRConnection</span> 583 584 <li class="method"> 585 <a href="SQLRConnection.html#method-i-setConnectTimeout">#setConnectTimeout</a> 586 — 587 <span class="container">SQLRConnection</span> 588 589 <li class="method"> 590 <a href="SQLRConnection.html#method-i-setDebugFile">#setDebugFile</a> 591 — 592 <span class="container">SQLRConnection</span> 593 594 <li class="method"> 595 <a href="SQLRConnection.html#method-i-setResponseTimeout">#setResponseTimeout</a> 596 — 597 <span class="container">SQLRConnection</span> 598 599 <li class="method"> 600 <a href="SQLRCursor.html#method-i-setResultSetBufferSize">#setResultSetBufferSize</a> 601 — 602 <span class="container">SQLRCursor</span> 603 604 <li class="method"> 605 <a href="SQLRCursor.html#method-i-substitution">#substitution</a> 606 — 607 <span class="container">SQLRCursor</span> 608 609 <li class="method"> 610 <a href="SQLRCursor.html#method-i-substitutions">#substitutions</a> 611 — 612 <span class="container">SQLRCursor</span> 613 614 <li class="method"> 615 <a href="SQLRCursor.html#method-i-suspendResultSet">#suspendResultSet</a> 616 — 617 <span class="container">SQLRCursor</span> 618 619 <li class="method"> 620 <a href="SQLRConnection.html#method-i-suspendSession">#suspendSession</a> 621 — 622 <span class="container">SQLRConnection</span> 623 624 <li class="method"> 625 <a href="SQLRCursor.html#method-i-totalRows">#totalRows</a> 626 — 627 <span class="container">SQLRCursor</span> 628 629 <li class="method"> 630 <a href="SQLRCursor.html#method-i-upperCaseColumnNames">#upperCaseColumnNames</a> 631 — 632 <span class="container">SQLRCursor</span> 633 634 <li class="method"> 635 <a href="SQLRCursor.html#method-i-validBind">#validBind</a> 636 — 637 <span class="container">SQLRCursor</span> 638 639 <li class="method"> 640 <a href="SQLRCursor.html#method-i-validateBinds">#validateBinds</a> 641 — 642 <span class="container">SQLRCursor</span> 643</ul> 644</main> 645 646 647<footer id="validator-badges" role="contentinfo"> 648 <p><a href="http://validator.w3.org/check/referer">Validate</a> 649 <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0. 650 <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. 651</footer> 652 653