rq 0.1.7 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (723) hide show
  1. data/INSTALL +21 -0
  2. data/README +752 -190
  3. data/TODO +18 -11
  4. data/TUTORIAL +230 -0
  5. data/all/install.rb +127 -0
  6. data/all/install.sh +165 -0
  7. data/all/packages/INSTALL +5 -0
  8. data/all/packages/arrayfields-3.6.0.tgz +0 -0
  9. data/all/packages/lockfile-1.4.1.tgz +0 -0
  10. data/all/packages/posixlock-0.0.1.tgz +0 -0
  11. data/all/packages/ruby-1.8.6.tgz +0 -0
  12. data/all/packages/rubygems-0.9.2.tgz +0 -0
  13. data/all/packages/sqlite-2.8.15.tar.gz +0 -0
  14. data/all/packages/sqlite-ruby-1.3.1.tar.gz +0 -0
  15. data/bin/rq +830 -361
  16. data/bin/rq-3.0.0 +860 -0
  17. data/doc/classes/ARGV.html +134 -0
  18. data/doc/classes/ARGV.src/M000036.html +36 -0
  19. data/doc/classes/ARGV.src/M000037.html +25 -0
  20. data/doc/classes/OrderedHash.html +1043 -0
  21. data/doc/classes/OrderedHash.src/M000003.html +26 -0
  22. data/doc/classes/OrderedHash.src/M000004.html +31 -0
  23. data/doc/classes/OrderedHash.src/M000005.html +23 -0
  24. data/doc/classes/OrderedHash.src/M000006.html +23 -0
  25. data/doc/classes/OrderedHash.src/M000007.html +24 -0
  26. data/doc/classes/OrderedHash.src/M000009.html +24 -0
  27. data/doc/classes/OrderedHash.src/M000010.html +24 -0
  28. data/doc/classes/OrderedHash.src/M000011.html +24 -0
  29. data/doc/classes/OrderedHash.src/M000012.html +24 -0
  30. data/doc/classes/OrderedHash.src/M000013.html +24 -0
  31. data/doc/classes/OrderedHash.src/M000014.html +24 -0
  32. data/doc/classes/OrderedHash.src/M000016.html +26 -0
  33. data/doc/classes/OrderedHash.src/M000017.html +25 -0
  34. data/doc/classes/OrderedHash.src/M000018.html +23 -0
  35. data/doc/classes/OrderedHash.src/M000019.html +25 -0
  36. data/doc/classes/OrderedHash.src/M000020.html +23 -0
  37. data/doc/classes/OrderedHash.src/M000021.html +24 -0
  38. data/doc/classes/OrderedHash.src/M000022.html +24 -0
  39. data/doc/classes/OrderedHash.src/M000023.html +24 -0
  40. data/doc/classes/OrderedHash.src/M000024.html +29 -0
  41. data/doc/classes/OrderedHash.src/M000025.html +29 -0
  42. data/doc/classes/OrderedHash.src/M000026.html +24 -0
  43. data/doc/classes/OrderedHash.src/M000027.html +25 -0
  44. data/doc/classes/OrderedHash.src/M000028.html +23 -0
  45. data/doc/classes/OrderedHash.src/M000029.html +25 -0
  46. data/doc/classes/OrderedHash.src/M000030.html +24 -0
  47. data/doc/classes/OrderedHash.src/M000032.html +23 -0
  48. data/doc/classes/OrderedHash.src/M000033.html +25 -0
  49. data/doc/classes/OrderedHash.src/M000034.html +36 -0
  50. data/doc/classes/OrderedHash.src/M000035.html +23 -0
  51. data/doc/classes/RQ.html +647 -0
  52. data/doc/classes/RQ/Backer.html +240 -0
  53. data/doc/classes/RQ/Backer.src/M000121.html +31 -0
  54. data/doc/classes/RQ/ConfigFile.html +416 -0
  55. data/doc/classes/RQ/ConfigFile.src/M000100.html +34 -0
  56. data/doc/classes/RQ/ConfigFile.src/M000101.html +26 -0
  57. data/doc/classes/RQ/ConfigFile.src/M000102.html +33 -0
  58. data/doc/classes/RQ/ConfigFile.src/M000103.html +25 -0
  59. data/doc/classes/RQ/ConfigFile.src/M000104.html +34 -0
  60. data/doc/classes/RQ/ConfigFile.src/M000105.html +25 -0
  61. data/doc/classes/RQ/Configurator.html +249 -0
  62. data/doc/classes/RQ/Configurator.src/M000122.html +40 -0
  63. data/doc/classes/RQ/Creator.html +264 -0
  64. data/doc/classes/RQ/Creator.src/M000157.html +32 -0
  65. data/doc/classes/RQ/Cron.html +461 -0
  66. data/doc/classes/RQ/Deleter.html +259 -0
  67. data/doc/classes/RQ/Deleter.src/M000078.html +52 -0
  68. data/doc/classes/RQ/Executor.html +249 -0
  69. data/doc/classes/RQ/Executor.src/M000099.html +45 -0
  70. data/doc/classes/RQ/Feeder.html +1131 -0
  71. data/doc/classes/RQ/Feeder.src/M000079.html +67 -0
  72. data/doc/classes/RQ/Feeder.src/M000080.html +47 -0
  73. data/doc/classes/RQ/Feeder.src/M000081.html +98 -0
  74. data/doc/classes/RQ/Feeder.src/M000082.html +25 -0
  75. data/doc/classes/RQ/Feeder.src/M000083.html +30 -0
  76. data/doc/classes/RQ/Feeder.src/M000084.html +58 -0
  77. data/doc/classes/RQ/Feeder.src/M000085.html +37 -0
  78. data/doc/classes/RQ/Feeder.src/M000086.html +40 -0
  79. data/doc/classes/RQ/Feeder.src/M000087.html +37 -0
  80. data/doc/classes/RQ/Feeder.src/M000088.html +35 -0
  81. data/doc/classes/RQ/Feeder.src/M000089.html +47 -0
  82. data/doc/classes/RQ/Feeder.src/M000090.html +25 -0
  83. data/doc/classes/RQ/Feeder.src/M000091.html +78 -0
  84. data/doc/classes/RQ/Feeder.src/M000092.html +34 -0
  85. data/doc/classes/RQ/Feeder.src/M000093.html +36 -0
  86. data/doc/classes/RQ/Feeder.src/M000094.html +25 -0
  87. data/doc/classes/RQ/Feeder.src/M000095.html +27 -0
  88. data/doc/classes/RQ/IOViewer.html +256 -0
  89. data/doc/classes/RQ/Job.html +304 -0
  90. data/doc/classes/RQ/Job.src/M000168.html +26 -0
  91. data/doc/classes/RQ/Job.src/M000169.html +37 -0
  92. data/doc/classes/RQ/Job.src/M000170.html +23 -0
  93. data/doc/classes/RQ/Job/Methods.html +210 -0
  94. data/doc/classes/RQ/JobQueue.html +1780 -0
  95. data/doc/classes/RQ/JobQueue.src/M000176.html +31 -0
  96. data/doc/classes/RQ/JobQueue.src/M000177.html +34 -0
  97. data/doc/classes/RQ/JobQueue.src/M000178.html +60 -0
  98. data/doc/classes/RQ/JobQueue.src/M000179.html +63 -0
  99. data/doc/classes/RQ/JobQueue.src/M000180.html +73 -0
  100. data/doc/classes/RQ/JobQueue.src/M000181.html +217 -0
  101. data/doc/classes/RQ/JobQueue.src/M000182.html +50 -0
  102. data/doc/classes/RQ/JobQueue.src/M000183.html +83 -0
  103. data/doc/classes/RQ/JobQueue.src/M000184.html +25 -0
  104. data/doc/classes/RQ/JobQueue.src/M000185.html +83 -0
  105. data/doc/classes/RQ/JobQueue.src/M000186.html +28 -0
  106. data/doc/classes/RQ/JobQueue.src/M000187.html +26 -0
  107. data/doc/classes/RQ/JobQueue.src/M000188.html +26 -0
  108. data/doc/classes/RQ/JobQueue.src/M000189.html +32 -0
  109. data/doc/classes/RQ/JobQueue.src/M000190.html +30 -0
  110. data/doc/classes/RQ/JobQueue.src/M000191.html +37 -0
  111. data/doc/classes/RQ/JobQueue.src/M000192.html +36 -0
  112. data/doc/classes/RQ/JobQueue.src/M000193.html +25 -0
  113. data/doc/classes/RQ/JobQueue.src/M000194.html +25 -0
  114. data/doc/classes/RQ/JobQueue.src/M000195.html +25 -0
  115. data/doc/classes/RQ/JobQueue.src/M000196.html +25 -0
  116. data/doc/classes/RQ/JobQueue.src/M000197.html +25 -0
  117. data/doc/classes/RQ/JobQueue.src/M000198.html +73 -0
  118. data/doc/classes/RQ/JobQueue.src/M000199.html +25 -0
  119. data/doc/classes/RQ/JobQueue.src/M000200.html +38 -0
  120. data/doc/classes/RQ/JobQueue.src/M000201.html +28 -0
  121. data/doc/classes/RQ/JobQueue/Error.html +187 -0
  122. data/doc/classes/RQ/JobRunner.html +386 -0
  123. data/doc/classes/RQ/JobRunner.src/M000117.html +53 -0
  124. data/doc/classes/RQ/JobRunner.src/M000118.html +26 -0
  125. data/doc/classes/RQ/JobRunnerDaemon.html +590 -0
  126. data/doc/classes/RQ/JobRunnerDaemon.src/M000159.html +94 -0
  127. data/doc/classes/RQ/JobRunnerDaemon.src/M000160.html +27 -0
  128. data/doc/classes/RQ/JobRunnerDaemon.src/M000161.html +39 -0
  129. data/doc/classes/RQ/JobRunnerDaemon.src/M000162.html +27 -0
  130. data/doc/classes/RQ/JobRunnerDaemon.src/M000163.html +27 -0
  131. data/doc/classes/RQ/JobRunnerDaemon.src/M000164.html +28 -0
  132. data/doc/classes/RQ/JobRunnerDaemon.src/M000165.html +28 -0
  133. data/doc/classes/RQ/JobRunnerDaemon.src/M000166.html +37 -0
  134. data/doc/classes/RQ/JobRunnerDaemon.src/M000167.html +25 -0
  135. data/doc/classes/RQ/Lister.html +256 -0
  136. data/doc/classes/RQ/Lister.src/M000156.html +52 -0
  137. data/doc/classes/RQ/Locker.html +250 -0
  138. data/doc/classes/RQ/Locker.src/M000120.html +40 -0
  139. data/doc/classes/RQ/Logging.html +296 -0
  140. data/doc/classes/RQ/Logging.src/M000067.html +28 -0
  141. data/doc/classes/RQ/Logging/LogClassMethods.html +254 -0
  142. data/doc/classes/RQ/Logging/LogClassMethods.src/M000068.html +32 -0
  143. data/doc/classes/RQ/Logging/LogClassMethods.src/M000069.html +28 -0
  144. data/doc/classes/RQ/Logging/LogMethods.html +404 -0
  145. data/doc/classes/RQ/Logging/LogMethods.src/M000070.html +35 -0
  146. data/doc/classes/RQ/Logging/LogMethods.src/M000071.html +28 -0
  147. data/doc/classes/RQ/Logging/LogMethods.src/M000072.html +21 -0
  148. data/doc/classes/RQ/Logging/LogMethods.src/M000073.html +21 -0
  149. data/doc/classes/RQ/Logging/LogMethods.src/M000074.html +21 -0
  150. data/doc/classes/RQ/Logging/LogMethods.src/M000075.html +21 -0
  151. data/doc/classes/RQ/Logging/LogMethods.src/M000076.html +21 -0
  152. data/doc/classes/RQ/Logging/LogMethods.src/M000077.html +29 -0
  153. data/doc/classes/RQ/Logging/LoggerExt.html +194 -0
  154. data/doc/classes/RQ/Main.html +2110 -0
  155. data/doc/classes/RQ/MainHelper.html +607 -0
  156. data/doc/classes/RQ/MainHelper.src/M000171.html +33 -0
  157. data/doc/classes/RQ/MainHelper.src/M000172.html +32 -0
  158. data/doc/classes/RQ/MainHelper.src/M000173.html +44 -0
  159. data/doc/classes/RQ/OrderedAutoHash.html +258 -0
  160. data/doc/classes/RQ/OrderedAutoHash.src/M000205.html +25 -0
  161. data/doc/classes/RQ/OrderedAutoHash.src/M000206.html +25 -0
  162. data/doc/classes/RQ/QDB.html +1653 -0
  163. data/doc/classes/RQ/QDB.src/M000126.html +25 -0
  164. data/doc/classes/RQ/QDB.src/M000127.html +37 -0
  165. data/doc/classes/RQ/QDB.src/M000128.html +27 -0
  166. data/doc/classes/RQ/QDB.src/M000129.html +27 -0
  167. data/doc/classes/RQ/QDB.src/M000130.html +27 -0
  168. data/doc/classes/RQ/QDB.src/M000131.html +31 -0
  169. data/doc/classes/RQ/QDB.src/M000132.html +32 -0
  170. data/doc/classes/RQ/QDB.src/M000133.html +30 -0
  171. data/doc/classes/RQ/QDB.src/M000134.html +91 -0
  172. data/doc/classes/RQ/QDB.src/M000135.html +26 -0
  173. data/doc/classes/RQ/QDB.src/M000136.html +46 -0
  174. data/doc/classes/RQ/QDB.src/M000137.html +26 -0
  175. data/doc/classes/RQ/QDB.src/M000138.html +51 -0
  176. data/doc/classes/RQ/QDB.src/M000139.html +61 -0
  177. data/doc/classes/RQ/QDB.src/M000140.html +57 -0
  178. data/doc/classes/RQ/QDB.src/M000141.html +25 -0
  179. data/doc/classes/RQ/QDB.src/M000142.html +25 -0
  180. data/doc/classes/RQ/QDB.src/M000143.html +37 -0
  181. data/doc/classes/RQ/QDB.src/M000144.html +107 -0
  182. data/doc/classes/RQ/QDB.src/M000145.html +40 -0
  183. data/doc/classes/RQ/QDB.src/M000146.html +34 -0
  184. data/doc/classes/RQ/QDB.src/M000147.html +33 -0
  185. data/doc/classes/RQ/QDB.src/M000148.html +32 -0
  186. data/doc/classes/RQ/QDB.src/M000149.html +98 -0
  187. data/doc/classes/RQ/QDB.src/M000150.html +26 -0
  188. data/doc/classes/RQ/QDB.src/M000151.html +31 -0
  189. data/doc/classes/RQ/QDB.src/M000154.html +26 -0
  190. data/doc/classes/RQ/QDB/AbortedTransactionError.html +187 -0
  191. data/doc/classes/RQ/QDB/RollbackTransactionError.html +187 -0
  192. data/doc/classes/RQ/Querier.html +328 -0
  193. data/doc/classes/RQ/Querier.src/M000203.html +45 -0
  194. data/doc/classes/RQ/Querier.src/M000204.html +78 -0
  195. data/doc/classes/RQ/ReSubmitter.html +307 -0
  196. data/doc/classes/RQ/ReSubmitter.src/M000098.html +111 -0
  197. data/doc/classes/RQ/Recoverer.html +247 -0
  198. data/doc/classes/RQ/Refresher.html +346 -0
  199. data/doc/classes/RQ/Refresher.src/M000174.html +51 -0
  200. data/doc/classes/RQ/Refresher.src/M000175.html +44 -0
  201. data/doc/classes/RQ/Relayer.html +723 -0
  202. data/doc/classes/RQ/Relayer.src/M000106.html +91 -0
  203. data/doc/classes/RQ/Relayer.src/M000107.html +47 -0
  204. data/doc/classes/RQ/Relayer.src/M000108.html +46 -0
  205. data/doc/classes/RQ/Relayer.src/M000109.html +26 -0
  206. data/doc/classes/RQ/Relayer.src/M000110.html +46 -0
  207. data/doc/classes/RQ/Relayer.src/M000111.html +40 -0
  208. data/doc/classes/RQ/Relayer.src/M000112.html +37 -0
  209. data/doc/classes/RQ/Relayer.src/M000113.html +40 -0
  210. data/doc/classes/RQ/Relayer.src/M000114.html +27 -0
  211. data/doc/classes/RQ/Relayer.src/M000115.html +25 -0
  212. data/doc/classes/RQ/Relayer.src/M000116.html +38 -0
  213. data/doc/classes/RQ/Resource.html +187 -0
  214. data/doc/classes/RQ/ResourceManager.html +276 -0
  215. data/doc/classes/RQ/Rotater.html +324 -0
  216. data/doc/classes/RQ/Rotater.src/M000158.html +71 -0
  217. data/doc/classes/RQ/SleepCycle.html +322 -0
  218. data/doc/classes/RQ/SleepCycle.src/M000123.html +32 -0
  219. data/doc/classes/RQ/SleepCycle.src/M000124.html +27 -0
  220. data/doc/classes/RQ/SleepCycle.src/M000125.html +25 -0
  221. data/doc/classes/RQ/Snapshotter.html +250 -0
  222. data/doc/classes/RQ/Snapshotter.src/M000097.html +35 -0
  223. data/doc/classes/RQ/StatusLister.html +289 -0
  224. data/doc/classes/RQ/StatusLister.src/M000096.html +26 -0
  225. data/doc/classes/RQ/Submitter.html +319 -0
  226. data/doc/classes/RQ/Submitter.src/M000119.html +92 -0
  227. data/doc/classes/RQ/Toucher.html +384 -0
  228. data/doc/classes/RQ/Updater.html +304 -0
  229. data/doc/classes/RQ/Updater.src/M000202.html +97 -0
  230. data/doc/classes/RQ/Usage.html +346 -0
  231. data/doc/classes/RQ/Usage.src/M000038.html +29 -0
  232. data/doc/classes/RQ/Usage.src/M000039.html +72 -0
  233. data/doc/classes/RQ/Util.html +1043 -0
  234. data/doc/classes/RQ/Util.src/M000040.html +27 -0
  235. data/doc/classes/RQ/Util.src/M000041.html +26 -0
  236. data/doc/classes/RQ/Util.src/M000042.html +25 -0
  237. data/doc/classes/RQ/Util.src/M000043.html +25 -0
  238. data/doc/classes/RQ/Util.src/M000044.html +30 -0
  239. data/doc/classes/RQ/Util.src/M000045.html +25 -0
  240. data/doc/classes/RQ/Util.src/M000046.html +34 -0
  241. data/doc/classes/RQ/Util.src/M000047.html +31 -0
  242. data/doc/classes/RQ/Util.src/M000048.html +41 -0
  243. data/doc/classes/RQ/Util.src/M000049.html +27 -0
  244. data/doc/classes/RQ/Util.src/M000050.html +34 -0
  245. data/doc/classes/RQ/Util.src/M000051.html +28 -0
  246. data/doc/classes/RQ/Util.src/M000052.html +27 -0
  247. data/doc/classes/RQ/Util.src/M000053.html +31 -0
  248. data/doc/classes/RQ/Util.src/M000054.html +31 -0
  249. data/doc/classes/RQ/Util.src/M000055.html +31 -0
  250. data/doc/classes/RQ/Util.src/M000056.html +25 -0
  251. data/doc/classes/RQ/Util.src/M000057.html +25 -0
  252. data/doc/classes/RQ/Util.src/M000058.html +25 -0
  253. data/doc/classes/RQ/Util.src/M000059.html +25 -0
  254. data/doc/classes/RQ/Util.src/M000060.html +25 -0
  255. data/doc/classes/RQ/Util.src/M000061.html +27 -0
  256. data/doc/classes/RQ/Util.src/M000062.html +28 -0
  257. data/doc/classes/RQ/Util.src/M000063.html +39 -0
  258. data/doc/classes/RQ/Util.src/M000064.html +39 -0
  259. data/doc/classes/RQ/Util.src/M000065.html +31 -0
  260. data/doc/classes/RQ/Util.src/M000066.html +29 -0
  261. data/doc/classes/SQLite.html +120 -0
  262. data/doc/classes/SQLite/Database.html +546 -0
  263. data/doc/classes/SQLite/TypeTranslator.html +221 -0
  264. data/doc/created.rid +1 -0
  265. data/doc/dot/f_0.dot +14 -0
  266. data/doc/dot/f_0.jpg +0 -0
  267. data/doc/dot/f_1.dot +14 -0
  268. data/doc/dot/f_1.jpg +0 -0
  269. data/doc/dot/f_10.dot +802 -0
  270. data/doc/dot/f_10.jpg +0 -0
  271. data/doc/dot/f_11.dot +14 -0
  272. data/doc/dot/f_11.jpg +0 -0
  273. data/doc/dot/f_12.dot +802 -0
  274. data/doc/dot/f_12.jpg +0 -0
  275. data/doc/dot/f_13.dot +802 -0
  276. data/doc/dot/f_13.jpg +0 -0
  277. data/doc/dot/f_14.dot +802 -0
  278. data/doc/dot/f_14.jpg +0 -0
  279. data/doc/dot/f_15.dot +802 -0
  280. data/doc/dot/f_15.jpg +0 -0
  281. data/doc/dot/f_16.dot +802 -0
  282. data/doc/dot/f_16.jpg +0 -0
  283. data/doc/dot/f_17.dot +802 -0
  284. data/doc/dot/f_17.jpg +0 -0
  285. data/doc/dot/f_18.dot +14 -0
  286. data/doc/dot/f_18.jpg +0 -0
  287. data/doc/dot/f_19.dot +802 -0
  288. data/doc/dot/f_19.jpg +0 -0
  289. data/doc/dot/f_2.dot +14 -0
  290. data/doc/dot/f_2.jpg +0 -0
  291. data/doc/dot/f_20.dot +802 -0
  292. data/doc/dot/f_20.jpg +0 -0
  293. data/doc/dot/f_21.dot +802 -0
  294. data/doc/dot/f_21.jpg +0 -0
  295. data/doc/dot/f_22.dot +802 -0
  296. data/doc/dot/f_22.jpg +0 -0
  297. data/doc/dot/f_23.dot +802 -0
  298. data/doc/dot/f_23.jpg +0 -0
  299. data/doc/dot/f_24.dot +802 -0
  300. data/doc/dot/f_24.jpg +0 -0
  301. data/doc/dot/f_25.dot +817 -0
  302. data/doc/dot/f_25.jpg +0 -0
  303. data/doc/dot/f_26.dot +29 -0
  304. data/doc/dot/f_26.jpg +0 -0
  305. data/doc/dot/f_27.dot +802 -0
  306. data/doc/dot/f_27.jpg +0 -0
  307. data/doc/dot/f_28.dot +802 -0
  308. data/doc/dot/f_28.jpg +0 -0
  309. data/doc/dot/f_29.dot +802 -0
  310. data/doc/dot/f_29.jpg +0 -0
  311. data/doc/dot/f_3.dot +14 -0
  312. data/doc/dot/f_3.jpg +0 -0
  313. data/doc/dot/f_30.dot +802 -0
  314. data/doc/dot/f_30.jpg +0 -0
  315. data/doc/dot/f_31.dot +802 -0
  316. data/doc/dot/f_31.jpg +0 -0
  317. data/doc/dot/f_32.dot +802 -0
  318. data/doc/dot/f_32.jpg +0 -0
  319. data/doc/dot/f_33.dot +802 -0
  320. data/doc/dot/f_33.jpg +0 -0
  321. data/doc/dot/f_34.dot +802 -0
  322. data/doc/dot/f_34.jpg +0 -0
  323. data/doc/dot/f_35.dot +802 -0
  324. data/doc/dot/f_35.jpg +0 -0
  325. data/doc/dot/f_36.dot +802 -0
  326. data/doc/dot/f_36.jpg +0 -0
  327. data/doc/dot/f_37.dot +802 -0
  328. data/doc/dot/f_37.jpg +0 -0
  329. data/doc/dot/f_38.dot +54 -0
  330. data/doc/dot/f_38.jpg +0 -0
  331. data/doc/dot/f_39.dot +802 -0
  332. data/doc/dot/f_39.jpg +0 -0
  333. data/doc/dot/f_4.dot +802 -0
  334. data/doc/dot/f_4.jpg +0 -0
  335. data/doc/dot/f_40.dot +802 -0
  336. data/doc/dot/f_40.jpg +0 -0
  337. data/doc/dot/f_41.dot +802 -0
  338. data/doc/dot/f_41.jpg +0 -0
  339. data/doc/dot/f_42.dot +802 -0
  340. data/doc/dot/f_42.jpg +0 -0
  341. data/doc/dot/f_43.dot +802 -0
  342. data/doc/dot/f_43.jpg +0 -0
  343. data/doc/dot/f_44.dot +802 -0
  344. data/doc/dot/f_44.jpg +0 -0
  345. data/doc/dot/f_5.dot +802 -0
  346. data/doc/dot/f_5.jpg +0 -0
  347. data/doc/dot/f_6.dot +802 -0
  348. data/doc/dot/f_6.jpg +0 -0
  349. data/doc/dot/f_7.dot +802 -0
  350. data/doc/dot/f_7.jpg +0 -0
  351. data/doc/dot/f_8.dot +802 -0
  352. data/doc/dot/f_8.jpg +0 -0
  353. data/doc/dot/f_9.dot +802 -0
  354. data/doc/dot/f_9.jpg +0 -0
  355. data/doc/dot/m_10_0.dot +802 -0
  356. data/doc/dot/m_10_0.jpg +0 -0
  357. data/doc/dot/m_11_0.dot +734 -0
  358. data/doc/dot/m_11_0.jpg +0 -0
  359. data/doc/dot/m_12_0.dot +802 -0
  360. data/doc/dot/m_12_0.jpg +0 -0
  361. data/doc/dot/m_13_0.dot +802 -0
  362. data/doc/dot/m_13_0.jpg +0 -0
  363. data/doc/dot/m_14_0.dot +802 -0
  364. data/doc/dot/m_14_0.jpg +0 -0
  365. data/doc/dot/m_15_0.dot +802 -0
  366. data/doc/dot/m_15_0.jpg +0 -0
  367. data/doc/dot/m_16_0.dot +802 -0
  368. data/doc/dot/m_16_0.jpg +0 -0
  369. data/doc/dot/m_17_0.dot +802 -0
  370. data/doc/dot/m_17_0.jpg +0 -0
  371. data/doc/dot/m_18_0.dot +734 -0
  372. data/doc/dot/m_18_0.jpg +0 -0
  373. data/doc/dot/m_19_0.dot +802 -0
  374. data/doc/dot/m_19_0.jpg +0 -0
  375. data/doc/dot/m_20_0.dot +802 -0
  376. data/doc/dot/m_20_0.jpg +0 -0
  377. data/doc/dot/m_21_0.dot +802 -0
  378. data/doc/dot/m_21_0.jpg +0 -0
  379. data/doc/dot/m_22_0.dot +802 -0
  380. data/doc/dot/m_22_0.jpg +0 -0
  381. data/doc/dot/m_23_0.dot +802 -0
  382. data/doc/dot/m_23_0.jpg +0 -0
  383. data/doc/dot/m_24_0.dot +802 -0
  384. data/doc/dot/m_24_0.jpg +0 -0
  385. data/doc/dot/m_25_0.dot +802 -0
  386. data/doc/dot/m_25_0.jpg +0 -0
  387. data/doc/dot/m_26_0.dot +734 -0
  388. data/doc/dot/m_26_0.jpg +0 -0
  389. data/doc/dot/m_27_0.dot +802 -0
  390. data/doc/dot/m_27_0.jpg +0 -0
  391. data/doc/dot/m_28_0.dot +802 -0
  392. data/doc/dot/m_28_0.jpg +0 -0
  393. data/doc/dot/m_29_0.dot +802 -0
  394. data/doc/dot/m_29_0.jpg +0 -0
  395. data/doc/dot/m_30_0.dot +802 -0
  396. data/doc/dot/m_30_0.jpg +0 -0
  397. data/doc/dot/m_31_0.dot +802 -0
  398. data/doc/dot/m_31_0.jpg +0 -0
  399. data/doc/dot/m_32_0.dot +802 -0
  400. data/doc/dot/m_32_0.jpg +0 -0
  401. data/doc/dot/m_33_0.dot +802 -0
  402. data/doc/dot/m_33_0.jpg +0 -0
  403. data/doc/dot/m_34_0.dot +802 -0
  404. data/doc/dot/m_34_0.jpg +0 -0
  405. data/doc/dot/m_35_0.dot +802 -0
  406. data/doc/dot/m_35_0.jpg +0 -0
  407. data/doc/dot/m_36_0.dot +802 -0
  408. data/doc/dot/m_36_0.jpg +0 -0
  409. data/doc/dot/m_37_0.dot +802 -0
  410. data/doc/dot/m_37_0.jpg +0 -0
  411. data/doc/dot/m_38_0.dot +54 -0
  412. data/doc/dot/m_38_0.jpg +0 -0
  413. data/doc/dot/m_39_0.dot +802 -0
  414. data/doc/dot/m_39_0.jpg +0 -0
  415. data/doc/dot/m_40_0.dot +802 -0
  416. data/doc/dot/m_40_0.jpg +0 -0
  417. data/doc/dot/m_41_0.dot +802 -0
  418. data/doc/dot/m_41_0.jpg +0 -0
  419. data/doc/dot/m_42_0.dot +802 -0
  420. data/doc/dot/m_42_0.jpg +0 -0
  421. data/doc/dot/m_43_0.dot +802 -0
  422. data/doc/dot/m_43_0.jpg +0 -0
  423. data/doc/dot/m_44_0.dot +802 -0
  424. data/doc/dot/m_44_0.jpg +0 -0
  425. data/doc/dot/m_4_0.dot +802 -0
  426. data/doc/dot/m_4_0.jpg +0 -0
  427. data/doc/dot/m_5_0.dot +802 -0
  428. data/doc/dot/m_5_0.jpg +0 -0
  429. data/doc/dot/m_6_0.dot +802 -0
  430. data/doc/dot/m_6_0.jpg +0 -0
  431. data/doc/dot/m_7_0.dot +802 -0
  432. data/doc/dot/m_7_0.jpg +0 -0
  433. data/doc/dot/m_8_0.dot +802 -0
  434. data/doc/dot/m_8_0.jpg +0 -0
  435. data/doc/dot/m_9_0.dot +802 -0
  436. data/doc/dot/m_9_0.jpg +0 -0
  437. data/doc/files/DEPENDS.html +107 -0
  438. data/doc/files/HISTORY.html +316 -0
  439. data/doc/files/INSTALL.html +126 -0
  440. data/doc/files/README.html +1223 -0
  441. data/doc/files/TODO.html +148 -0
  442. data/doc/files/TUTORIAL.html +392 -0
  443. data/doc/files/VERSION.html +107 -0
  444. data/doc/files/bin/rq_rb.html +231 -0
  445. data/doc/files/install_rb.html +188 -0
  446. data/doc/files/install_rb.src/M000001.html +53 -0
  447. data/doc/files/install_rb.src/M000002.html +43 -0
  448. data/doc/files/lib/rq-1_0_0/backer_rb.html +174 -0
  449. data/doc/files/lib/rq-1_0_0/configfile_rb.html +174 -0
  450. data/doc/files/lib/rq-1_0_0/configurator_rb.html +174 -0
  451. data/doc/files/lib/rq-1_0_0/creator_rb.html +174 -0
  452. data/doc/files/lib/rq-1_0_0/defaultconfig_txt.html +110 -0
  453. data/doc/files/lib/rq-1_0_0/deleter_rb.html +174 -0
  454. data/doc/files/lib/rq-1_0_0/executor_rb.html +174 -0
  455. data/doc/files/lib/rq-1_0_0/feeder_rb.html +178 -0
  456. data/doc/files/lib/rq-1_0_0/job_rb.html +176 -0
  457. data/doc/files/lib/rq-1_0_0/jobqueue_rb.html +177 -0
  458. data/doc/files/lib/rq-1_0_0/jobrunner_rb.html +175 -0
  459. data/doc/files/lib/rq-1_0_0/jobrunnerdaemon_rb.html +179 -0
  460. data/doc/files/lib/rq-1_0_0/lister_rb.html +174 -0
  461. data/doc/files/lib/rq-1_0_0/locker_rb.html +175 -0
  462. data/doc/files/lib/rq-1_0_0/logging_rb.html +178 -0
  463. data/doc/files/lib/rq-1_0_0/mainhelper_rb.html +175 -0
  464. data/doc/files/lib/rq-1_0_0/qdb_rb.html +177 -0
  465. data/doc/files/lib/rq-1_0_0/querier_rb.html +174 -0
  466. data/doc/files/lib/rq-1_0_0/refresher_rb.html +167 -0
  467. data/doc/files/lib/rq-1_0_0/relayer_rb.html +178 -0
  468. data/doc/files/lib/rq-1_0_0/sleepcycle_rb.html +167 -0
  469. data/doc/files/lib/rq-1_0_0/snapshotter_rb.html +174 -0
  470. data/doc/files/lib/rq-1_0_0/statuslister_rb.html +174 -0
  471. data/doc/files/lib/rq-1_0_0/submitter_rb.html +174 -0
  472. data/doc/files/lib/rq-1_0_0/updater_rb.html +174 -0
  473. data/doc/files/lib/rq-1_0_0/usage_rb.html +174 -0
  474. data/doc/files/lib/rq-1_0_0/util_rb.html +176 -0
  475. data/doc/files/lib/rq-2_0_0/backer_rb.html +180 -0
  476. data/doc/files/lib/rq-2_0_0/configfile_rb.html +180 -0
  477. data/doc/files/lib/rq-2_0_0/configurator_rb.html +180 -0
  478. data/doc/files/lib/rq-2_0_0/creator_rb.html +180 -0
  479. data/doc/files/lib/rq-2_0_0/defaultconfig_txt.html +110 -0
  480. data/doc/files/lib/rq-2_0_0/deleter_rb.html +180 -0
  481. data/doc/files/lib/rq-2_0_0/executor_rb.html +180 -0
  482. data/doc/files/lib/rq-2_0_0/feeder_rb.html +184 -0
  483. data/doc/files/lib/rq-2_0_0/job_rb.html +182 -0
  484. data/doc/files/lib/rq-2_0_0/jobqueue_rb.html +185 -0
  485. data/doc/files/lib/rq-2_0_0/jobrunner_rb.html +181 -0
  486. data/doc/files/lib/rq-2_0_0/jobrunnerdaemon_rb.html +185 -0
  487. data/doc/files/lib/rq-2_0_0/lister_rb.html +180 -0
  488. data/doc/files/lib/rq-2_0_0/locker_rb.html +181 -0
  489. data/doc/files/lib/rq-2_0_0/logging_rb.html +184 -0
  490. data/doc/files/lib/rq-2_0_0/mainhelper_rb.html +181 -0
  491. data/doc/files/lib/rq-2_0_0/orderedautohash_rb.html +182 -0
  492. data/doc/files/lib/rq-2_0_0/orderedhash_rb.html +138 -0
  493. data/doc/files/lib/rq-2_0_0/qdb_rb.html +184 -0
  494. data/doc/files/lib/rq-2_0_0/querier_rb.html +180 -0
  495. data/doc/files/lib/rq-2_0_0/refresher_rb.html +173 -0
  496. data/doc/files/lib/rq-2_0_0/relayer_rb.html +184 -0
  497. data/doc/files/lib/rq-2_0_0/rotater_rb.html +180 -0
  498. data/doc/files/lib/rq-2_0_0/sleepcycle_rb.html +173 -0
  499. data/doc/files/lib/rq-2_0_0/snapshotter_rb.html +180 -0
  500. data/doc/files/lib/rq-2_0_0/statuslister_rb.html +180 -0
  501. data/doc/files/lib/rq-2_0_0/submitter_rb.html +181 -0
  502. data/doc/files/lib/rq-2_0_0/updater_rb.html +180 -0
  503. data/doc/files/lib/rq-2_0_0/usage_rb.html +180 -0
  504. data/doc/files/lib/rq-2_0_0/util_rb.html +182 -0
  505. data/doc/files/lib/rq-2_3_1/backer_rb.html +182 -0
  506. data/doc/files/lib/rq-2_3_1/configfile_rb.html +182 -0
  507. data/doc/files/lib/rq-2_3_1/configurator_rb.html +182 -0
  508. data/doc/files/lib/rq-2_3_1/creator_rb.html +182 -0
  509. data/doc/files/lib/rq-2_3_1/defaultconfig_txt.html +110 -0
  510. data/doc/files/lib/rq-2_3_1/deleter_rb.html +182 -0
  511. data/doc/files/lib/rq-2_3_1/executor_rb.html +182 -0
  512. data/doc/files/lib/rq-2_3_1/feeder_rb.html +187 -0
  513. data/doc/files/lib/rq-2_3_1/job_rb.html +185 -0
  514. data/doc/files/lib/rq-2_3_1/jobqueue_rb.html +187 -0
  515. data/doc/files/lib/rq-2_3_1/jobrunner_rb.html +184 -0
  516. data/doc/files/lib/rq-2_3_1/jobrunnerdaemon_rb.html +187 -0
  517. data/doc/files/lib/rq-2_3_1/lister_rb.html +182 -0
  518. data/doc/files/lib/rq-2_3_1/locker_rb.html +183 -0
  519. data/doc/files/lib/rq-2_3_1/logging_rb.html +186 -0
  520. data/doc/files/lib/rq-2_3_1/mainhelper_rb.html +183 -0
  521. data/doc/files/lib/rq-2_3_1/orderedautohash_rb.html +184 -0
  522. data/doc/files/lib/rq-2_3_1/orderedhash_rb.html +138 -0
  523. data/doc/files/lib/rq-2_3_1/qdb_rb.html +188 -0
  524. data/doc/files/lib/rq-2_3_1/querier_rb.html +182 -0
  525. data/doc/files/lib/rq-2_3_1/refresher_rb.html +175 -0
  526. data/doc/files/lib/rq-2_3_1/relayer_rb.html +186 -0
  527. data/doc/files/lib/rq-2_3_1/resubmitter_rb.html +183 -0
  528. data/doc/files/lib/rq-2_3_1/rotater_rb.html +182 -0
  529. data/doc/files/lib/rq-2_3_1/sleepcycle_rb.html +175 -0
  530. data/doc/files/lib/rq-2_3_1/snapshotter_rb.html +182 -0
  531. data/doc/files/lib/rq-2_3_1/statuslister_rb.html +182 -0
  532. data/doc/files/lib/rq-2_3_1/submitter_rb.html +183 -0
  533. data/doc/files/lib/rq-2_3_1/updater_rb.html +182 -0
  534. data/doc/files/lib/rq-2_3_1/usage_rb.html +182 -0
  535. data/doc/files/lib/rq-2_3_1/util_rb.html +184 -0
  536. data/doc/files/lib/rq-2_3_1_rb.html +153 -0
  537. data/doc/files/lib/rq-2_3_2/backer_rb.html +186 -0
  538. data/doc/files/lib/rq-2_3_2/configfile_rb.html +186 -0
  539. data/doc/files/lib/rq-2_3_2/configurator_rb.html +186 -0
  540. data/doc/files/lib/rq-2_3_2/creator_rb.html +186 -0
  541. data/doc/files/lib/rq-2_3_2/defaultconfig_txt.html +110 -0
  542. data/doc/files/lib/rq-2_3_2/deleter_rb.html +186 -0
  543. data/doc/files/lib/rq-2_3_2/executor_rb.html +186 -0
  544. data/doc/files/lib/rq-2_3_2/feeder_rb.html +191 -0
  545. data/doc/files/lib/rq-2_3_2/ioviewer_rb.html +186 -0
  546. data/doc/files/lib/rq-2_3_2/job_rb.html +189 -0
  547. data/doc/files/lib/rq-2_3_2/jobqueue_rb.html +192 -0
  548. data/doc/files/lib/rq-2_3_2/jobrunner_rb.html +188 -0
  549. data/doc/files/lib/rq-2_3_2/jobrunnerdaemon_rb.html +191 -0
  550. data/doc/files/lib/rq-2_3_2/lister_rb.html +186 -0
  551. data/doc/files/lib/rq-2_3_2/locker_rb.html +187 -0
  552. data/doc/files/lib/rq-2_3_2/logging_rb.html +190 -0
  553. data/doc/files/lib/rq-2_3_2/mainhelper_rb.html +188 -0
  554. data/doc/files/lib/rq-2_3_2/orderedautohash_rb.html +188 -0
  555. data/doc/files/lib/rq-2_3_2/orderedhash_rb.html +138 -0
  556. data/doc/files/lib/rq-2_3_2/qdb_rb.html +193 -0
  557. data/doc/files/lib/rq-2_3_2/querier_rb.html +186 -0
  558. data/doc/files/lib/rq-2_3_2/recoverer_rb.html +186 -0
  559. data/doc/files/lib/rq-2_3_2/refresher_rb.html +179 -0
  560. data/doc/files/lib/rq-2_3_2/relayer_rb.html +190 -0
  561. data/doc/files/lib/rq-2_3_2/resubmitter_rb.html +187 -0
  562. data/doc/files/lib/rq-2_3_2/rotater_rb.html +186 -0
  563. data/doc/files/lib/rq-2_3_2/sleepcycle_rb.html +179 -0
  564. data/doc/files/lib/rq-2_3_2/snapshotter_rb.html +186 -0
  565. data/doc/files/lib/rq-2_3_2/statuslister_rb.html +186 -0
  566. data/doc/files/lib/rq-2_3_2/submitter_rb.html +187 -0
  567. data/doc/files/lib/rq-2_3_2/updater_rb.html +186 -0
  568. data/doc/files/lib/rq-2_3_2/usage_rb.html +186 -0
  569. data/doc/files/lib/rq-2_3_2/util_rb.html +188 -0
  570. data/doc/files/lib/rq-2_3_3/backer_rb.html +186 -0
  571. data/doc/files/lib/rq-2_3_3/configfile_rb.html +186 -0
  572. data/doc/files/lib/rq-2_3_3/configurator_rb.html +186 -0
  573. data/doc/files/lib/rq-2_3_3/creator_rb.html +186 -0
  574. data/doc/files/lib/rq-2_3_3/defaultconfig_txt.html +110 -0
  575. data/doc/files/lib/rq-2_3_3/deleter_rb.html +186 -0
  576. data/doc/files/lib/rq-2_3_3/executor_rb.html +186 -0
  577. data/doc/files/lib/rq-2_3_3/feeder_rb.html +191 -0
  578. data/doc/files/lib/rq-2_3_3/ioviewer_rb.html +186 -0
  579. data/doc/files/lib/rq-2_3_3/job_rb.html +189 -0
  580. data/doc/files/lib/rq-2_3_3/jobqueue_rb.html +192 -0
  581. data/doc/files/lib/rq-2_3_3/jobrunner_rb.html +188 -0
  582. data/doc/files/lib/rq-2_3_3/jobrunnerdaemon_rb.html +191 -0
  583. data/doc/files/lib/rq-2_3_3/lister_rb.html +186 -0
  584. data/doc/files/lib/rq-2_3_3/locker_rb.html +187 -0
  585. data/doc/files/lib/rq-2_3_3/logging_rb.html +190 -0
  586. data/doc/files/lib/rq-2_3_3/mainhelper_rb.html +188 -0
  587. data/doc/files/lib/rq-2_3_3/orderedautohash_rb.html +188 -0
  588. data/doc/files/lib/rq-2_3_3/orderedhash_rb.html +138 -0
  589. data/doc/files/lib/rq-2_3_3/qdb_rb.html +193 -0
  590. data/doc/files/lib/rq-2_3_3/querier_rb.html +186 -0
  591. data/doc/files/lib/rq-2_3_3/recoverer_rb.html +186 -0
  592. data/doc/files/lib/rq-2_3_3/refresher_rb.html +179 -0
  593. data/doc/files/lib/rq-2_3_3/relayer_rb.html +190 -0
  594. data/doc/files/lib/rq-2_3_3/resubmitter_rb.html +187 -0
  595. data/doc/files/lib/rq-2_3_3/rotater_rb.html +187 -0
  596. data/doc/files/lib/rq-2_3_3/sleepcycle_rb.html +179 -0
  597. data/doc/files/lib/rq-2_3_3/snapshotter_rb.html +186 -0
  598. data/doc/files/lib/rq-2_3_3/statuslister_rb.html +186 -0
  599. data/doc/files/lib/rq-2_3_3/submitter_rb.html +187 -0
  600. data/doc/files/lib/rq-2_3_3/updater_rb.html +186 -0
  601. data/doc/files/lib/rq-2_3_3/usage_rb.html +186 -0
  602. data/doc/files/lib/rq-2_3_3/util_rb.html +188 -0
  603. data/doc/files/lib/rq-3_0_0/backer_rb.html +194 -0
  604. data/doc/files/lib/rq-3_0_0/configfile_rb.html +194 -0
  605. data/doc/files/lib/rq-3_0_0/configurator_rb.html +194 -0
  606. data/doc/files/lib/rq-3_0_0/creator_rb.html +194 -0
  607. data/doc/files/lib/rq-3_0_0/cron_rb.html +194 -0
  608. data/doc/files/lib/rq-3_0_0/defaultconfig_txt.html +110 -0
  609. data/doc/files/lib/rq-3_0_0/deleter_rb.html +194 -0
  610. data/doc/files/lib/rq-3_0_0/executor_rb.html +194 -0
  611. data/doc/files/lib/rq-3_0_0/feeder_rb.html +199 -0
  612. data/doc/files/lib/rq-3_0_0/ioviewer_rb.html +194 -0
  613. data/doc/files/lib/rq-3_0_0/job_rb.html +197 -0
  614. data/doc/files/lib/rq-3_0_0/jobqueue_rb.html +200 -0
  615. data/doc/files/lib/rq-3_0_0/jobrunner_rb.html +196 -0
  616. data/doc/files/lib/rq-3_0_0/jobrunnerdaemon_rb.html +199 -0
  617. data/doc/files/lib/rq-3_0_0/lister_rb.html +194 -0
  618. data/doc/files/lib/rq-3_0_0/locker_rb.html +195 -0
  619. data/doc/files/lib/rq-3_0_0/logging_rb.html +198 -0
  620. data/doc/files/lib/rq-3_0_0/mainhelper_rb.html +196 -0
  621. data/doc/files/lib/rq-3_0_0/orderedautohash_rb.html +196 -0
  622. data/doc/files/lib/rq-3_0_0/orderedhash_rb.html +138 -0
  623. data/doc/files/lib/rq-3_0_0/qdb_rb.html +201 -0
  624. data/doc/files/lib/rq-3_0_0/querier_rb.html +194 -0
  625. data/doc/files/lib/rq-3_0_0/recoverer_rb.html +194 -0
  626. data/doc/files/lib/rq-3_0_0/refresher_rb.html +187 -0
  627. data/doc/files/lib/rq-3_0_0/relayer_rb.html +198 -0
  628. data/doc/files/lib/rq-3_0_0/resource_rb.html +194 -0
  629. data/doc/files/lib/rq-3_0_0/resourcemanager_rb.html +187 -0
  630. data/doc/files/lib/rq-3_0_0/resubmitter_rb.html +195 -0
  631. data/doc/files/lib/rq-3_0_0/rotater_rb.html +195 -0
  632. data/doc/files/lib/rq-3_0_0/sleepcycle_rb.html +187 -0
  633. data/doc/files/lib/rq-3_0_0/snapshotter_rb.html +194 -0
  634. data/doc/files/lib/rq-3_0_0/sqlite_rb.html +160 -0
  635. data/doc/files/lib/rq-3_0_0/statuslister_rb.html +194 -0
  636. data/doc/files/lib/rq-3_0_0/submitter_rb.html +195 -0
  637. data/doc/files/lib/rq-3_0_0/toucher_rb.html +195 -0
  638. data/doc/files/lib/rq-3_0_0/updater_rb.html +194 -0
  639. data/doc/files/lib/rq-3_0_0/usage_rb.html +194 -0
  640. data/doc/files/lib/rq-3_0_0/util_rb.html +196 -0
  641. data/doc/files/lib/rq_rb.html +244 -0
  642. data/doc/fr_class_index.html +73 -0
  643. data/doc/fr_file_index.html +71 -0
  644. data/doc/fr_method_index.html +323 -0
  645. data/doc/index.html +24 -0
  646. data/doc/rdoc-style.css +172 -0
  647. data/extconf.rb +150 -0
  648. data/gemspec.rb +32 -0
  649. data/install.rb +75 -8
  650. data/lib/{rq-0.1.7.rb → rq-3.0.0.rb} +52 -10
  651. data/lib/{rq-0.1.7 → rq-3.0.0}/backer.rb +11 -7
  652. data/lib/{rq-0.1.7 → rq-3.0.0}/configfile.rb +21 -17
  653. data/lib/{rq-0.1.7 → rq-3.0.0}/configurator.rb +10 -6
  654. data/lib/rq-3.0.0/creator.rb +46 -0
  655. data/lib/rq-3.0.0/cron.rb +125 -0
  656. data/lib/{rq-0.1.7 → rq-3.0.0}/defaultconfig.txt +0 -0
  657. data/lib/rq-3.0.0/deleter.rb +51 -0
  658. data/lib/rq-3.0.0/executor.rb +40 -0
  659. data/lib/{rq-0.1.7 → rq-3.0.0}/feeder.rb +245 -91
  660. data/lib/rq-3.0.0/i686-linux/_sqlite.so +0 -0
  661. data/lib/rq-3.0.0/ioviewer.rb +48 -0
  662. data/lib/rq-3.0.0/job.rb +51 -0
  663. data/lib/rq-3.0.0/jobqueue.rb +899 -0
  664. data/lib/rq-3.0.0/jobrunner.rb +104 -0
  665. data/lib/{rq-0.1.7 → rq-3.0.0}/jobrunnerdaemon.rb +41 -27
  666. data/lib/rq-3.0.0/lister.rb +47 -0
  667. data/lib/rq-3.0.0/local/bin/sqlite +0 -0
  668. data/lib/rq-3.0.0/local/include/sqlite.h +868 -0
  669. data/lib/rq-3.0.0/local/lib/libsqlite.a +0 -0
  670. data/lib/rq-3.0.0/local/lib/libsqlite.la +35 -0
  671. data/lib/rq-3.0.0/local/lib/libsqlite.so +0 -0
  672. data/lib/rq-3.0.0/local/lib/libsqlite.so.0 +0 -0
  673. data/lib/rq-3.0.0/local/lib/libsqlite.so.0.8.6 +0 -0
  674. data/lib/rq-3.0.0/local/lib/pkgconfig/sqlite.pc +12 -0
  675. data/lib/{rq-0.1.7 → rq-3.0.0}/locker.rb +12 -6
  676. data/lib/{rq-0.1.7 → rq-3.0.0}/logging.rb +49 -42
  677. data/lib/rq-3.0.0/mainhelper.rb +184 -0
  678. data/lib/rq-3.0.0/orderedautohash.rb +39 -0
  679. data/lib/rq-3.0.0/orderedhash.rb +240 -0
  680. data/lib/{rq-0.1.7 → rq-3.0.0}/qdb.rb +183 -84
  681. data/lib/rq-3.0.0/querier.rb +98 -0
  682. data/lib/rq-3.0.0/recoverer.rb +28 -0
  683. data/lib/{rq-0.1.7 → rq-3.0.0}/refresher.rb +16 -8
  684. data/lib/rq-3.0.0/relayer.rb +283 -0
  685. data/lib/rq-3.0.0/resource.rb +22 -0
  686. data/lib/rq-3.0.0/resourcemanager.rb +40 -0
  687. data/lib/rq-3.0.0/resubmitter.rb +96 -0
  688. data/lib/rq-3.0.0/rotater.rb +98 -0
  689. data/lib/{rq-0.1.7 → rq-3.0.0}/sleepcycle.rb +14 -14
  690. data/lib/rq-3.0.0/snapshotter.rb +40 -0
  691. data/lib/rq-3.0.0/sqlite.rb +293 -0
  692. data/lib/rq-3.0.0/statuslister.rb +48 -0
  693. data/lib/rq-3.0.0/submitter.rb +109 -0
  694. data/lib/rq-3.0.0/toucher.rb +177 -0
  695. data/lib/rq-3.0.0/updater.rb +95 -0
  696. data/lib/rq-3.0.0/usage.rb +1157 -0
  697. data/lib/{rq-0.1.7 → rq-3.0.0}/util.rb +74 -56
  698. data/lib/rq.rb +52 -12
  699. data/rdoc.sh +17 -0
  700. data/rq +3 -1
  701. data/white_box/joblist +8 -0
  702. metadata +779 -96
  703. data/DEPENDS +0 -5
  704. data/HISTORY +0 -26
  705. data/VERSION +0 -1
  706. data/bin/rq-0.1.7 +0 -410
  707. data/lib/rq-0.1.7/creator.rb +0 -23
  708. data/lib/rq-0.1.7/deleter.rb +0 -39
  709. data/lib/rq-0.1.7/executor.rb +0 -41
  710. data/lib/rq-0.1.7/job.rb +0 -51
  711. data/lib/rq-0.1.7/jobqueue.rb +0 -432
  712. data/lib/rq-0.1.7/jobrunner.rb +0 -63
  713. data/lib/rq-0.1.7/lister.rb +0 -22
  714. data/lib/rq-0.1.7/mainhelper.rb +0 -53
  715. data/lib/rq-0.1.7/querier.rb +0 -33
  716. data/lib/rq-0.1.7/snapshotter.rb +0 -25
  717. data/lib/rq-0.1.7/statuslister.rb +0 -22
  718. data/lib/rq-0.1.7/submitter.rb +0 -90
  719. data/lib/rq-0.1.7/updater.rb +0 -95
  720. data/lib/rq-0.1.7/usage.rb +0 -609
  721. data/rdoc.cmd +0 -2
  722. data/rq.gemspec +0 -36
  723. data/rq.help +0 -552
