Show
Ignore:
Timestamp:
03/22/08 13:40:09 (5 months ago)
Author:
uriel
Message:

*updated docs
*changed version to 0.2.1

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • GearsORM/trunk/docs/files/GearsORM-Fields-js.html

    r329 r414  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> 
    22 
    3 <html><head><title>GearsORM.Fields.js</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body id=ContentPage onLoad="NDOnLoad()"><script language=JavaScript><!-- 
    4 if (browserType) {document.write("<div id=" + browserType + ">");if (browserVer) {document.write("<div id=" + browserVer + ">"); }}// --></script> 
     3<html><head><title>GearsORM.Fields.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> 
    55 
    6 <!--  Generated by Natural Docs, version Development Release 02-10-2007 (1.35 base) --> 
     6<!--  Generated by Natural Docs, version 1.35 --> 
    77<!--  http://www.naturaldocs.org  --> 
    88 
    99<!-- saved from url=(0026)http://www.naturaldocs.org --> 
    1010 
     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 id=MSelected>Fields.js</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><a href="GearsORM-js.html">js</a></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> 
    1112 
     13<td class=ContentSection valign=top><div class=CFile id=MainTopic><div class=CTopic><h1 class=CTitle><a name="GearsORM.Fields.js"></a>GearsORM.<span class=HB> </span>Fields.js</h1><div class=CBody><p class=CParagraph>Contains the fields to be used in the models.</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.Fields.js" >GearsORM.<span class=HB> </span>Fields.js</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Contains the fields to be used in the models.</div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.Field.Primitive" >GearsORM.<span class=HB> </span>Field.<span class=HB> </span>Primitive</a></div></div></td><td><div class=SClass><div class=SDescription>a meta class for basic field types like varchar,integer,real and timestamp</div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.Fields.ManyToOne" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToOne</a></div></div></td><td><div class=SClass><div class=SDescription>represent a ManyToOne relation,this isn`t a actual table field.</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToOne.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.Fields.ManyToOne.copy" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToOne.toSql" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToOne.select" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">select</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>do a SELECT on the related table</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToOne.remove" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>do a DELETE on the related table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToOne.getRelatedClass" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the related model class</div></div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.Fields.OneToMany" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>OneToMany</a></div></div></td><td><div class=SClass><div class=SDescription>represent a forigen key relation</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.OneToMany.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.Fields.OneToMany.copy" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.OneToMany.toSql" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.OneToMany.getRelatedClass" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the related model class</div></div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.Fields.ManyToMany" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToMany</a></div></div></td><td><div class=SClass><div class=SDescription>represent a many to many relation between two tables using a many to many relation table</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.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.Fields.ManyToMany.copy" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" >getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the related model class</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.add" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">add</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>add a relation between this object to another object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.toSql" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.createTable" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">createTable</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>create the many to many table</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.select" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">select</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>do a SELECT on the related table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.remove" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>delete a relation between this object and other object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.dropTable" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">dropTable</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>drop the many to many table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the related model class</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    1214 
     15<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.Field.Primitive"></a>GearsORM.<span class=HB> </span>Field.<span class=HB> </span>Primitive</h2><div class=CBody><p class=CParagraph>a meta class for basic field types like varchar,integer,real and timestamp</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sqlType</td><td class=CDLDescription>the sql string for the type</td></tr></table></div></div></div> 
    1316 
    14 <div id=Content><div class="CFile CTopic" id=MainTopic><h1 class=CTitle><a name="GearsORM.Fields.js"></a>GearsORM.<span class=HB> </span>Fields.js</h1><div class=CBody><p class=CParagraph>Contains the fields to be used in the models.</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=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#GearsORM.Fields.js" >GearsORM.<span class=HB> </span>Fields.js</a></td><td class=SDescription>Contains the fields to be used in the models.</td></tr><tr class="SClass"><td class=SEntry><a href="#GearsORM.Field.Primitive" >GearsORM.<span class=HB> </span>Field.<span class=HB> </span>Primitive</a></td><td class=SDescription>a meta class for basic field types like varchar,integer,real and timestamp</td></tr><tr class="SClass"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToOne</a></td><td class=SDescription>represent a ManyToOne relation,this isn`t a actual table field.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.copy" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.toSql" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.select" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">select</a></td><td class=SDescription>do a SELECT on the related table</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.remove" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">remove</a></td><td class=SDescription>do a DELETE on the related table</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.getRelatedClass" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr><tr class="SClass"><td class=SEntry><a href="#GearsORM.Fields.OneToMany" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>OneToMany</a></td><td class=SDescription>represent a forigen key relation</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.copy" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.toSql" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.getRelatedClass" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr><tr class="SClass"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany" >GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToMany</a></td><td class=SDescription>represent a many to many relation between two tables using a many to many relation table</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.copy" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" >getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.add" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">add</a></td><td class=SDescription>add a relation between this object to another object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.toSql" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.createTable" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">createTable</a></td><td class=SDescription>create the many to many table</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.select" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">select</a></td><td class=SDescription>do a SELECT on the related table</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.remove" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">remove</a></td><td class=SDescription>delete a relation between this object and other object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.dropTable" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">dropTable</a></td><td class=SDescription>drop the many to many table</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     17<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.Fields.ManyToOne"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToOne</h2><div class=CBody><p class=CParagraph>represent a ManyToOne relation,this isn`t a actual table field.</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;,</td></tr><tr><td class=CDLEntry>onDeleteCascade:true/false</td><td class=CDLDescription>if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT }</td></tr></table><!--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.Fields.ManyToOne.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.Fields.ManyToOne.copy" id=link17 onMouseOver="ShowTip(event, 'tt1', 'link17')" onMouseOut="HideTip('tt1')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToOne.toSql" id=link18 onMouseOver="ShowTip(event, 'tt2', 'link18')" onMouseOut="HideTip('tt2')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToOne.select" id=link19 onMouseOver="ShowTip(event, 'tt3', 'link19')" onMouseOut="HideTip('tt3')">select</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>do a SELECT on the related table</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToOne.remove" id=link20 onMouseOver="ShowTip(event, 'tt4', 'link20')" onMouseOut="HideTip('tt4')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>do a DELETE on the related table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToOne.getRelatedClass" id=link21 onMouseOver="ShowTip(event, 'tt5', 'link21')" onMouseOut="HideTip('tt5')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the related model class</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    1518 
    16 <div class="CClass CTopic"><h2 class=CTitle><a name="GearsORM.Field.Primitive"></a>GearsORM.<span class=HB> </span>Field.<span class=HB> </span>Primitive</h2><div class=CBody><p class=CParagraph>a meta class for basic field types like varchar,integer,real and timestamp</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sqlType</td><td class=CDLDescription>the sql string for the type</td></tr></table></div></div> 
     19<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.Functions"></a>Functions</h3></div></div> 
    1720 
    18 <div class="CClass CTopic"><h2 class=CTitle><a name="GearsORM.Fields.ManyToOne"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToOne</h2><div class=CBody><p class=CParagraph>represent a ManyToOne relation,this isn`t a actual table field.</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;,</td></tr><tr><td class=CDLEntry>onDeleteCascade:true/false</td><td class=CDLDescription>if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT }</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.copy" id=link17 onMouseOver="ShowTip(event, 'tt1', 'link17')" onMouseOut="HideTip('tt1')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.toSql" id=link18 onMouseOver="ShowTip(event, 'tt2', 'link18')" onMouseOut="HideTip('tt2')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.select" id=link19 onMouseOver="ShowTip(event, 'tt3', 'link19')" onMouseOut="HideTip('tt3')">select</a></td><td class=SDescription>do a SELECT on the related table</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.remove" id=link20 onMouseOver="ShowTip(event, 'tt4', 'link20')" onMouseOut="HideTip('tt4')">remove</a></td><td class=SDescription>do a DELETE on the related table</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToOne.getRelatedClass" id=link21 onMouseOver="ShowTip(event, 'tt5', 'link21')" onMouseOut="HideTip('tt5')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     21<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div></div> 
    1922 
    20 <div class="CGroup CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.Functions"></a>Functions</h3></div> 
     23<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div></div> 
    2124 
    22 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div> 
     25<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.select"></a>select</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>select:function(</td><td class=PParameter nowrap>whereExpression,</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>do a SELECT on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query</td></tr></table></div></div></div> 
    2326 
    24 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div> 
     27<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.remove"></a>remove</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>remove:function(</td><td class=PParameter nowrap>whereExpression,</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>do a DELETE on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query</td></tr></table></div></div></div> 
    2528 
    26 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.select"></a>select</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>select:function(</td><td class=PParameter nowrap>whereExpression,</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>do a SELECT on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query</td></tr></table></div></div> 
     29<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div></div> 
    2730 
    28 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.remove"></a>remove</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>remove:function(</td><td class=PParameter nowrap>whereExpression,</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>do a DELETE on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query</td></tr></table></div></div> 
     31<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.Fields.OneToMany"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>OneToMany</h2><div class=CBody><p class=CParagraph>represent a forigen key relation</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;, onDeleteCascade:if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT, allowNull:allow a null value }</td></tr></table><!--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.Fields.OneToMany.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.Fields.OneToMany.copy" id=link22 onMouseOver="ShowTip(event, 'tt6', 'link22')" onMouseOut="HideTip('tt6')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.OneToMany.toSql" id=link23 onMouseOver="ShowTip(event, 'tt7', 'link23')" onMouseOut="HideTip('tt7')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.OneToMany.getRelatedClass" id=link24 onMouseOver="ShowTip(event, 'tt8', 'link24')" onMouseOut="HideTip('tt8')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the related model class</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    2932 
    30 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToOne.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div> 
     33<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.Functions"></a>Functions</h3></div></div> 
    3134 
    32 <div class="CClass CTopic"><h2 class=CTitle><a name="GearsORM.Fields.OneToMany"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>OneToMany</h2><div class=CBody><p class=CParagraph>represent a forigen key relation</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;, onDeleteCascade:if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT, allowNull:allow a null value }</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.copy" id=link22 onMouseOver="ShowTip(event, 'tt6', 'link22')" onMouseOut="HideTip('tt6')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.toSql" id=link23 onMouseOver="ShowTip(event, 'tt7', 'link23')" onMouseOut="HideTip('tt7')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.OneToMany.getRelatedClass" id=link24 onMouseOver="ShowTip(event, 'tt8', 'link24')" onMouseOut="HideTip('tt8')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     35<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div></div> 
    3336 
    34 <div class="CGroup CTopic"><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.Functions"></a>Functions</h3></div> 
     37<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div></div> 
    3538 
    36 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div> 
     39<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div></div> 
    3740 
    38 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div> 
     41<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.Fields.ManyToMany"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToMany</h2><div class=CBody><p class=CParagraph>represent a many to many relation between two tables using a many to many relation table</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;, onDeleteCascade:if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT }</td></tr></table><!--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.Fields.ManyToMany.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.Fields.ManyToMany.copy" id=link25 onMouseOver="ShowTip(event, 'tt9', 'link25')" onMouseOut="HideTip('tt9')">copy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>create a copy of this object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" >getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the related model class</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.add" id=link26 onMouseOver="ShowTip(event, 'tt10', 'link26')" onMouseOut="HideTip('tt10')">add</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>add a relation between this object to another object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.toSql" id=link27 onMouseOver="ShowTip(event, 'tt11', 'link27')" onMouseOut="HideTip('tt11')">toSql</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the sql string for this field</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.createTable" id=link28 onMouseOver="ShowTip(event, 'tt12', 'link28')" onMouseOut="HideTip('tt12')">createTable</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>create the many to many table</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.select" id=link29 onMouseOver="ShowTip(event, 'tt13', 'link29')" onMouseOut="HideTip('tt13')">select</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>do a SELECT on the related table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.remove" id=link30 onMouseOver="ShowTip(event, 'tt14', 'link30')" onMouseOut="HideTip('tt14')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>delete a relation between this object and other object</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.dropTable" id=link31 onMouseOver="ShowTip(event, 'tt15', 'link31')" onMouseOut="HideTip('tt15')">dropTable</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>drop the many to many table</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" id=link32 onMouseOver="ShowTip(event, 'tt16', 'link32')" onMouseOut="HideTip('tt16')">getRelatedClass</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the related model class</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    3942 
    40 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.OneToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div> 
     43<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.Functions"></a>Functions</h3></div></div> 
    4144 
    42 <div class="CClass CTopic"><h2 class=CTitle><a name="GearsORM.Fields.ManyToMany"></a>GearsORM.<span class=HB> </span>Fields.<span class=HB> </span>ManyToMany</h2><div class=CBody><p class=CParagraph>represent a many to many relation between two tables using a many to many relation table</p><h4 class=CHeading>Constructor</h4><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>a object that look like this: { related:&rdquo;name_of_the_related_table&rdquo;, onDeleteCascade:if true this will create triggers to emulate a ON DELETE CASCADE,if this is false it will do ON DELETE RESTRICT }</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.copy" id=link25 onMouseOver="ShowTip(event, 'tt9', 'link25')" onMouseOut="HideTip('tt9')">copy</a></td><td class=SDescription>create a copy of this object</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" >getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.add" id=link26 onMouseOver="ShowTip(event, 'tt10', 'link26')" onMouseOut="HideTip('tt10')">add</a></td><td class=SDescription>add a relation between this object to another object</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.toSql" id=link27 onMouseOver="ShowTip(event, 'tt11', 'link27')" onMouseOut="HideTip('tt11')">toSql</a></td><td class=SDescription>return the sql string for this field</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.createTable" id=link28 onMouseOver="ShowTip(event, 'tt12', 'link28')" onMouseOut="HideTip('tt12')">createTable</a></td><td class=SDescription>create the many to many table</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.select" id=link29 onMouseOver="ShowTip(event, 'tt13', 'link29')" onMouseOut="HideTip('tt13')">select</a></td><td class=SDescription>do a SELECT on the related table</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.remove" id=link30 onMouseOver="ShowTip(event, 'tt14', 'link30')" onMouseOut="HideTip('tt14')">remove</a></td><td class=SDescription>delete a relation between this object and other object</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.dropTable" id=link31 onMouseOver="ShowTip(event, 'tt15', 'link31')" onMouseOut="HideTip('tt15')">dropTable</a></td><td class=SDescription>drop the many to many table</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Fields.ManyToMany.getRelatedClass" id=link32 onMouseOver="ShowTip(event, 'tt16', 'link32')" onMouseOut="HideTip('tt16')">getRelatedClass</a></td><td class=SDescription>return the related model class</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     45<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div></div> 
    4346 
    44 <div class="CGroup CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.Functions"></a>Functions</h3></div> 
     47<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><p class=CParagraph>return the related model class</p></div></div></div> 
    4548 
    46 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.copy"></a>copy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote><p class=CParagraph>create a copy of this object</p></div></div> 
     49<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.add"></a>add</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>add:function(</td><td class=PParameter nowrap>realtedObject</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>add a relation between this object to another object</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>realtedObject</td><td class=CDLDescription>a related model instance or a id of that object</td></tr></table></div></div></div> 
    4750 
    48 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><p class=CParagraph>return the related model class</p></div></div> 
     51<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div></div> 
    4952 
    50 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.add"></a>add</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>add:function(</td><td class=PParameter nowrap>realtedObject</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>add a relation between this object to another object</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>realtedObject</td><td class=CDLDescription>a related model instance or a id of that object</td></tr></table></div></div> 
     53<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.createTable"></a>createTable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>createTable:function()</td></tr></table></blockquote><p class=CParagraph>create the many to many table</p></div></div></div> 
    5154 
    52 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.toSql"></a>toSql</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote><p class=CParagraph>return the sql string for this field</p></div></div> 
     55<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.select"></a>select</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>select:function(</td><td class=PParameter nowrap>whereExpression,</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>do a SELECT on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query.</td></tr></table></div></div></div> 
    5356 
    54 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.createTable"></a>createTable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>createTable:function()</td></tr></table></blockquote><p class=CParagraph>create the many to many table</p></div></div> 
     57<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.remove"></a>remove</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>remove:function(</td><td class=PParameter nowrap>related</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>delete a relation between this object and other object</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>realtedObject</td><td class=CDLDescription>a related model instance or a id of that object</td></tr></table></div></div></div> 
    5558 
    56 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.select"></a>select</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>select:function(</td><td class=PParameter nowrap>whereExpression,</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>do a SELECT on the related table</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>whereExpression</td><td class=CDLDescription>sql where expression.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>a array of bind parameters to be used in sql query.</td></tr></table></div></div> 
     59<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.dropTable"></a>dropTable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>dropTable:function()</td></tr></table></blockquote><p class=CParagraph>drop the many to many table</p></div></div></div> 
    5760 
    58 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.remove"></a>remove</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>remove:function(</td><td class=PParameter nowrap>related</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>delete a relation between this object and other object</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>realtedObject</td><td class=CDLDescription>a related model instance or a id of that object</td></tr></table></div></div> 
     61<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div></div> 
    5962 
    60 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.dropTable"></a>dropTable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>dropTable:function()</td></tr></table></blockquote><p class=CParagraph>drop the many to many table</p></div></div> 
     63</td> 
    6164 
    62 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Fields.ManyToMany.getRelatedClass"></a>getRelatedClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote><p class=CParagraph>return the related model class</p></div></div> 
    63  
    64 </div><!--Content--> 
    65  
    66  
    67 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer--> 
    68  
    69  
    70 <div id=Menu><div class="MFile MEntry" id=MSelected>GearsORM.<span class=HB> </span>Fields.js</div><div class="MFile MEntry"><a href="GearsORM-Introspection-js.html">GearsORM.<span class=HB> </span>Introspection.js</a></div><div class="MFile MEntry"><a href="GearsORM-js.html">GearsORM.js</a></div><div class="MFile MEntry"><a href="GearsORM-Model-js.html">GearsORM.<span class=HB> </span>Model.js</a></div><div class="MFile MEntry"><a href="GearsORM-ResultIterator-js.html">GearsORM.<span class=HB> </span>ResultIterator.js</a></div><div class="MFile MEntry"><a href="GearsORM-Transaction-js.html">GearsORM.<span class=HB> </span>Transaction.js</a></div><div class="MGroup MEntry"><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class="MIndex MEntry"><a href="../index/General.html">Everything</a></div><div class="MIndex MEntry"><a href="../index/Classes.html">Classes</a></div><div class="MIndex MEntry"><a href="../index/Files.html">Files</a></div><div class="MIndex MEntry"><a href="../index/Functions.html">Functions</a></div><div class="MIndex MEntry"><a href="../index/Properties.html">Properties</a></div></div></div><script type="text/javascript"><!-- 
    71 var searchPanel = new SearchPanel("searchPanel", "HTML", "../search"); 
    72 --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div></div><!--Menu--> 
    73  
    74  
    75  
     65</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div> 
    7666<!--START_ND_TOOLTIPS--> 
    7767<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote>create a copy of this object</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote>return the sql string for this field</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>select:function(</td><td class=PParameter nowrap>whereExpression,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>do a SELECT on the related table</div></div><div class=CToolTip id="tt4"><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>remove:function(</td><td class=PParameter nowrap>whereExpression,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>do a DELETE on the related table</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote>return the related model class</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote>create a copy of this object</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote>return the sql string for this field</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote>return the related model class</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>copy:function()</td></tr></table></blockquote>create a copy of this object</div></div><div class=CToolTip id="tt10"><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>add:function(</td><td class=PParameter nowrap>realtedObject</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>add a relation between this object to another object</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toSql:function()</td></tr></table></blockquote>return the sql string for this field</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>createTable:function()</td></tr></table></blockquote>create the many to many table</div></div><div class=CToolTip id="tt13"><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>select:function(</td><td class=PParameter nowrap>whereExpression,</td></tr><tr><td></td><td class=PParameter nowrap>params</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>do a SELECT on the related table</div></div><div class=CToolTip id="tt14"><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>remove:function(</td><td class=PParameter nowrap>related</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>delete a relation between this object and other object</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>dropTable:function()</td></tr></table></blockquote>drop the many to many table</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getRelatedClass:function()</td></tr></table></blockquote>return the related model class</div></div><!--END_ND_TOOLTIPS--> 
    7868 
    79  
    80  
    81  
    8269<script language=JavaScript><!-- 
    8370if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> 

  • GearsORM/trunk/docs/files/GearsORM-Introspection-js.html

    r329 r414  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> 
    22 
    3 <html><head><title>GearsORM.Introspection.js</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body id=ContentPage onLoad="NDOnLoad()"><script language=JavaScript><!-- 
    4 if (browserType) {document.write("<div id=" + browserType + ">");if (browserVer) {document.write("<div id=" + browserVer + ">"); }}// --></script> 
     3<html><head><title>GearsORM.Introspection.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> 
    55 
    6 <!--  Generated by Natural Docs, version Development Release 02-10-2007 (1.35 base) --> 
     6<!--  Generated by Natural Docs, version 1.35 --> 
    77<!--  http://www.naturaldocs.org  --> 
    88 
    99<!-- saved from url=(0026)http://www.naturaldocs.org --> 
    1010 
     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 id=MSelected>Introspection.js</div></div><div class=MEntry><div class=MFile><a href="GearsORM-js.html">js</a></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> 
    1112 
     13<td class=ContentSection valign=top><div class=CFile id=MainTopic><div class=CTopic><h1 class=CTitle><a name="GearsORM.Introspection.js"></a>GearsORM.<span class=HB> </span>Introspection.js</h1><div class=CBody><p class=CParagraph>Contains the GearsORM.Introspection utility class, which contain also a model for sqlite_master table</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.Introspection.js" >GearsORM.<span class=HB> </span>Introspection.js</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Contains the GearsORM.Introspection utility class, which contain also a model for sqlite_master table</div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.Introspection" >GearsORM.<span class=HB> </span>Introspection</a></div></div></td><td><div class=SClass><div class=SDescription>a utility class to do database introspection.</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Introspection.Properties" >Properties</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=SProperty><div class=SEntry><div class=SIndent2><a href="#GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel" >GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.Introspection.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.Introspection.doesTableExist" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">doesTableExist</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    1214 
     15<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.Introspection"></a>GearsORM.<span class=HB> </span>Introspection</h2><div class=CBody><p class=CParagraph>a utility class to do database introspection.</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.Introspection.Properties" >Properties</a></div></div></td><td class=SDescriptionSize><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel" >GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><a href="#GearsORM.Introspection.Functions" >Functions</a></div></div></td><td><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.Introspection.doesTableExist" id=link2 onMouseOver="ShowTip(event, 'tt1', 'link2')" onMouseOut="HideTip('tt1')">doesTableExist</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> 
    1316 
    14 <div id=Content><div class="CFile CTopic" id=MainTopic><h1 class=CTitle><a name="GearsORM.Introspection.js"></a>GearsORM.<span class=HB> </span>Introspection.js</h1><div class=CBody><p class=CParagraph>Contains the GearsORM.Introspection utility class, which contain also a model for sqlite_master table</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=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#GearsORM.Introspection.js" >GearsORM.<span class=HB> </span>Introspection.js</a></td><td class=SDescription>Contains the GearsORM.Introspection utility class, which contain also a model for sqlite_master table</td></tr><tr class="SClass"><td class=SEntry><a href="#GearsORM.Introspection" >GearsORM.<span class=HB> </span>Introspection</a></td><td class=SDescription>a utility class to do database introspection.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#GearsORM.Introspection.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel" >GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</a></td><td class=SDescription>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#GearsORM.Introspection.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#GearsORM.Introspection.doesTableExist" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">doesTableExist</a></td><td class=SDescription>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     17<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Introspection.Properties"></a>Properties</h3></div></div> 
    1518 
    16 <div class="CClass CTopic"><h2 class=CTitle><a name="GearsORM.Introspection"></a>GearsORM.<span class=HB> </span>Introspection</h2><div class=CBody><p class=CParagraph>a utility class to do database introspection.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBody><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#GearsORM.Introspection.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel" >GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</a></td><td class=SDescription>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</td></tr><tr class="SGroup"><td class=SEntry><a href="#GearsORM.Introspection.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#GearsORM.Introspection.doesTableExist" id=link2 onMouseOver="ShowTip(event, 'tt1', 'link2')" onMouseOut="HideTip('tt1')">doesTableExist</a></td><td class=SDescription>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div> 
     19<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel"></a>GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</h3><div class=CBody><p class=CParagraph>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</p></div></div></div> 
    1720 
    18 <div class="CGroup CTopic"><h3 class=CTitle><a name="GearsORM.Introspection.Properties"></a>Properties</h3></div> 
     21<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.Introspection.Functions"></a>Functions</h3></div></div> 
    1922 
    20 <div class="CProperty CTopic"><h3 class=CTitle><a name="GearsORM.Introspection.GearsORM.Introspection.sqliteMasterModel"></a>GearsORM.<span class=HB> </span>Introspection.<span class=HB> </span>sqliteMasterModel</h3><div class=CBody><p class=CParagraph>a model to work with sqlite_master(provide information on the schema) table sqlite_master definition from sqlite site: CREATE TABLE sqlite_master ( type TEXT, name TEXT, tbl_name TEXT, rootpage INTEGER, sql TEXT );</p></div></div> 
     23<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.Introspection.doesTableExist"></a>doesTableExist</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>doesTableExist:function()</td></tr></table></blockquote><p class=CParagraph>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</p></div></div></div> 
    2124 
    22 <div class="CGroup CTopic"><h3 class=CTitle><a name="GearsORM.Introspection.Functions"></a>Functions</h3></div> 
     25</td> 
    2326 
    24 <div class="CFunction CTopic"><h3 class=CTitle><a name="GearsORM.Introspection.doesTableExist"></a>doesTableExist</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>doesTableExist:function()</td></tr></table></blockquote><p class=CParagraph>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</p></div></div> 
    25  
    26 </div><!--Content--> 
    27  
    28  
    29 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer--> 
    30  
    31  
    32 <div id=Menu><div class="MFile MEntry"><a href="GearsORM-Fields-js.html">GearsORM.<span class=HB> </span>Fields.js</a></div><div class="MFile MEntry" id=MSelected>GearsORM.<span class=HB> </span>Introspection.js</div><div class="MFile MEntry"><a href="GearsORM-js.html">GearsORM.js</a></div><div class="MFile MEntry"><a href="GearsORM-Model-js.html">GearsORM.<span class=HB> </span>Model.js</a></div><div class="MFile MEntry"><a href="GearsORM-ResultIterator-js.html">GearsORM.<span class=HB> </span>ResultIterator.js</a></div><div class="MFile MEntry"><a href="GearsORM-Transaction-js.html">GearsORM.<span class=HB> </span>Transaction.js</a></div><div class="MGroup MEntry"><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class="MIndex MEntry"><a href="../index/General.html">Everything</a></div><div class="MIndex MEntry"><a href="../index/Classes.html">Classes</a></div><div class="MIndex MEntry"><a href="../index/Files.html">Files</a></div><div class="MIndex MEntry"><a href="../index/Functions.html">Functions</a></div><div class="MIndex MEntry"><a href="../index/Properties.html">Properties</a></div></div></div><script type="text/javascript"><!-- 
    33 var searchPanel = new SearchPanel("searchPanel", "HTML", "../search"); 
    34 --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div></div><!--Menu--> 
    35  
    36  
    37  
     27</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div> 
    3828<!--START_ND_TOOLTIPS--> 
    3929<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>doesTableExist:function()</td></tr></table></blockquote>get the names of the tables to checked if they exist return true if <b>all</b> of them exist else return false</div></div><!--END_ND_TOOLTIPS--> 
    4030 
    41  
    42  
    43  
    4431<script language=JavaScript><!-- 
    4532if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> 

  • GearsORM/trunk/docs/files/GearsORM-Model-js.html

    r329 r414  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> 
    22 
    3 <html><head><title>GearsORM.Model.js</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body id=ContentPage onLoad="NDOnLoad()"><script language=JavaScript><!-- 
    4 if (browserType) {document.write("<div id=" + browserType + ">");if (browserVer) {document.write("<div id=" + browserVer + ">"); }}// --></script> 
     3<html><head><title>GearsORM.Model.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> 
    55 
    6 <!--  Generated by Natural Docs, version Development Release 02-10-2007 (1.35 base) --> 
     6<!--  Generated by Natural Docs, version 1.35 --> 
    77<!--  http://www.naturaldocs.org  --> 
    88 
    99<!-- saved from url=(0026)http://www.naturaldocs.org --> 
    1010 
     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><a href="GearsORM-js.html">js</a></div></div><div class=MEntry><div class=MFile id=MSelected>Model.js</div></div><div class=MEntry><div class=MFile><a href="GearsORM-ResultIterator-js.html">ResultIterator.js</a></div></div><div class=MEntry><div class