Browse Source

Fix executeQuery documentation

Rob Ryan 11 years ago
parent
commit
f954bad943

+ 1 - 1
html/Blocks/FMDBExecuteStatementsCallbackBlock.html

@@ -80,7 +80,7 @@
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Categories/FMDatabase+FMDatabaseAdditions.html

@@ -1459,7 +1459,7 @@
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Categories/NSObject+FMDatabasePoolDelegate.html

@@ -256,7 +256,7 @@
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 3 - 3
html/Classes/FMDatabase.html

@@ -1901,7 +1901,7 @@ FMDatabase *db     = [FMDatabase databaseWithPath:dbPath];
 
 <p>In order to iterate through the results of your query, you use a <code>while()</code> loop.  You also need to &ldquo;step&rdquo; (via <a href="../Classes/FMResultSet.html#//api/name/next"><code>[FMResultSet next]</code></a>) from one record to the other.</p>
 
-<p>This method employs <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> for any optional value parameters. This  properly escapes any characters that need escape sequences (e.g. quotation marks), which eliminates simple SQL errors as well as protects against SQL injection attacks. This method natively handles <code>NSString</code>, <code>NSNumber</code>, <code>NSNull</code>, <code>NSDate</code>, and <code>NSData</code> objects. All other object types will be interpreted as text values using the object&rsquo;s <code>description</code> method.</p>
+<p>This method employs <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> for any optional value parameters. This  properly escapes any characters that need escape sequences (e.g. quotation marks), which eliminates simple SQL errors as well as protects against SQL injection attacks. This method natively handles <code>NSString</code>, <code>NSNumber</code>, <code>NSNull</code>, <code>NSDate</code>, and <code>NSData</code> objects. All other object types will be interpreted as text values using the object&rsquo;s <code>description</code> method.</p><div class="note"><p><strong>Note:</strong> If you want to use this from Swift, please note that you must include <code>FMDatabaseVariadic.swift</code> in your project. Without that, you cannot use this method directly, and instead have to use methods such as <a href="#//api/name/executeQuery:withArgumentsInArray:"><code>executeQuery:withArgumentsInArray:</code></a>.</p></div>
 			</div>
 			
 
@@ -1996,7 +1996,7 @@ FMDatabase *db     = [FMDatabase databaseWithPath:dbPath];
 <pre><code>[db executeQuery:@"SELECT * FROM test WHERE name=?", @"Gus"];
 </code></pre>
 
-<p>There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite <code>?</code> placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with <code>pragma</code> statements and the like. Second, note the lack of quotation marks in the SQL. The <code>WHERE</code> clause was <em>not</em> <code>WHERE name='%@'</code> (like you might have to do if you built a SQL statement using <code>NSString</code> method <code>stringWithFormat</code>), but rather simply <code>WHERE name=%@</code>.</p></div><div class="note"><p><strong>Note:</strong> If you want to use this from Swift, please note that you must include <code>FMDatabaseVariadic.swift</code> in your project. Without that, you cannot use this method directly, and instead have to use methods such as <a href="#//api/name/executeQuery:withArgumentsInArray:"><code>executeQuery:withArgumentsInArray:</code></a>.</p></div>
+<p>There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite <code>?</code> placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with <code>pragma</code> statements and the like. Second, note the lack of quotation marks in the SQL. The <code>WHERE</code> clause was <em>not</em> <code>WHERE name='%@'</code> (like you might have to do if you built a SQL statement using <code>NSString</code> method <code>stringWithFormat</code>), but rather simply <code>WHERE name=%@</code>.</p></div>
 			</div>
 			
 
@@ -4445,7 +4445,7 @@ FMDatabase *db     = [FMDatabase databaseWithPath:dbPath];
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Classes/FMDatabasePool.html

@@ -1068,7 +1068,7 @@ in the main.m file.</p></div>
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Classes/FMDatabaseQueue.html

@@ -895,7 +895,7 @@
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Classes/FMResultSet.html

@@ -2836,7 +2836,7 @@ If you don&rsquo;t, you&rsquo;re going to be in a world of hurt when you try and
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/Classes/FMStatement.html

@@ -442,7 +442,7 @@
 				<footer>
 					<div class="footer-copyright">
 						
-						<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+						<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>

+ 1 - 1
html/hierarchy.html

@@ -87,7 +87,7 @@
 					<footer>
 						<div class="footer-copyright">
 							
-							<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+							<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>

+ 1 - 1
html/index.html

@@ -87,7 +87,7 @@
 					<footer>
 						<div class="footer-copyright">
 							
-							<p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-24</p>
+							<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>