@@ -0,0 +1,104 @@
1
+ unless defined? $__rq_jobrunner__
2
+ module RQ
3
+ #--{{{
4
+ LIBDIR = File::dirname(File::expand_path(__FILE__)) + File::SEPARATOR unless
5
+ defined? LIBDIR
6
+
7
+ require 'drb/drb'
8
+ require 'yaml'
9
+
10
+ require LIBDIR + 'util'
11
+
12
+ #
13
+ # the JobRunner class is responsible for pre-forking a process/shell in
14
+ # which to run a job. this class is utilized by the JobRunnerDaemon so
15
+ # processes can be forked via a drb proxy to avoid actual forking during an
16
+ # sqlite transaction - which has undefined behaviour
17
+ #
18
+ class JobRunner
19
+ #--{{{
20
+ $VERBOSE = nil
21
+ include DRbUndumped
22
+ attr :q
23
+ attr :job
24
+ attr :jid
25
+ attr :cid
26
+ attr :shell
27
+ attr :command
28
+ attr :stdin
29
+ attr :stdout
30
+ attr :stderr
31
+ alias pid cid
32
+ def initialize q, job
33
+ #--{{{
34
+ @q = q
35
+ @job = job
36
+ @jid = job['jid']
37
+ @command = job['command']
38
+ @shell = job['shell'] || 'bash'
39
+ @sh_like = File::basename(@shell) == 'bash' || File::basename(@shell) == 'sh'
40
+ @r,@w = IO::pipe
41
+
42
+ @env = {}
43
+ @env["PATH"] = [@q.bin, ENV["PATH"]].join(":")
44
+ @job.fields.each do |field|
45
+ key = "RQ_#{ field }".upcase.gsub(%r/\s+/,'_')
46
+ val = @job[field]
47
+ @env[key] = "#{ val }"
48
+ end
49
+ @env['RQ_JOB'] = @job.to_hash.to_yaml
50
+
51
+ @stdin = @job['stdin']
52
+ @stdout = @job['stdout']
53
+ @stderr = @job['stderr']
54
+
55
+ @stdin &&= File::join @q.path, @stdin # assume path relative to queue
56
+ @stdout &&= File::join @q.path, @stdout # assume path relative to queue
57
+ @stderr &&= File::join @q.path, @stderr # assume path relative to queue
58
+
59
+ @cid =
60
+ Util::fork do
61
+ @env.each{|k,v| ENV[k] = v}
62
+ ENV['RQ_PID'] = "#{ $$ }"
63
+ @w.close
64
+ STDIN.reopen @r
65
+ argv =
66
+ if @sh_like
67
+ [ [@shell, "__rq_job__#{ @jid }__#{ File::basename(@shell) }__"], '--login' ]
68
+ else
69
+ [ [@shell, "__rq_job__#{ @jid }__#{ File::basename(@shell) }__"], '-l' ]
70
+ end
71
+ exec *argv
72
+ end
73
+
74
+ @r.close
75
+ #--}}}
76
+ end
77
+ def run
78
+ #--{{{
79
+ command =
80
+ if @sh_like
81
+ sin = "0<#{ @stdin }" if @stdin
82
+ sout = "1>#{ @stdout }" if @stdout
83
+ serr = "2>#{ @stderr }" if @stderr
84
+ #"{ #{ @command } ;} #{ sin } #{ sout } #{ serr }" # this maskes exit_status for bad input!
85
+ "( #{ @command } ;) #{ sin } #{ sout } #{ serr }"
86
+ else
87
+ sin = "<#{ @stdin }" if @stdin
88
+ sout = ">#{ @stdout }" if @stdout
89
+ serr = ">&#{ @stderr }" if @stderr
90
+ "( ( #{ @command } ;) #{ sin } #{ sout } ) #{ serr }"
91
+ end
92
+
93
+ #STDERR.puts command
94
+
95
+ @w.puts command
96
+ @w.close
97
+ #--}}}
98
+ end
99
+ #--}}}
100
+ end # class JobRunner
101
+ #--}}}
102
+ end # module RQ
103
+ $__rq_jobrunner__ = __FILE__
104
+ end
@@ -1,6 +1,6 @@
1
1
  unless defined? $__rq_jobrunnerdaemon__
