SQL Relay node.js API
sqlrelay.doc.h
1 // Copyright (c) 2015 David Muse
2 // See the file COPYING for more information.
3 
5  public:
21  SQLRConnection(var server, var port,
22  var socket,
23  var user, var password,
24  var retrytime, var tries);
25 
26 
27 
32  function setConnectTimeout(var timeoutsec, var timeoutusec);
33 
38  function setAuthenticationTimeout(var timeoutsec,
39  var timeoutusec);
40 
46  function setResponseTimeout(var timeoutsec, var timeoutusec);
47 
48 
49 
85  void enableKerberos(var service, var mech, var flags);
86 
156  void enableTls(var version,
157  var cert, var password, var ciphers,
158  var validate, var ca, var depth);
159 
161  void disableEncryption();
162 
163 
164 
166  function endSession();
167 
172  var suspendSession();
173 
180  var getConnectionPort();
181 
188  var getConnectionSocket();
189 
193  var resumeSession(var port, var socket);
194 
195 
196 
199  var ping();
200 
203  var identify();
204 
206  var dbVersion();
207 
209  var dbHostName();
210 
212  var dbIpAddress();
213 
215  var serverVersion();
216 
218  var clientVersion();
219 
222  var bindFormat();
223 
224 
225 
227  var selectDatabase(var database);
228 
230  var getCurrentDatabase();
231 
232 
233 
236  var getLastInsertId();
237 
238 
239 
242  var autoCommitOn();
243 
246  var autoCommitOff();
247 
248 
255  var begin();
256 
259  var commit();
260 
263  var rollback();
264 
265 
266 
271  var errorMessage();
272 
277  var errorNumber();
278 
279 
280 
286  function debugOn();
287 
289  function debugOff();
290 
293  var getDebug();
294 
295 
296 
300  function setDebugFile(var filename);
301 
302 
307  function setClientInfo(var clientinfo);
308 
310  var getClientInfo();
311 };
312 
313 
314 class SQLRCursor {
315  public:
318  SQLRCursor(var sqlrc);
319 
320 
324  function setResultSetBufferSize(var rows);
325 
330 
331 
332 
337  function dontGetColumnInfo();
338 
340  function getColumnInfo();
341 
342 
346  function mixedCaseColumnNames();
347 
349  function upperCaseColumnNames();
350 
352  function lowerCaseColumnNames();
353 
354 
355 
368  function cacheToFile(var filename);
369 
375  function setCacheTtl(var ttl);
376 
379  var getCacheFileName();
380 
382  function cacheOff();
383 
384 
385 
390  var getDatabaseList(var wild);
391 
395  var getTableList(var wild);
396 
401  var getColumnList(var table, var wild);
402 
403 
404 
406  var sendQuery(var query);
407 
411  var sendQuery(var query, var length);
412 
415  var sendFileQuery(var path, var filename);
416 
417 
418 
420  function prepareQuery(var query);
421 
425  function prepareQuery(var query, var length);
426 
430  var prepareFileQuery(var path,
431  var filename);
432 
433 
434 
436  function substitution(var variable, var value);
437 
439  function substitution(var variable, var value);
440 
442  function substitution(var variable, var value,
443  var precision,
444  var scale);
445 
447  function substitutions(var variables,
448  var values);
449 
451  function substitutions(var variables,
452  var values);
453 
455  function substitutions(var variables,
456  var values,
457  var precisions,
458  var scales);
459 
460 
461 
463  function inputBind(var variable, var value);
464 
466  function inputBind(var variable, var value,
467  var valuelength);
468 
470  function inputBind(var variable, var value);
471 
477  function inputBind(var variable, var value,
478  var precision,
479  var scale);
480 
484  function inputBind(var variable,
485  var year, var month, var day,
486  var hour, var minute, var second,
487  var microsecond, var tz);
488 
490  function inputBindBlob(var variable,
491  var value,
492  var size);
493 
495  function inputBindClob(var variable,
496  var value,
497  var size);
498 
500  function inputBinds(var variables, var values);
501 
503  function inputBinds(var variables,
504  const var values);
505 
507  function inputBinds(var variables,
508  const var values,
509  const var precisions,
510  const var scales);
511 
512 
513 
517  function defineOutputBindString(var variable,
518  var bufferlength);
519 
521  function defineOutputBindInteger(var variable);
522 
524  function defineOutputBindDouble(var variable);
525 
527  function defineOutputBindDate(var variable);
528 
530  function defineOutputBindBlob(var variable);
531 
533  function defineOutputBindClob(var variable);
534 
536  function defineOutputBindCursor(var variable);
537 
538 
539 
541  function clearBinds();
542 
546  var countBindVariables() const;
547 
554  function validateBinds();
555 
558  var validBind(var variable);
559 
560 
561 
564  var executeQuery();
565 
568  var fetchFromBindCursor();
569 
570 
571 
574  var getOutputBindString(var variable);
575 
578  var getOutputBindInteger(var variable);
579 
582  var getOutputBindDouble(var variable);
583 
586  var getOutputBindDate(var variable,
587  var year,
588  var month,
589  var day,
590  var hour,
591  var minute,
592  var second,
593  var microsecond,
594  var tz);
595 
598  var getOutputBindBlob(var variable);
599 
602  var getOutputBindClob(var variable);
603 
606  var getOutputBindLength(var variable);
607 
610  var getOutputBindCursor(var variable);
611 
612 
613 
616  var openCachedResultSet(var filename);
617 
618 
619 
622  var colCount();
623 
628  var rowCount();
629 
636  var totalRows();
637 
645  var affectedRows();
646 
650  var firstRowIndex();
651 
657  var endOfResultSet();
658 
659 
660 
665  var errorMessage();
666 
671  var errorNumber();
672 
673 
674 
678  function getNullsAsEmptyStrings();
679 
683  function getNullsAsNulls();
684 
685 
686 
688  var getField(var row, var col);
689 
691  var getField(var row, var col);
692 
694  var getFieldAsInteger(var row, var col);
695 
697  var getFieldAsInteger(var row, var col);
698 
700  var getFieldAsDouble(var row, var col);
701 
703  var getFieldAsDouble(var row, var col);
704 
705 
706 
708  var getFieldLength(var row, var col);
709 
711  var getFieldLength(var row, var col);
712 
713 
714 
717  var getRow(var row);
718 
721  var getRowLengths(var row);
722 
725  var getColumnNames();
726 
728  var getColumnName(var col);
729 
731  var getColumnType(var col);
732 
734  var getColumnType(var col);
735 
738  var getColumnLength(var col);
739 
742  var getColumnLength(var col);
743 
750  var getColumnPrecision(var col);
751 
758  var getColumnPrecision(var col);
759 
764  var getColumnScale(var col);
765 
770  var getColumnScale(var col);
771 
774  var getColumnIsNullable(var col);
775 
778  var getColumnIsNullable(var col);
779 
782  var getColumnIsPrimaryKey(var col);
783 
786  var getColumnIsPrimaryKey(var col);
787 
790  var getColumnIsUnique(var col);
791 
794  var getColumnIsUnique(var col);
795 
798  var getColumnIsPartOfKey(var col);
799 
802  var getColumnIsPartOfKey(var col);
803 
806  var getColumnIsUnsigned(var col);
807 
810  var getColumnIsUnsigned(var col);
811 
815  var getColumnIsZeroFilled(var col);
816 
820  var getColumnIsZeroFilled(var col);
821 
825  var getColumnIsBinary(var col);
826 
830  var getColumnIsBinary(var col);
831 
834  var getColumnIsAutoIncrement(var col);
835 
838  var getColumnIsAutoIncrement(var col);
839 
842  var getLongest(var col);
843 
846  var getLongest(var col);
847 
848 
849 
855  function suspendResultSet();
856 
863  var getResultSetId();
864 
868  var resumeResultSet(var id);
869 
874  var resumeCachedResultSet(var id,
875  var filename);
876 
881  function closeResultSet();
882 };
var getLongest(var col)
function closeResultSet()
var errorMessage()
function getNullsAsNulls()
var getTableList(var wild)
function defineOutputBindDouble(var variable)
var getConnectionSocket()
var getField(var row, var col)
function setClientInfo(var clientinfo)
function setConnectTimeout(var timeoutsec, var timeoutusec)
var getOutputBindDate(var variable, var year, var month, var day, var hour, var minute, var second, var microsecond, var tz)
var getRow(var row)
var getLastInsertId()
SQLRCursor(var sqlrc)
var getCurrentDatabase()
var resumeCachedResultSet(var id, var filename)
function prepareQuery(var query)
function clearBinds()
var errorNumber()
function defineOutputBindClob(var variable)
function cacheOff()
var openCachedResultSet(var filename)
var suspendSession()
var resumeResultSet(var id)
function getColumnInfo()
var getColumnType(var col)
void disableEncryption()
var getColumnLength(var col)
var getColumnIsBinary(var col)
var getFieldAsDouble(var row, var col)
var rowCount()
function defineOutputBindDate(var variable)
var executeQuery()
function lowerCaseColumnNames()
var colCount()
var selectDatabase(var database)
function inputBindClob(var variable, var value, var size)
function cacheToFile(var filename)
var getOutputBindString(var variable)
var getOutputBindDouble(var variable)
var getColumnIsAutoIncrement(var col)
function substitution(var variable, var value)
var getColumnName(var col)
function defineOutputBindString(var variable, var bufferlength)
var sendFileQuery(var path, var filename)
function inputBind(var variable, var value)
Definition: sqlrelay.doc.h:4
function suspendResultSet()
function setDebugFile(var filename)
var affectedRows()
function inputBinds(var variables, var values)
function debugOff()
var getOutputBindClob(var variable)
function upperCaseColumnNames()
var getColumnIsPrimaryKey(var col)
function defineOutputBindBlob(var variable)
function validateBinds()
SQLRConnection(var server, var port, var socket, var user, var password, var retrytime, var tries)
function substitutions(var variables, var values)
var getColumnNames()
var getColumnIsZeroFilled(var col)
function inputBindBlob(var variable, var value, var size)
function getNullsAsEmptyStrings()
var firstRowIndex()
var getOutputBindBlob(var variable)
var getOutputBindCursor(var variable)
var prepareFileQuery(var path, var filename)
function endSession()
Definition: sqlrelay.doc.h:314
var getColumnIsNullable(var col)
function setResultSetBufferSize(var rows)
var getColumnIsPartOfKey(var col)
function setResponseTimeout(var timeoutsec, var timeoutusec)
function dontGetColumnInfo()
var getResultSetBufferSize()
var getRowLengths(var row)
var validBind(var variable)
var fetchFromBindCursor()
var getColumnIsUnique(var col)
function defineOutputBindInteger(var variable)
var resumeSession(var port, var socket)
var countBindVariables() const
function setAuthenticationTimeout(var timeoutsec, var timeoutusec)
function mixedCaseColumnNames()
var getFieldAsInteger(var row, var col)
var getConnectionPort()
var getOutputBindInteger(var variable)
var getColumnScale(var col)
void enableTls(var version, var cert, var password, var ciphers, var validate, var ca, var depth)
var endOfResultSet()
void enableKerberos(var service, var mech, var flags)
var getOutputBindLength(var variable)
var sendQuery(var query)
var getCacheFileName()
function debugOn()
var getFieldLength(var row, var col)
var getColumnPrecision(var col)
var getDatabaseList(var wild)
var getColumnIsUnsigned(var col)
var getResultSetId()
var getColumnList(var table, var wild)
var totalRows()
function defineOutputBindCursor(var variable)
function setCacheTtl(var ttl)