mirror
/
fmdb


			
				
					
						
						
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475
							<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>FMDatabase(FMDatabaseAdditions) Category Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">FMDB </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">ccgus</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	

	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/applicationID">- applicationID</option>
		
		<option value="//api/name/applicationIDString">- applicationIDString</option>
		
		<option value="//api/name/boolForQuery:">- boolForQuery:</option>
		
		<option value="//api/name/columnExists:columnName:">- columnExists:columnName:</option>
		
		<option value="//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</option>
		
		<option value="//api/name/dataForQuery:">- dataForQuery:</option>
		
		<option value="//api/name/dateForQuery:">- dateForQuery:</option>
		
		<option value="//api/name/doubleForQuery:">- doubleForQuery:</option>
		
		<option value="//api/name/getSchema">- getSchema</option>
		
		<option value="//api/name/getTableSchema:">- getTableSchema:</option>
		
		<option value="//api/name/intForQuery:">- intForQuery:</option>
		
		<option value="//api/name/longForQuery:">- longForQuery:</option>
		
		<option value="//api/name/setApplicationID:">- setApplicationID:</option>
		
		<option value="//api/name/setApplicationIDString:">- setApplicationIDString:</option>
		
		<option value="//api/name/setUserVersion:">- setUserVersion:</option>
		
		<option value="//api/name/stringForQuery:">- stringForQuery:</option>
		
		<option value="//api/name/tableExists:">- tableExists:</option>
		
		<option value="//api/name/userVersion">- userVersion</option>
		
		<option value="//api/name/validateSQL:error:">- validateSQL:error:</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">FMDatabase(FMDatabaseAdditions) Category Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Declared in</th>
	<td>FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td>
</tr>
						</tbody></table></div>
					

                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>Category of additions for <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> class.</p>

<h3>See also</h3>

<ul>
<li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
</ul>

					</div>
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/stringForQuery:" title="stringForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/stringForQuery:">&ndash;&nbsp;stringForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>NSString</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (NSString *)stringForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>NSString</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>NSString</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/intForQuery:" title="intForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/intForQuery:">&ndash;&nbsp;intForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>int</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (int)intForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>int</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>int</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/longForQuery:" title="longForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/longForQuery:">&ndash;&nbsp;longForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>long</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>long</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>long</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/boolForQuery:" title="boolForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/boolForQuery:">&ndash;&nbsp;boolForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>BOOL</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>BOOL</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>BOOL</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/doubleForQuery:">&ndash;&nbsp;doubleForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>double</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (double)doubleForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>double</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>double</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/dataForQuery:" title="dataForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/dataForQuery:">&ndash;&nbsp;dataForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>NSData</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (NSData *)dataForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>NSData</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>NSData</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/dateForQuery:" title="dateForQuery:"></a>
	<h3 class="method-title"><code><a href="#//api/name/dateForQuery:">&ndash;&nbsp;dateForQuery:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Return <code>NSDate</code> value for query</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (NSDate *)dateForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>query</code></th>
						<td><p>The SQL query to be performed.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>...</code></th>
						<td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>NSDate</code> value.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Return <code>NSDate</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/tableExists:" title="tableExists:"></a>
	<h3 class="method-title"><code><a href="#//api/name/tableExists:">&ndash;&nbsp;tableExists:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Does table exist in database?</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (BOOL)tableExists:(NSString *)<em>tableName</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>tableName</code></th>
						<td><p>The name of the table being looked for.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>YES</code> if table found; <code>NO</code> if not found.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Does table exist in database?</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/getSchema" title="getSchema"></a>
	<h3 class="method-title"><code><a href="#//api/name/getSchema">&ndash;&nbsp;getSchema</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The schema of the database.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (FMResultSet *)getSchema</code></div>

		    
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>The schema of the database.</p>

<p>This will be the schema for the entire database. For each entity, each row of the result set will include the following fields:</p>

<ul>
<li><code>type</code> - The type of entity (e.g. table, index, view, or trigger)</li>
<li><code>name</code> - The name of the object</li>
<li><code>tbl_name</code> - The name of the table to which the object references</li>
<li><code>rootpage</code> - The page number of the root b-tree page for tables and indices</li>
<li><code>sql</code> - The SQL that created the entity</li>
</ul>

			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="http://www.sqlite.org/fileformat.html">SQLite File Format</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/getTableSchema:" title="getTableSchema:"></a>
	<h3 class="method-title"><code><a href="#//api/name/getTableSchema:">&ndash;&nbsp;getTableSchema:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The schema of the database.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (FMResultSet *)getTableSchema:(NSString *)<em>tableName</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>tableName</code></th>
						<td><p>The name of the table for whom the schema will be returned.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>The schema of the database.</p>