2
2
  module RQ
3
- #{{{
3
+ #--{{{
4
4
  LIBDIR = File::dirname(File::expand_path(__FILE__)) + File::SEPARATOR unless
5
5
  defined? LIBDIR
6
6
 
@@ -12,14 +12,22 @@ unless defined? $__rq_jobrunnerdaemon__
12
12
  require LIBDIR + 'job'
13
13
  require LIBDIR + 'jobrunner'
14
14
 
15
+ #
16
+ # as stated in the description of the JobRunner class, the JobRunnerDaemon
17
+ # is a helper daemon that runs as a drb object. it's primary responsibilty
18
+ # is simply for enable forks to occur in a a different address space that
19
+ # the one doing the sqlite transaction. in addition to forking to create
20
+ # child processes in which to run jobs, the JobRunnerDaemon daemon also
21
+ # provides facilities to wait for these children
22
+ #
15
23
  class JobRunnerDaemon
16
- #{{{
24
+ #--{{{
17
25
  include Logging
18
26
 
19
27
  class << self
20
- #{{{
28
+ #--{{{
21
29
  def daemon(*a,&b)
22
- #{{{
30
+ #--{{{
23
31
  jrd = new(*a, &b)
24
32
 
25
33
  r, w = IO::pipe
@@ -40,6 +48,7 @@ unless defined? $__rq_jobrunnerdaemon__
40
48
  DRb::start_service u, jrd
