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  setConnectTimeout(var timeoutsec, var timeoutusec);
33 
38  setAuthenticationTimeout(var timeoutsec, var timeoutusec);
39 
45  setResponseTimeout(var timeoutsec, var timeoutusec);
46 
48  function endSession();
49 
54  var suspendSession();
55 
62  var getConnectionPort();
63 
70  var getConnectionSocket();
71 
75  var resumeSession(var port, var socket);
76 
77 
78 
81  var ping();
82 
85  var identify();
86 
88  var dbVersion();
89 
91  var dbHostName();
92 
94  var dbIpAddress();
95 
97  var serverVersion();
98 
100  var clientVersion();
101 
104  var bindFormat();
105 
106 
107 
109  var selectDatabase(var database);
110 
112  var getCurrentDatabase();
113 
114 
115 
118  var getLastInsertId();
119 
120 
121 
124  var autoCommitOn();
125 
128  var autoCommitOff();
129 
130 
137  var begin();
138 
141  var commit();
142 
145  var rollback();
146 
147 
148 
153  var errorMessage();
154 
159  var errorNumber();
160 
161 
162 
168  function debugOn();
169 
171  function debugOff();
172 
175  var getDebug();
176 
177 
178 
182  function setDebugFile(var filename);
183 
184 
189  function setClientInfo(var clientinfo);
190 
192  var getClientInfo();
193 };
194 
195 
196 class SQLRCursor {
197  public:
200  SQLRCursor(var sqlrc);
201 
202 
206  function setResultSetBufferSize(var rows);
207 
212 
213 
214 
219  function dontGetColumnInfo();
220 
222  function getColumnInfo();
223 
224 
228  function mixedCaseColumnNames();
229 
231  function upperCaseColumnNames();
232 
234  function lowerCaseColumnNames();
235 
236 
237 
250  function cacheToFile(var filename);
251 
257  function setCacheTtl(var ttl);
258 
261  var getCacheFileName();
262 
264  function cacheOff();
265 
266 
267 
272  var getDatabaseList(var wild);
273 
277  var getTableList(var wild);
278 
283  var getColumnList(var table, var wild);
284 
285 
286 
288  var sendQuery(var query);
289 
293  var sendQuery(var query, var length);
294 
297  var sendFileQuery(var path, var filename);
298 
299 
300 
302  function prepareQuery(var query);
303 
307  function prepareQuery(var query, var length);
308 
312  var prepareFileQuery(var path,
313  var filename);
314 
315 
316 
318  function substitution(var variable, var value);
319 
321  function substitution(var variable, var value);
322 
324  function substitution(var variable, var value,
325  var precision,
326  var scale);
327 
329  function substitutions(var variables,
330  var values);
331 
333  function substitutions(var variables,
334  var values);
335 
337  function substitutions(var variables,
338  var values,
339  var precisions,
340  var scales);
341 
342 
343 
345  function inputBind(var variable, var value);
346 
348  function inputBind(var variable, var value,
349  var valuelength);
350 
352  function inputBind(var variable, var value);
353 
359  function inputBind(var variable, var value,
360  var precision,
361  var scale);
362 
366  function inputBind(var variable,
367  var year, var month, var day,
368  var hour, var minute, var second,
369  var microsecond, var tz);
370 
372  function inputBindBlob(var variable,
373  var value,
374  var size);
375 
377  function inputBindClob(var variable,
378  var value,
379  var size);
380 
382  function inputBinds(var variables, var values);
383 
385  function inputBinds(var variables,
386  const var values);
387 
389  function inputBinds(var variables,
390  const var values,
391  const var precisions,
392  const var scales);
393 
394 
395 
399  function defineOutputBindString(var variable,
400  var bufferlength);
401 
403  function defineOutputBindInteger(var variable);
404 
406  function defineOutputBindDouble(var variable);
407 
409  function defineOutputBindDate(var variable);
410 
412  function defineOutputBindBlob(var variable);
413 
415  function defineOutputBindClob(var variable);
416 
418  function defineOutputBindCursor(var variable);
419 
420 
421 
423  function clearBinds();
424 
428  var countBindVariables() const;
429 
436  function validateBinds();
437 
440  var validBind(var variable);
441 
442 
443 
446  var executeQuery();
447 
450  var fetchFromBindCursor();
451 
452 
453 
456  var getOutputBindString(var variable);
457 
460  var getOutputBindInteger(var variable);
461 
464  var getOutputBindDouble(var variable);
465 
468  var getOutputBindDate(var variable,
469  var year,
470  var month,
471  var day,
472  var hour,
473  var minute,
474  var second,
475  var microsecond,
476  var tz);
477 
480  var getOutputBindBlob(var variable);
481 
484  var getOutputBindClob(var variable);
485 
488  var getOutputBindLength(var variable);
489 
492  var getOutputBindCursor(var variable);
493 
494 
495 
498  var openCachedResultSet(var filename);
499 
500 
501 
504  var colCount();
505 
510  var rowCount();
511 
518  var totalRows();
519 
527  var affectedRows();
528 
532  var firstRowIndex();
533 
539  var endOfResultSet();
540 
541 
542 
547  var errorMessage();
548 
553  var errorNumber();
554 
555 
556 
560  function getNullsAsEmptyStrings();
561 
565  function getNullsAsNulls();
566 
567 
568 
570  var getField(var row, var col);
571 
573  var getField(var row, var col);
574 
576  var getFieldAsInteger(var row, var col);
577 
579  var getFieldAsInteger(var row, var col);
580 
582  var getFieldAsDouble(var row, var col);
583 
585  var getFieldAsDouble(var row, var col);
586 
587 
588 
590  var getFieldLength(var row, var col);
591 
593  var getFieldLength(var row, var col);
594 
595 
596 
599  var getRow(var row);
600 
603  var getRowLengths(var row);
604 
607  var getColumnNames();
608 
610  var getColumnName(var col);
611 
613  var getColumnType(var col);
614 
616  var getColumnType(var col);
617 
620  var getColumnLength(var col);
621 
624  var getColumnLength(var col);
625 
632  var getColumnPrecision(var col);
633 
640  var getColumnPrecision(var col);
641 
646  var getColumnScale(var col);
647 
652  var getColumnScale(var col);
653 
656  var getColumnIsNullable(var col);
657 
660  var getColumnIsNullable(var col);
661 
664  var getColumnIsPrimaryKey(var col);
665 
668  var getColumnIsPrimaryKey(var col);
669 
672  var getColumnIsUnique(var col);
673 
676  var getColumnIsUnique(var col);
677 
680  var getColumnIsPartOfKey(var col);
681 
684  var getColumnIsPartOfKey(var col);
685 
688  var getColumnIsUnsigned(var col);
689 
692  var getColumnIsUnsigned(var col);
693 
697  var getColumnIsZeroFilled(var col);
698 
702  var getColumnIsZeroFilled(var col);
703 
707  var getColumnIsBinary(var col);
708 
712  var getColumnIsBinary(var col);
713 
716  var getColumnIsAutoIncrement(var col);
717 
720  var getColumnIsAutoIncrement(var col);
721 
724  var getLongest(var col);
725 
728  var getLongest(var col);
729 
730 
731 
737  function suspendResultSet();
738 
745  var getResultSetId();
746 
750  var resumeResultSet(var id);
751 
756  var resumeCachedResultSet(var id,
757  var filename);
758 
763  function closeResultSet();
764 };
setResponseTimeout(var timeoutsec, var timeoutusec)
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)
setConnectTimeout(var timeoutsec, var timeoutusec)
function setClientInfo(var clientinfo)
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)
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:196
var getColumnIsNullable(var col)
function setResultSetBufferSize(var rows)
var getColumnIsPartOfKey(var col)
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 mixedCaseColumnNames()
var getFieldAsInteger(var row, var col)
var getConnectionPort()
var getOutputBindInteger(var variable)
var getColumnScale(var col)
var endOfResultSet()
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)
setAuthenticationTimeout(var timeoutsec, var timeoutusec)
var getColumnIsUnsigned(var col)
var getResultSetId()
var getColumnList(var table, var wild)
var totalRows()
function defineOutputBindCursor(var variable)
function setCacheTtl(var ttl)