<p>This will be the schema for a particular table as report by SQLite <code>PRAGMA</code>, for example:</p>

<pre><code>PRAGMA table_info('employees')
</code></pre>

<p>This will report:</p>

<ul>
<li><code>cid</code> - The column ID number</li>
<li><code>name</code> - The name of the column</li>
<li><code>type</code> - The data type specified for the column</li>
<li><code>notnull</code> - whether the field is defined as NOT NULL (i.e. values required)</li>
<li><code>dflt_value</code> - The default value for the column</li>
<li><code>pk</code> - Whether the field is part of the primary key of the table</li>
</ul>

			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="http://www.sqlite.org/pragma.html#pragma_table_info">table_info</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/columnExists:inTableWithName:" title="columnExists:inTableWithName:"></a>
	<h3 class="method-title"><code><a href="#//api/name/columnExists:inTableWithName:">&ndash;&nbsp;columnExists:inTableWithName:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Test to see if particular column exists for particular table in database</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>columnName</em> inTableWithName:(NSString *)<em>tableName</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>columnName</code></th>
						<td><p>The name of the column.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>tableName</code></th>
						<td><p>The name of the table.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Test to see if particular column exists for particular table in database</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/applicationID" title="applicationID"></a>
	<h3 class="method-title"><code><a href="#//api/name/applicationID">&ndash;&nbsp;applicationID</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Retrieve application ID</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div>

		    
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>The <code>uint32_t</code> numeric value of the application ID.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Retrieve application ID</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/setApplicationID:" title="setApplicationID:"></a>
	<h3 class="method-title"><code><a href="#//api/name/setApplicationID:">&ndash;&nbsp;setApplicationID:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Set the application ID</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>appID</code></th>
						<td><p>The <code>uint32_t</code> numeric value of the application ID.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Set the application ID</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/applicationIDString" title="applicationIDString"></a>
	<h3 class="method-title"><code><a href="#//api/name/applicationIDString">&ndash;&nbsp;applicationIDString</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Retrieve application ID string</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div>

		    
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>The <code>NSString</code> value of the application ID.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Retrieve application ID string</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a>
	<h3 class="method-title"><code><a href="#//api/name/setApplicationIDString:">&ndash;&nbsp;setApplicationIDString:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Set the application ID string</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>string</code></th>
						<td><p>The <code>NSString</code> value of the application ID.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Set the application ID string</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/userVersion" title="userVersion"></a>
	<h3 class="method-title"><code><a href="#//api/name/userVersion">&ndash;&nbsp;userVersion</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Retrieve user version</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></div>

		    
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>The <code>uint32_t</code> numeric value of the user version.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Retrieve user version</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/setUserVersion:">- setUserVersion:</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/setUserVersion:" title="setUserVersion:"></a>
	<h3 class="method-title"><code><a href="#//api/name/setUserVersion:">&ndash;&nbsp;setUserVersion:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Set the user-version</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)setUserVersion:(uint32_t)<em>version</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>version</code></th>
						<td><p>The <code>uint32_t</code> numeric value of the user version.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Set the user-version</p>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/userVersion">- userVersion</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a>
	<h3 class="method-title"><code><a href="#//api/name/columnExists:columnName:">&ndash;&nbsp;columnExists:columnName:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Test to see if particular column exists for particular table in database</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>tableName</em> columnName:(NSString *)<em>columnName</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>tableName</code></th>
						<td><p>The name of the table.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>columnName</code></th>
						<td><p>The name of the column.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Test to see if particular column exists for particular table in database</p><div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</p></div>
			</div>
			

			

			
			<div class="method-subsection see-also-section">
				<h4 class="method-subtitle">See Also</h4>
				<ul>
					
					<li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li>
					
				</ul>
			</div>
			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a>
	<h3 class="method-title"><code><a href="#//api/name/validateSQL:error:">&ndash;&nbsp;validateSQL:error:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Validate SQL statement</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>sql</code></th>
						<td><p>The SQL statement being validated.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>error</code></th>
						<td><p>This is a pointer to a <code>NSError</code> object that will receive the autoreleased <code>NSError</code> object if there was any error. If this is <code>nil</code>, no <code>NSError</code> result will be returned.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p><code>YES</code> if validation succeeded without incident; <code>NO</code> otherwise.</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>Validate SQL statement</p>

<p>This validates SQL statement by performing <code>sqlite3_prepare_v2</code>, but not returning the results, but instead immediately calling <code>sqlite3_finalize</code>.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-25</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>