41
49
  socket = s
42
50
  uri = u
51
+ break
43
52
  rescue Errno::EADDRINUSE
44
53
  n += 1
45
54
  end
@@ -76,6 +85,9 @@ unless defined? $__rq_jobrunnerdaemon__
76
85
  if socket and File::exist?(socket)
77
86
  at_exit{ FileUtils::rm_f socket }
78
87
  uri = "drbunix://#{ socket }"
88
+ #
89
+ # starting this on localhost avoids dns lookups!
90
+ #
79
91
  DRb::start_service 'druby://localhost:0', nil
80
92
  jrd = DRbObject::new nil, uri
81
93
  jrd.pid = pid
@@ -86,26 +98,28 @@ unless defined? $__rq_jobrunnerdaemon__
86
98
  end
87
99
 
88
100
  return jrd
89
- #}}}
101
+ #--}}}
90
102
  end
91
- #}}}
103
+ #--}}}
92
104
  end
105
+ attr :q
93
106
  attr :runners
94
107
  attr :pid, true
95
108
  attr :uri, true
96
- def initialize
97
- #{{{
109
+ def initialize q
110
+ #--{{{
111
+ @q = q
98
112
  @runners = {}
99
113
  @uri = nil
100
114
  @pid = Process::pid
101
- #}}}
115
+ #--}}}
102
116
  end
