From b33aa49f00b4c8026302577d97c54ffe2dad4567 Mon Sep 17 00:00:00 2001
From: Shish <shish@shishnet.org>
Date: Tue, 9 Feb 2010 02:07:19 +0000
Subject: [PATCH] a technical explanation of build_accurate_search_querylet

---
 core/imageboard.pack.php | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/core/imageboard.pack.php b/core/imageboard.pack.php
index 9f1b5329..e96941e5 100644
--- a/core/imageboard.pack.php
+++ b/core/imageboard.pack.php
@@ -492,8 +492,24 @@ class Image {
 			return Image::build_accurate_search_querylet($terms);
 	}
 
-	// this method is simple, fast and accurate; but mysql chokes on it
-	// because it uses subqueries
+	/**
+	 * "foo bar -baz user=foo" becomes
+	 *
+	 * SELECT * FROM images WHERE
+	 *           images.id IN (SELECT image_id FROM image_tags WHERE tag='foo')
+	 *   AND     images.id IN (SELECT image_id FROM image_tags WHERE tag='bar')
+	 *   AND NOT images.id IN (SELECT image_id FROM image_tags WHERE tag='baz')
+	 *   AND     images.id IN (SELECT id FROM images WHERE owner_name='foo')
+	 *
+	 * This is:
+	 *   A) Incredibly simple:
+	 *      Each search term maps to a list of image IDs
+	 *   B) Runs really fast on a good database:
+	 *      These lists are calucalted once, and the set intersection taken
+	 *   C) Runs really slow on bad databases:
+	 *      All the subqueries are executed every time for every row in the
+	 *      images table. Yes, MySQL does suck this much.
+	 */
 	private static function build_accurate_search_querylet($terms) {
 		global $config, $database;
 
@@ -651,7 +667,10 @@ class Image {
 		return $query;
 	}
 
-	// this function exists because mysql is a turd.
+	/**
+	 * this function exists because mysql is a turd, see the docs for
+	 * build_accurate_search_querylet() for a full explanation
+	 */
 	private static function build_ugly_search_querylet($terms) {
 		global $config, $database;