root/GearsORM/trunk/docs/files/GearsORM-js.html

Revision 414, 11.1 kB (checked in by uriel, 9 months ago)

*updated docs
*changed version to 0.2.1
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
3<html><head><title>GearsORM.js</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
4if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
6<!--  Generated by Natural Docs, version 1.35 -->
7<!--  http://www.naturaldocs.org  -->
8
9<!-- saved from url=(0026)http://www.naturaldocs.org -->
10
11<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MEntry><div class=MFile><a href="GearsORM-Events-js.html">Events.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Fields-js.html">Fields.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Introspection-js.html">Introspection.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>js</div></div><div class=MEntry><div class=MFile><a href="GearsORM-Model-js.html">Model.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-ResultIterator-js.html">ResultIterator.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Sql-js.html">Sql.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Transaction-js.html">Transaction.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Properties.html">Properties</a></div></div></div></div></div><!--END_ND_MENU--></td>
12
13<td class=ContentSection valign=top><div class=CFile id=MainTopic><div class=CTopic><h1 class=CTitle><a name="GearsORM.js"></a>GearsORM.js</h1><div class=CBody><p class=CParagraph>Contains the main namespace for GearsORM and a thin abstraction for open,close and execute functions</p><h4 class=CHeading>License</h4><p class=CParagraph>MIT-style license.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#GearsORM.js" >GearsORM.js</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Contains the main namespace for GearsORM and a thin abstraction for open,close and execute functions</div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM" >GearsORM</a></div></div></td><td><div class=SClass><div class=SDescription>the main namespace for GearsORM,also provide a basic api wrapper for execute,close and open</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.getDB" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">getDB</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return a open database connection</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.execute" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">execute</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>execute a sql query on the database</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.executeAndClose" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">executeAndClose</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>execute a sql query on the database and close it.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.close" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">close</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>close the database connection.</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
14
15<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM"></a>GearsORM</h2><div class=CBody><p class=CParagraph>the main namespace for GearsORM,also provide a basic api wrapper for execute,close and open</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SGroup><div class=SEntry><a href="#GearsORM.Functions" >Functions</a></div></div></td><td class=SDescriptionSize><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.getDB" id=link5 onMouseOver="ShowTip(event, 'tt1', 'link5')" onMouseOut="HideTip('tt1')">getDB</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return a open database connection</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.execute" id=link6 onMouseOver="ShowTip(event, 'tt2', 'link6')" onMouseOut="HideTip('tt2')">execute</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>execute a sql query on the database</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.executeAndClose" id=link7 onMouseOver="ShowTip(event, 'tt3', 'link7')" onMouseOut="HideTip('tt3')">executeAndClose</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>execute a sql query on the database and close it.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.close" id=link8 onMouseOver="ShowTip(event, 'tt4', 'link8')" onMouseOut="HideTip('tt4')">close</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>close the database connection.</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16
17<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Functions"></a>Functions</h3></div></div>
18
19<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.getDB"></a>getDB</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDB:function()</td></tr></table></blockquote><p class=CParagraph>return a open database connection</p><h4 class=CHeading>Returns</h4><p class=CParagraph>A open database connection.</p></div></div></div>
20
21<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.execute"></a>execute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>execute:function(</td><td class=PParameter nowrap>sql,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>execute a sql query on the database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sql</td><td class=CDLDescription>sql query to execute</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>bind parameters to be used in the sql query,optional</td></tr></table></div></div></div>
22
23<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.executeAndClose"></a>executeAndClose</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>executeAndClose:function(</td><td class=PParameter nowrap>sql,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>execute a sql query on the database and close it.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sql</td><td class=CDLDescription>sql query to execute</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>bind parameters to be used in the sql query,optional</td></tr></table></div></div></div>
24
25<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.close"></a>close</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>close:function()</td></tr></table></blockquote><p class=CParagraph>close the database connection.</p></div></div></div>
26
27</td>
28
29</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
30<!--START_ND_TOOLTIPS-->
31<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDB:function()</td></tr></table></blockquote>return a open database connection</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>execute:function(</td><td class=PParameter nowrap>sql,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>execute a sql query on the database</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>executeAndClose:function(</td><td class=PParameter nowrap>sql,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>execute a sql query on the database and close it.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>close:function()</td></tr></table></blockquote>close the database connection.</div></div><!--END_ND_TOOLTIPS-->
32
33<script language=JavaScript><!--
34if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Note: See TracBrowser for help on using the browser.