103
117
  def runner job
104
- #{{{
118
+ #--{{{
105
119
  r = nil
106
120
  retried = false
107
121
  begin
108
- r = JobRunner::new job
122
+ r = JobRunner::new @q, job
109
123
  rescue Errno::ENOMEM, Errno::EAGAIN
110
124
  GC::start
111
125
  unless retried
@@ -117,40 +131,40 @@ unless defined? $__rq_jobrunnerdaemon__
117
131
  end
118
132
  @runners[r.pid] = r
119
133
  r
120
- #}}}
134
+ #--}}}
121
135
  end
122
136
  def wait
123
- #{{{
137
+ #--{{{
124
138
  pid = Process::wait
125
139
  @runners.delete pid
126
140
  pid
127
- #}}}
141
+ #--}}}
128
142
  end
129
143
  def wait2
130
- #{{{
144
+ #--{{{
131
145
  pid, status = Process::wait2
132
146
  @runners.delete pid
133
147
  [pid, status]
134
- #}}}
148
+ #--}}}
135
149
  end
136
150
  def waitpid pid = -1, flags = 0
137
- #{{{
151
+ #--{{{
138
152
  pid = pid.pid if pid.respond_to? 'pid'
139
153
  pid = Process::waitpid pid, flags
140
154
  @runners.delete pid
141
155
  pid
142
- #}}}
156
+ #--}}}
143
157
  end
144
158
  def waitpid2 pid = -1, flags = 0
145
- #{{{
159
+ #--{{{
146
160
  pid = pid.pid if pid.respond_to? 'pid'
147
161
  pid, status = Process::waitpid2 pid, flags
148
162
  @runners.delete pid
149
163
  [pid, status]
150
- #}}}
164
+ #--}}}
151
165
  end
152
166
  def shutdown
153
- #{{{
167
+ #--{{{
154
168
  @death =
155
169
  Thread::new do
156
170
  begin
@@ -159,21 +173,21 @@ unless defined? $__rq_jobrunnerdaemon__
159
173
  @runners.delete pid
160
174
  end
161
175
  ensure
162
- sleep 4.2
176
+ #sleep 4.2
163
177
  DRb::thread.kill
164
178
  Thread::main exit!
165
179
  end
166
180
  end
167
- #}}}
181
+ #--}}}
168
182
  end
169
183
  def install_signal_handlers
170
- #{{{
184
+ #--{{{
171
185
  %w(TERM INT HUP).each{|sig| trap sig, 'SIG_IGN'}
172
- #}}}
186
+ #--}}}
173
187
  end
174
- #}}}
188
+ #--}}}
175
189
  end # class JobRunnerDaemon
176
- #}}}
190
+ #--}}}
177
191
  end # module RQ
178
192
  $__rq_jobrunnerdaemon__ = __FILE__
179
193
  end
@@ -0,0 +1,47 @@
1
+ unless defined? $__rq_lister__
2
+ module RQ
3
+ #--{{{
4
+ LIBDIR = File::dirname(File::expand_path(__FILE__)) + File::SEPARATOR unless
5
+ defined? LIBDIR
6
+
7
+ require LIBDIR + 'mainhelper'
8
+
9
+ #
10
+ # the Lister class simply dumps the contents of the queue in valid yaml
11
+ #
12
+ class Lister < MainHelper
13
+ #--{{{
14
+ def list
15
+ #--{{{
16
+ set_q
17
+
18
+ @infile = @options['infile']
19
+ debug{ "infile <#{ @infile }>" }
20
+
21
+ jobs = []
22
+ if @infile
23
+ open(@infile) do |f|
24
+ debug{ "reading jobs from <#{ @infile }>" }
25
+ loadio f, @infile, jobs
26
+ end
27
+ end
28
+ if stdin?
29
+ debug{ "reading jobs from <stdin>" }
30
+ loadio stdin, 'stdin', jobs
31
+ end
32
+ jobs.each{|job| @argv << Integer(job['jid'])}
33
+
34
+ @q.qdb.transaction_retries = 1
35
+
36
+ @q.list(*@argv, &dumping_yaml_tuples)
37
+
38
+ jobs = nil
39
+ self
40
+ #--}}}
41
+ end
42
+ #--}}}
43
+ end # class Lister
44
+ #--}}}
45
+ end # module RQ
46
+ $__rq_lister__ = __FILE__
47
+ end
@@ -0,0 +1,868 @@
1
+ /*
2
+ ** 2001 September 15
3
+ **
4
+ ** The author disclaims copyright to this source code. In place of
5
+ ** a legal notice, here is a blessing:
6
+ **
7
+ ** May you do good and not evil.
8
+ ** May you find forgiveness for yourself and forgive others.
9
+ ** May you share freely, never taking more than you give.
10
+ **
11
+ *************************************************************************
12
+ ** This header file defines the interface that the SQLite library
13
+ ** presents to client programs.
14
+ **
15
+ ** @(#) $Id: sqlite.h.in,v 1.60 2004/03/14 22:12:35 drh Exp $
16
+ */
17
+ #ifndef _SQLITE_H_
18
+ #define _SQLITE_H_
19
+ #include <stdarg.h> /* Needed for the definition of va_list */
20
+
21
+ /*
22
+ ** Make sure we can call this stuff from C++.
23
+ */
24
+ #ifdef __cplusplus
25
+ extern "C" {
26
+ #endif
27
+
28
+ /*
29
+ ** The version of the SQLite library.
30
+ */
31
+ #define SQLITE_VERSION "2.8.15"
32
+
33
+ /*
34
+ ** The version string is also compiled into the library so that a program
35
+ ** can check to make sure that the lib*.a file and the *.h file are from
36
+ ** the same version.
37
+ */
38
+ extern const char sqlite_version[];
39
+
40
+ /*
41
+ ** The SQLITE_UTF8 macro is defined if the library expects to see
42
+ ** UTF-8 encoded data. The SQLITE_ISO8859 macro is defined if the
43
+ ** iso8859 encoded should be used.
44
+ */
45
+ #define SQLITE_ISO8859 1
46
+
47
+ /*
48
+ ** The following constant holds one of two strings, "UTF-8" or "iso8859",
49
+ ** depending on which character encoding the SQLite library expects to
50
+ ** see. The character encoding makes a difference for the LIKE and GLOB
51
+ ** operators and for the LENGTH() and SUBSTR() functions.
52
+ */
53
+ extern const char sqlite_encoding[];
54
+
55
+ /*
56
+ ** Each open sqlite database is represented by an instance of the
57
+ ** following opaque structure.
58
+ */
59
+ typedef struct sqlite sqlite;
60
+
61
+ /*
62
+ ** A function to open a new sqlite database.
63
+ **
64
+ ** If the database does not exist and mode indicates write
65
+ ** permission, then a new database is created. If the database
66
+ ** does not exist and mode does not indicate write permission,
67
+ ** then the open fails, an error message generated (if errmsg!=0)
68
+ ** and the function returns 0.
69
+ **
70
+ ** If mode does not indicates user write permission, then the
71
+ ** database is opened read-only.
72
+ **
73
+ ** The Truth: As currently implemented, all databases are opened
74
+ ** for writing all the time. Maybe someday we will provide the
75
+ ** ability to open a database readonly. The mode parameters is
76
+ ** provided in anticipation of that enhancement.
77
+ */
78
+ sqlite *sqlite_open(const char *filename, int mode, char **errmsg);
79
+
80
+ /*
81
+ ** A function to close the database.
82
+ **
83
+ ** Call this function with a pointer to a structure that was previously
84
+ ** returned from sqlite_open() and the corresponding database will by closed.
85
+ */
86
+ void sqlite_close(sqlite *);
87
+
88
+ /*
89
+ ** The type for a callback function.
90
+ */
91
+ typedef int (*sqlite_callback)(void*,int,char**, char**);
92
+
93
+ /*
94
+ ** A function to executes one or more statements of SQL.
95
+ **
96
+ ** If one or more of the SQL statements are queries, then
97
+ ** the callback function specified by the 3rd parameter is
98
+ ** invoked once for each row of the query result. This callback
99
+ ** should normally return 0. If the callback returns a non-zero
100
+ ** value then the query is aborted, all subsequent SQL statements
101
+ ** are skipped and the sqlite_exec() function returns the SQLITE_ABORT.
102
+ **
103
+ ** The 4th parameter is an arbitrary pointer that is passed
104
+ ** to the callback function as its first parameter.
105
+ **
106
+ ** The 2nd parameter to the callback function is the number of
107
+ ** columns in the query result. The 3rd parameter to the callback
108
+ ** is an array of strings holding the values for each column.
109
+ ** The 4th parameter to the callback is an array of strings holding
110
+ ** the names of each column.
111
+ **
112
+ ** The callback function may be NULL, even for queries. A NULL
113
+ ** callback is not an error. It just means that no callback
114
+ ** will be invoked.
115
+ **
116
+ ** If an error occurs while parsing or evaluating the SQL (but
117
+ ** not while executing the callback) then an appropriate error
118
+ ** message is written into memory obtained from malloc() and
119
+ ** *errmsg is made to point to that message. The calling function
120
+ ** is responsible for freeing the memory that holds the error
121
+ ** message. Use sqlite_freemem() for this. If errmsg==NULL,
122
+ ** then no error message is ever written.
123
+ **
124
+ ** The return value is is SQLITE_OK if there are no errors and
125
+ ** some other return code if there is an error. The particular
126
+ ** return value depends on the type of error.
127
+ **
128
+ ** If the query could not be executed because a database file is
129
+ ** locked or busy, then this function returns SQLITE_BUSY. (This
130
+ ** behavior can be modified somewhat using the sqlite_busy_handler()
131
+ ** and sqlite_busy_timeout() functions below.)
132
+ */
133
+ int sqlite_exec(
134
+ sqlite*, /* An open database */
135
+ const char *sql, /* SQL to be executed */
136
+ sqlite_callback, /* Callback function */
137
+ void *, /* 1st argument to callback function */
138
+ char **errmsg /* Error msg written here */
139
+ );
140
+
141
+ /*
142
+ ** Return values for sqlite_exec() and sqlite_step()
143
+ */
144
+ #define SQLITE_OK 0 /* Successful result */
145
+ #define SQLITE_ERROR 1 /* SQL error or missing database */
146
+ #define SQLITE_INTERNAL 2 /* An internal logic error in SQLite */
147
+ #define SQLITE_PERM 3 /* Access permission denied */
148
+ #define SQLITE_ABORT 4 /* Callback routine requested an abort */
149
+ #define SQLITE_BUSY 5 /* The database file is locked */
150
+ #define SQLITE_LOCKED 6 /* A table in the database is locked */
151
+ #define SQLITE_NOMEM 7 /* A malloc() failed */
152
+ #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
153
+ #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite_interrupt() */
154
+ #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
155
+ #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
156
+ #define SQLITE_NOTFOUND 12 /* (Internal Only) Table or record not found */
157
+ #define SQLITE_FULL 13 /* Insertion failed because database is full */
158
+ #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
159
+ #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
160
+ #define SQLITE_EMPTY 16 /* (Internal Only) Database table is empty */
161
+ #define SQLITE_SCHEMA 17 /* The database schema changed */
162
+ #define SQLITE_TOOBIG 18 /* Too much data for one row of a table */
163
+ #define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */
164
+ #define SQLITE_MISMATCH 20 /* Data type mismatch */
165
+ #define SQLITE_MISUSE 21 /* Library used incorrectly */
166
+ #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
167
+ #define SQLITE_AUTH 23 /* Authorization denied */
168
+ #define SQLITE_FORMAT 24 /* Auxiliary database format error */
169
+ #define SQLITE_RANGE 25 /* 2nd parameter to sqlite_bind out of range */
170
+ #define SQLITE_NOTADB 26 /* File opened that is not a database file */
171
+ #define SQLITE_ROW 100 /* sqlite_step() has another row ready */
172
+ #define SQLITE_DONE 101 /* sqlite_step() has finished executing */
173
+
174
+ /*
175
+ ** Each entry in an SQLite table has a unique integer key. (The key is
176
+ ** the value of the INTEGER PRIMARY KEY column if there is such a column,
177
+ ** otherwise the key is generated at random. The unique key is always
178
+ ** available as the ROWID, OID, or _ROWID_ column.) The following routine
179
+ ** returns the integer key of the most recent insert in the database.
180
+ **
181
+ ** This function is similar to the mysql_insert_id() function from MySQL.
182
+ */
183
+ int sqlite_last_insert_rowid(sqlite*);
184
+
185
+ /*
186
+ ** This function returns the number of database rows that were changed
187
+ ** (or inserted or deleted) by the most recent called sqlite_exec().
188
+ **
189
+ ** All changes are counted, even if they were later undone by a
190
+ ** ROLLBACK or ABORT. Except, changes associated with creating and
191
+ ** dropping tables are not counted.
192
+ **
193
+ ** If a callback invokes sqlite_exec() recursively, then the changes
194
+ ** in the inner, recursive call are counted together with the changes
195
+ ** in the outer call.
196
+ **
197
+ ** SQLite implements the command "DELETE FROM table" without a WHERE clause
198
+ ** by dropping and recreating the table. (This is much faster than going
199
+ ** through and deleting individual elements form the table.) Because of
200
+ ** this optimization, the change count for "DELETE FROM table" will be
201
+ ** zero regardless of the number of elements that were originally in the
202
+ ** table. To get an accurate count of the number of rows deleted, use
203
+ ** "DELETE FROM table WHERE 1" instead.
204
+ */
205
+ int sqlite_changes(sqlite*);
206
+
207
+ /*
208
+ ** This function returns the number of database rows that were changed
209
+ ** by the last INSERT, UPDATE, or DELETE statment executed by sqlite_exec(),
210
+ ** or by the last VM to run to completion. The change count is not updated
211
+ ** by SQL statements other than INSERT, UPDATE or DELETE.
212
+ **
213
+ ** Changes are counted, even if they are later undone by a ROLLBACK or
214
+ ** ABORT. Changes associated with trigger programs that execute as a
215
+ ** result of the INSERT, UPDATE, or DELETE statement are not counted.
216
+ **
217
+ ** If a callback invokes sqlite_exec() recursively, then the changes
218
+ ** in the inner, recursive call are counted together with the changes
219
+ ** in the outer call.
220
+ **
221
+ ** SQLite implements the command "DELETE FROM table" without a WHERE clause
222
+ ** by dropping and recreating the table. (This is much faster than going
223
+ ** through and deleting individual elements form the table.) Because of
224
+ ** this optimization, the change count for "DELETE FROM table" will be
225
+ ** zero regardless of the number of elements that were originally in the
226
+ ** table. To get an accurate count of the number of rows deleted, use
227
+ ** "DELETE FROM table WHERE 1" instead.
228
+ **
229
+ ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
230
+ */
231
+ int sqlite_last_statement_changes(sqlite*);
232
+
233
+ /* If the parameter to this routine is one of the return value constants
234
+ ** defined above, then this routine returns a constant text string which
235
+ ** descripts (in English) the meaning of the return value.
236
+ */
237
+ const char *sqlite_error_string(int);
238
+ #define sqliteErrStr sqlite_error_string /* Legacy. Do not use in new code. */
239
+
240
+ /* This function causes any pending database operation to abort and
241
+ ** return at its earliest opportunity. This routine is typically
242
+ ** called in response to a user action such as pressing "Cancel"
243
+ ** or Ctrl-C where the user wants a long query operation to halt
244
+ ** immediately.
245
+ */
246
+ void sqlite_interrupt(sqlite*);
247
+
248
+
249
+ /* This function returns true if the given input string comprises
250
+ ** one or more complete SQL statements.
251
+ **
252
+ ** The algorithm is simple. If the last token other than spaces
253
+ ** and comments is a semicolon, then return true. otherwise return
254
+ ** false.
255
+ */
256
+ int sqlite_complete(const char *sql);
257
+
258
+ /*
259
+ ** This routine identifies a callback function that is invoked
260
+ ** whenever an attempt is made to open a database table that is
261
+ ** currently locked by another process or thread. If the busy callback
262
+ ** is NULL, then sqlite_exec() returns SQLITE_BUSY immediately if
263
+ ** it finds a locked table. If the busy callback is not NULL, then
264
+ ** sqlite_exec() invokes the callback with three arguments. The
265
+ ** second argument is the name of the locked table and the third
266
+ ** argument is the number of times the table has been busy. If the
267
+ ** busy callback returns 0, then sqlite_exec() immediately returns
268
+ ** SQLITE_BUSY. If the callback returns non-zero, then sqlite_exec()
269
+ ** tries to open the table again and the cycle repeats.
270
+ **
271
+ ** The default busy callback is NULL.
272
+ **
273
+ ** Sqlite is re-entrant, so the busy handler may start a new query.
274
+ ** (It is not clear why anyone would every want to do this, but it
275
+ ** is allowed, in theory.) But the busy handler may not close the
276
+ ** database. Closing the database from a busy handler will delete
277
+ ** data structures out from under the executing query and will
278
+ ** probably result in a coredump.
279
+ */
280
+ void sqlite_busy_handler(sqlite*, int(*)(void*,const char*,int), void*);
281
+
282
+ /*
283
+ ** This routine sets a busy handler that sleeps for a while when a
284
+ ** table is locked. The handler will sleep multiple times until
285
+ ** at least "ms" milleseconds of sleeping have been done. After
286
+ ** "ms" milleseconds of sleeping, the handler returns 0 which
287
+ ** causes sqlite_exec() to return SQLITE_BUSY.
288
+ **
289
+ ** Calling this routine with an argument less than or equal to zero
290
+ ** turns off all busy handlers.
291
+ */
292
+ void sqlite_busy_timeout(sqlite*, int ms);
293
+
294
+ /*
295
+ ** This next routine is really just a wrapper around sqlite_exec().
296
+ ** Instead of invoking a user-supplied callback for each row of the
297
+ ** result, this routine remembers each row of the result in memory
298
+ ** obtained from malloc(), then returns all of the result after the
299
+ ** query has finished.
300
+ **
301
+ ** As an example, suppose the query result where this table:
302
+ **
303
+ ** Name | Age
304
+ ** -----------------------
305
+ ** Alice | 43
306
+ ** Bob | 28
307
+ ** Cindy | 21
308
+ **
309
+ ** If the 3rd argument were &azResult then after the function returns
310
+ ** azResult will contain the following data:
311
+ **
312
+ ** azResult[0] = "Name";
313
+ ** azResult[1] = "Age";
314
+ ** azResult[2] = "Alice";
315
+ ** azResult[3] = "43";
316
+ ** azResult[4] = "Bob";
317
+ ** azResult[5] = "28";
318
+ ** azResult[6] = "Cindy";
319
+ ** azResult[7] = "21";
320
+ **
321
+ ** Notice that there is an extra row of data containing the column
322
+ ** headers. But the *nrow return value is still 3. *ncolumn is
323
+ ** set to 2. In general, the number of values inserted into azResult
324
+ ** will be ((*nrow) + 1)*(*ncolumn).
325
+ **
326
+ ** After the calling function has finished using the result, it should
327
+ ** pass the result data pointer to sqlite_free_table() in order to
328
+ ** release the memory that was malloc-ed. Because of the way the
329
+ ** malloc() happens, the calling function must not try to call
330
+ ** malloc() directly. Only sqlite_free_table() is able to release
331
+ ** the memory properly and safely.
332
+ **
333
+ ** The return value of this routine is the same as from sqlite_exec().
334
+ */
335
+ int sqlite_get_table(
336
+ sqlite*, /* An open database */
337
+ const char *sql, /* SQL to be executed */
338
+ char ***resultp, /* Result written to a char *[] that this points to */
339
+ int *nrow, /* Number of result rows written here */
340
+ int *ncolumn, /* Number of result columns written here */
341
+ char **errmsg /* Error msg written here */
342
+ );
343
+
344
+ /*
345
+ ** Call this routine to free the memory that sqlite_get_table() allocated.
346
+ */
347
+ void sqlite_free_table(char **result);
348
+
349
+ /*
350
+ ** The following routines are wrappers around sqlite_exec() and
351
+ ** sqlite_get_table(). The only difference between the routines that
352
+ ** follow and the originals is that the second argument to the
353
+ ** routines that follow is really a printf()-style format
354
+ ** string describing the SQL to be executed. Arguments to the format
355
+ ** string appear at the end of the argument list.
356
+ **
357
+ ** All of the usual printf formatting options apply. In addition, there
358
+ ** is a "%q" option. %q works like %s in that it substitutes a null-terminated
359
+ ** string from the argument list. But %q also doubles every '\'' character.
360
+ ** %q is designed for use inside a string literal. By doubling each '\''
361
+ ** character it escapes that character and allows it to be inserted into
362
+ ** the string.
363
+ **
364
+ ** For example, so some string variable contains text as follows:
365
+ **
366
+ ** char *zText = "It's a happy day!";
367
+ **
368
+ ** We can use this text in an SQL statement as follows:
369
+ **
370
+ ** sqlite_exec_printf(db, "INSERT INTO table VALUES('%q')",
371
+ ** callback1, 0, 0, zText);
372
+ **
373
+ ** Because the %q format string is used, the '\'' character in zText
374
+ ** is escaped and the SQL generated is as follows:
375
+ **
376
+ ** INSERT INTO table1 VALUES('It''s a happy day!')
377
+ **
378
+ ** This is correct. Had we used %s instead of %q, the generated SQL
379
+ ** would have looked like this:
380
+ **
381
+ ** INSERT INTO table1 VALUES('It's a happy day!');
382
+ **
383
+ ** This second example is an SQL syntax error. As a general rule you
384
+ ** should always use %q instead of %s when inserting text into a string
385
+ ** literal.
386
+ */
387
+ int sqlite_exec_printf(
388
+ sqlite*, /* An open database */
389
+ const char *sqlFormat, /* printf-style format string for the SQL */
390
+ sqlite_callback, /* Callback function */
391
+ void *, /* 1st argument to callback function */
392
+ char **errmsg, /* Error msg written here */
393
+ ... /* Arguments to the format string. */
394
+ );
395
+ int sqlite_exec_vprintf(
396
+ sqlite*, /* An open database */
397
+ const char *sqlFormat, /* printf-style format string for the SQL */
398
+ sqlite_callback, /* Callback function */
399
+ void *, /* 1st argument to callback function */
400
+ char **errmsg, /* Error msg written here */
401
+ va_list ap /* Arguments to the format string. */
402
+ );
403
+ int sqlite_get_table_printf(
404
+ sqlite*, /* An open database */
405
+ const char *sqlFormat, /* printf-style format string for the SQL */
406
+ char ***resultp, /* Result written to a char *[] that this points to */
407
+ int *nrow, /* Number of result rows written here */
408
+ int *ncolumn, /* Number of result columns written here */
409
+ char **errmsg, /* Error msg written here */
410
+ ... /* Arguments to the format string */
411
+ );
412
+ int sqlite_get_table_vprintf(
413
+ sqlite*, /* An open database */
414
+ const char *sqlFormat, /* printf-style format string for the SQL */
415
+ char ***resultp, /* Result written to a char *[] that this points to */
416
+ int *nrow, /* Number of result rows written here */
417
+ int *ncolumn, /* Number of result columns written here */
418
+ char **errmsg, /* Error msg written here */
419
+ va_list ap /* Arguments to the format string */
420
+ );
421
+ char *sqlite_mprintf(const char*,...);
422
+ char *sqlite_vmprintf(const char*, va_list);
423
+
424
+ /*
425
+ ** Windows systems should call this routine to free memory that
426
+ ** is returned in the in the errmsg parameter of sqlite_open() when
427
+ ** SQLite is a DLL. For some reason, it does not work to call free()
428
+ ** directly.
429
+ */
430
+ void sqlite_freemem(void *p);
431
+
432
+ /*
433
+ ** Windows systems need functions to call to return the sqlite_version
434
+ ** and sqlite_encoding strings.
435
+ */
436
+ const char *sqlite_libversion(void);
437
+ const char *sqlite_libencoding(void);
438
+
439
+ /*
440
+ ** A pointer to the following structure is used to communicate with
441
+ ** the implementations of user-defined functions.
442
+ */
443
+ typedef struct sqlite_func sqlite_func;
444
+
445
+ /*
446
+ ** Use the following routines to create new user-defined functions. See
447
+ ** the documentation for details.
448
+ */
449
+ int sqlite_create_function(
450
+ sqlite*, /* Database where the new function is registered */
451
+ const char *zName, /* Name of the new function */
452
+ int nArg, /* Number of arguments. -1 means any number */
453
+ void (*xFunc)(sqlite_func*,int,const char**), /* C code to implement */
454
+ void *pUserData /* Available via the sqlite_user_data() call */
455
+ );
456
+ int sqlite_create_aggregate(
457
+ sqlite*, /* Database where the new function is registered */
458
+ const char *zName, /* Name of the function */
459
+ int nArg, /* Number of arguments */
460
+ void (*xStep)(sqlite_func*,int,const char**), /* Called for each row */
461
+ void (*xFinalize)(sqlite_func*), /* Called once to get final result */
462
+ void *pUserData /* Available via the sqlite_user_data() call */
463
+ );
464
+
465
+ /*
466
+ ** Use the following routine to define the datatype returned by a
467
+ ** user-defined function. The second argument can be one of the
468
+ ** constants SQLITE_NUMERIC, SQLITE_TEXT, or SQLITE_ARGS or it
469
+ ** can be an integer greater than or equal to zero. When the datatype
470
+ ** parameter is non-negative, the type of the result will be the
471
+ ** same as the datatype-th argument. If datatype==SQLITE_NUMERIC
472
+ ** then the result is always numeric. If datatype==SQLITE_TEXT then
473
+ ** the result is always text. If datatype==SQLITE_ARGS then the result
474
+ ** is numeric if any argument is numeric and is text otherwise.
475
+ */
476
+ int sqlite_function_type(
477
+ sqlite *db, /* The database there the function is registered */
478
+ const char *zName, /* Name of the function */
479
+ int datatype /* The datatype for this function */
480
+ );
481
+ #define SQLITE_NUMERIC (-1)
482
+ #define SQLITE_TEXT (-2)
483
+ #define SQLITE_ARGS (-3)
484
+
485
+ /*
486
+ ** The user function implementations call one of the following four routines
487
+ ** in order to return their results. The first parameter to each of these
488
+ ** routines is a copy of the first argument to xFunc() or xFinialize().
489
+ ** The second parameter to these routines is the result to be returned.
490
+ ** A NULL can be passed as the second parameter to sqlite_set_result_string()
491
+ ** in order to return a NULL result.
492
+ **
493
+ ** The 3rd argument to _string and _error is the number of characters to
494
+ ** take from the string. If this argument is negative, then all characters
495
+ ** up to and including the first '\000' are used.
496
+ **
497
+ ** The sqlite_set_result_string() function allocates a buffer to hold the
498
+ ** result and returns a pointer to this buffer. The calling routine
499
+ ** (that is, the implmentation of a user function) can alter the content
500
+ ** of this buffer if desired.
501
+ */
502
+ char *sqlite_set_result_string(sqlite_func*,const char*,int);
503
+ void sqlite_set_result_int(sqlite_func*,int);
504
+ void sqlite_set_result_double(sqlite_func*,double);
505
+ void sqlite_set_result_error(sqlite_func*,const char*,int);
506
+
507
+ /*
508
+ ** The pUserData parameter to the sqlite_create_function() and
509
+ ** sqlite_create_aggregate() routines used to register user functions
510
+ ** is available to the implementation of the function using this
511
+ ** call.
512
+ */
513
+ void *sqlite_user_data(sqlite_func*);
514
+
515
+ /*
516
+ ** Aggregate functions use the following routine to allocate
517
+ ** a structure for storing their state. The first time this routine
518
+ ** is called for a particular aggregate, a new structure of size nBytes
519
+ ** is allocated, zeroed, and returned. On subsequent calls (for the
520
+ ** same aggregate instance) the same buffer is returned. The implementation
521
+ ** of the aggregate can use the returned buffer to accumulate data.
522
+ **
523
+ ** The buffer allocated is freed automatically be SQLite.
524
+ */
525
+ void *sqlite_aggregate_context(sqlite_func*, int nBytes);
526
+
527
+ /*
528
+ ** The next routine returns the number of calls to xStep for a particular
529
+ ** aggregate function instance. The current call to xStep counts so this
530
+ ** routine always returns at least 1.
531
+ */
532
+ int sqlite_aggregate_count(sqlite_func*);
533
+
534
+ /*
535
+ ** This routine registers a callback with the SQLite library. The
536
+ ** callback is invoked (at compile-time, not at run-time) for each
537
+ ** attempt to access a column of a table in the database. The callback
538
+ ** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire
539
+ ** SQL statement should be aborted with an error and SQLITE_IGNORE
540
+ ** if the column should be treated as a NULL value.
541
+ */
542
+ int sqlite_set_authorizer(
543
+ sqlite*,
544
+ int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
545
+ void *pUserData
546
+ );
547
+
548
+ /*
549
+ ** The second parameter to the access authorization function above will
550
+ ** be one of the values below. These values signify what kind of operation
551
+ ** is to be authorized. The 3rd and 4th parameters to the authorization
552
+ ** function will be parameters or NULL depending on which of the following
553
+ ** codes is used as the second parameter. The 5th parameter is the name
554
+ ** of the database ("main", "temp", etc.) if applicable. The 6th parameter
555
+ ** is the name of the inner-most trigger or view that is responsible for
556
+ ** the access attempt or NULL if this access attempt is directly from
557
+ ** input SQL code.
558
+ **
559
+ ** Arg-3 Arg-4
560
+ */
561
+ #define SQLITE_COPY 0 /* Table Name File Name */
562
+ #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
563
+ #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
564
+ #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
565
+ #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
566
+ #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
567
+ #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
568
+ #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
569
+ #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
570
+ #define SQLITE_DELETE 9 /* Table Name NULL */
571
+ #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
572
+ #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
573
+ #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
574
+ #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
575
+ #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
576
+ #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
577
+ #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
578
+ #define SQLITE_DROP_VIEW 17 /* View Name NULL */
579
+ #define SQLITE_INSERT 18 /* Table Name NULL */
580
+ #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
581
+ #define SQLITE_READ 20 /* Table Name Column Name */
582
+ #define SQLITE_SELECT 21 /* NULL NULL */
583
+ #define SQLITE_TRANSACTION 22 /* NULL NULL */
584
+ #define SQLITE_UPDATE 23 /* Table Name Column Name */
585
+ #define SQLITE_ATTACH 24 /* Filename NULL */
586
+ #define SQLITE_DETACH 25 /* Database Name NULL */
587
+
588
+
589
+ /*
590
+ ** The return value of the authorization function should be one of the
591
+ ** following constants:
592
+ */
593
+ /* #define SQLITE_OK 0 // Allow access (This is actually defined above) */
594
+ #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
595
+ #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
596
+
597
+ /*
598
+ ** Register a function that is called at every invocation of sqlite_exec()
599
+ ** or sqlite_compile(). This function can be used (for example) to generate
600
+ ** a log file of all SQL executed against a database.
601
+ */
602
+ void *sqlite_trace(sqlite*, void(*xTrace)(void*,const char*), void*);
603
+
604
+ /*** The Callback-Free API
605
+ **
606
+ ** The following routines implement a new way to access SQLite that does not
607
+ ** involve the use of callbacks.
608
+ **
609
+ ** An sqlite_vm is an opaque object that represents a single SQL statement
610
+ ** that is ready to be executed.
611
+ */
612
+ typedef struct sqlite_vm sqlite_vm;
613
+
614
+ /*
615
+ ** To execute an SQLite query without the use of callbacks, you first have
616
+ ** to compile the SQL using this routine. The 1st parameter "db" is a pointer
617
+ ** to an sqlite object obtained from sqlite_open(). The 2nd parameter
618
+ ** "zSql" is the text of the SQL to be compiled. The remaining parameters
619
+ ** are all outputs.
620
+ **
621
+ ** *pzTail is made to point to the first character past the end of the first
622
+ ** SQL statement in zSql. This routine only compiles the first statement
623
+ ** in zSql, so *pzTail is left pointing to what remains uncompiled.
624
+ **
625
+ ** *ppVm is left pointing to a "virtual machine" that can be used to execute
626
+ ** the compiled statement. Or if there is an error, *ppVm may be set to NULL.
627
+ ** If the input text contained no SQL (if the input is and empty string or
628
+ ** a comment) then *ppVm is set to NULL.
629
+ **
630
+ ** If any errors are detected during compilation, an error message is written
631
+ ** into space obtained from malloc() and *pzErrMsg is made to point to that
632
+ ** error message. The calling routine is responsible for freeing the text
633
+ ** of this message when it has finished with it. Use sqlite_freemem() to
634
+ ** free the message. pzErrMsg may be NULL in which case no error message
635
+ ** will be generated.
636
+ **
637
+ ** On success, SQLITE_OK is returned. Otherwise and error code is returned.
638
+ */
639
+ int sqlite_compile(
640
+ sqlite *db, /* The open database */
641
+ const char *zSql, /* SQL statement to be compiled */
642
+ const char **pzTail, /* OUT: uncompiled tail of zSql */
643
+ sqlite_vm **ppVm, /* OUT: the virtual machine to execute zSql */
644
+ char **pzErrmsg /* OUT: Error message. */
645
+ );
646
+
647
+ /*
648
+ ** After an SQL statement has been compiled, it is handed to this routine
649
+ ** to be executed. This routine executes the statement as far as it can
650
+ ** go then returns. The return value will be one of SQLITE_DONE,
651
+ ** SQLITE_ERROR, SQLITE_BUSY, SQLITE_ROW, or SQLITE_MISUSE.
652
+ **
653
+ ** SQLITE_DONE means that the execute of the SQL statement is complete
654
+ ** an no errors have occurred. sqlite_step() should not be called again
655
+ ** for the same virtual machine. *pN is set to the number of columns in
656
+ ** the result set and *pazColName is set to an array of strings that
657
+ ** describe the column names and datatypes. The name of the i-th column
658
+ ** is (*pazColName)[i] and the datatype of the i-th column is
659
+ ** (*pazColName)[i+*pN]. *pazValue is set to NULL.
660
+ **
661
+ ** SQLITE_ERROR means that the virtual machine encountered a run-time
662
+ ** error. sqlite_step() should not be called again for the same
663
+ ** virtual machine. *pN is set to 0 and *pazColName and *pazValue are set
664
+ ** to NULL. Use sqlite_finalize() to obtain the specific error code
665
+ ** and the error message text for the error.
666
+ **
667
+ ** SQLITE_BUSY means that an attempt to open the database failed because
668
+ ** another thread or process is holding a lock. The calling routine
669
+ ** can try again to open the database by calling sqlite_step() again.
670
+ ** The return code will only be SQLITE_BUSY if no busy handler is registered
671
+ ** using the sqlite_busy_handler() or sqlite_busy_timeout() routines. If
672
+ ** a busy handler callback has been registered but returns 0, then this
673
+ ** routine will return SQLITE_ERROR and sqltie_finalize() will return
674
+ ** SQLITE_BUSY when it is called.
675
+ **
676
+ ** SQLITE_ROW means that a single row of the result is now available.
677
+ ** The data is contained in *pazValue. The value of the i-th column is
678
+ ** (*azValue)[i]. *pN and *pazColName are set as described in SQLITE_DONE.
679
+ ** Invoke sqlite_step() again to advance to the next row.
680
+ **
681
+ ** SQLITE_MISUSE is returned if sqlite_step() is called incorrectly.
682
+ ** For example, if you call sqlite_step() after the virtual machine
683
+ ** has halted (after a prior call to sqlite_step() has returned SQLITE_DONE)
684
+ ** or if you call sqlite_step() with an incorrectly initialized virtual
685
+ ** machine or a virtual machine that has been deleted or that is associated
686
+ ** with an sqlite structure that has been closed.
687
+ */
688
+ int sqlite_step(
689
+ sqlite_vm *pVm, /* The virtual machine to execute */
690
+ int *pN, /* OUT: Number of columns in result */
691
+ const char ***pazValue, /* OUT: Column data */
692
+ const char ***pazColName /* OUT: Column names and datatypes */
693
+ );
694
+
695
+ /*
696
+ ** This routine is called to delete a virtual machine after it has finished
697
+ ** executing. The return value is the result code. SQLITE_OK is returned
698
+ ** if the statement executed successfully and some other value is returned if
699
+ ** there was any kind of error. If an error occurred and pzErrMsg is not
700
+ ** NULL, then an error message is written into memory obtained from malloc()
701
+ ** and *pzErrMsg is made to point to that error message. The calling routine
702
+ ** should use sqlite_freemem() to delete this message when it has finished
703
+ ** with it.
704
+ **
705
+ ** This routine can be called at any point during the execution of the
706
+ ** virtual machine. If the virtual machine has not completed execution
707
+ ** when this routine is called, that is like encountering an error or
708
+ ** an interrupt. (See sqlite_interrupt().) Incomplete updates may be
709
+ ** rolled back and transactions cancelled, depending on the circumstances,
710
+ ** and the result code returned will be SQLITE_ABORT.
711
+ */
712
+ int sqlite_finalize(sqlite_vm*, char **pzErrMsg);
713
+
714
+ /*
715
+ ** This routine deletes the virtual machine, writes any error message to
716
+ ** *pzErrMsg and returns an SQLite return code in the same way as the
717
+ ** sqlite_finalize() function.
718
+ **
719
+ ** Additionally, if ppVm is not NULL, *ppVm is left pointing to a new virtual
720
+ ** machine loaded with the compiled version of the original query ready for
721
+ ** execution.
722
+ **
723
+ ** If sqlite_reset() returns SQLITE_SCHEMA, then *ppVm is set to NULL.
724
+ **
725
+ ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
726
+ */
727
+ int sqlite_reset(sqlite_vm*, char **pzErrMsg);
728
+
729
+ /*
730
+ ** If the SQL that was handed to sqlite_compile contains variables that
731
+ ** are represeted in the SQL text by a question mark ('?'). This routine
732
+ ** is used to assign values to those variables.
733
+ **
734
+ ** The first parameter is a virtual machine obtained from sqlite_compile().
735
+ ** The 2nd "idx" parameter determines which variable in the SQL statement
736
+ ** to bind the value to. The left most '?' is 1. The 3rd parameter is
737
+ ** the value to assign to that variable. The 4th parameter is the number
738
+ ** of bytes in the value, including the terminating \000 for strings.
739
+ ** Finally, the 5th "copy" parameter is TRUE if SQLite should make its
740
+ ** own private copy of this value, or false if the space that the 3rd
741
+ ** parameter points to will be unchanging and can be used directly by
742
+ ** SQLite.
743
+ **
744
+ ** Unbound variables are treated as having a value of NULL. To explicitly
745
+ ** set a variable to NULL, call this routine with the 3rd parameter as a
746
+ ** NULL pointer.
747
+ **
748
+ ** If the 4th "len" parameter is -1, then strlen() is used to find the
749
+ ** length.
750
+ **
751
+ ** This routine can only be called immediately after sqlite_compile()
752
+ ** or sqlite_reset() and before any calls to sqlite_step().
753
+ **
754
+ ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
755
+ */
756
+ int sqlite_bind(sqlite_vm*, int idx, const char *value, int len, int copy);
757
+
758
+ /*
759
+ ** This routine configures a callback function - the progress callback - that
760
+ ** is invoked periodically during long running calls to sqlite_exec(),
761
+ ** sqlite_step() and sqlite_get_table(). An example use for this API is to keep
762
+ ** a GUI updated during a large query.
763
+ **
764
+ ** The progress callback is invoked once for every N virtual machine opcodes,
765
+ ** where N is the second argument to this function. The progress callback
766
+ ** itself is identified by the third argument to this function. The fourth
767
+ ** argument to this function is a void pointer passed to the progress callback
768
+ ** function each time it is invoked.
769
+ **
770
+ ** If a call to sqlite_exec(), sqlite_step() or sqlite_get_table() results
771
+ ** in less than N opcodes being executed, then the progress callback is not
772
+ ** invoked.
773
+ **
774
+ ** Calling this routine overwrites any previously installed progress callback.
775
+ ** To remove the progress callback altogether, pass NULL as the third
776
+ ** argument to this function.
777
+ **
778
+ ** If the progress callback returns a result other than 0, then the current
779
+ ** query is immediately terminated and any database changes rolled back. If the
780
+ ** query was part of a larger transaction, then the transaction is not rolled
781
+ ** back and remains active. The sqlite_exec() call returns SQLITE_ABORT.
782
+ **
783
+ ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
784
+ */
785
+ void sqlite_progress_handler(sqlite*, int, int(*)(void*), void*);
786
+
787
+ /*
788
+ ** Register a callback function to be invoked whenever a new transaction
789
+ ** is committed. The pArg argument is passed through to the callback.
790
+ ** callback. If the callback function returns non-zero, then the commit
791
+ ** is converted into a rollback.
792
+ **
793
+ ** If another function was previously registered, its pArg value is returned.
794
+ ** Otherwise NULL is returned.
795
+ **
796
+ ** Registering a NULL function disables the callback.
797
+ **
798
+ ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
799
+ */
800
+ void *sqlite_commit_hook(sqlite*, int(*)(void*), void*);
801
+
802
+ /*
803
+ ** Open an encrypted SQLite database. If pKey==0 or nKey==0, this routine
804
+ ** is the same as sqlite_open().
805
+ **
806
+ ** The code to implement this API is not available in the public release
807
+ ** of SQLite.
808
+ */
809
+ sqlite *sqlite_open_encrypted(
810
+ const char *zFilename, /* Name of the encrypted database */
811
+ const void *pKey, /* Pointer to the key */
812
+ int nKey, /* Number of bytes in the key */
813
+ int *pErrcode, /* Write error code here */
814
+ char **pzErrmsg /* Write error message here */
815
+ );
816
+
817
+ /*
818
+ ** Change the key on an open database. If the current database is not
819
+ ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
820
+ ** database is decrypted.
821
+ **
822
+ ** The code to implement this API is not available in the public release
823
+ ** of SQLite.
824
+ */
825
+ int sqlite_rekey(
826
+ sqlite *db, /* Database to be rekeyed */
827
+ const void *pKey, int nKey /* The new key */
828
+ );
829
+
830
+ /*
831
+ ** Encode a binary buffer "in" of size n bytes so that it contains
832
+ ** no instances of characters '\'' or '\000'. The output is
833
+ ** null-terminated and can be used as a string value in an INSERT
834
+ ** or UPDATE statement. Use sqlite_decode_binary() to convert the
835
+ ** string back into its original binary.
836
+ **
837
+ ** The result is written into a preallocated output buffer "out".
838
+ ** "out" must be able to hold at least 2 +(257*n)/254 bytes.
839
+ ** In other words, the output will be expanded by as much as 3
840
+ ** bytes for every 254 bytes of input plus 2 bytes of fixed overhead.
841
+ ** (This is approximately 2 + 1.0118*n or about a 1.2% size increase.)
842
+ **
843
+ ** The return value is the number of characters in the encoded
844
+ ** string, excluding the "\000" terminator.
845
+ **
846
+ ** If out==NULL then no output is generated but the routine still returns
847
+ ** the number of characters that would have been generated if out had
848
+ ** not been NULL.
849
+ */
850
+ int sqlite_encode_binary(const unsigned char *in, int n, unsigned char *out);
851
+
852
+ /*
853
+ ** Decode the string "in" into binary data and write it into "out".
854
+ ** This routine reverses the encoding created by sqlite_encode_binary().
855
+ ** The output will always be a few bytes less than the input. The number
856
+ ** of bytes of output is returned. If the input is not a well-formed
857
+ ** encoding, -1 is returned.
858
+ **
859
+ ** The "in" and "out" parameters may point to the same buffer in order
860
+ ** to decode a string in place.
861
+ */
862
+ int sqlite_decode_binary(const unsigned char *in, unsigned char *out);
863
+
864
+ #ifdef __cplusplus
865
+ } /* End of the 'extern "C"' block */
866
+ #endif
867
+
868
+ #endif /* _SQLITE_H_ */