/php/class.tokyotyrant.html

https://bitbucket.org/thncr/manuals · HTML · 1154 lines · 711 code · 443 blank · 0 comment · 0 complexity · 2a370d1216e8ac240c0d7600793fa0d9 MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  5. <title>The TokyoTyrant class</title>
  6. </head>
  7. <body><div class="manualnavbar" style="text-align: center;">
  8. <div class="prev" style="text-align: left; float: left;"><a href="tokyo-tyrant.examples.html">范例</a></div>
  9. <div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.add.html">TokyoTyrant::add</a></div>
  10. <div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
  11. <div class="home"><a href="index.html">PHP Manual</a></div>
  12. </div><hr /><div id="class.tokyotyrant" class="reference">
  13. <h1 class="title">The TokyoTyrant class</h1>
  14. <div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
  15. <div class="section" id="tokyotyrant.intro">
  16. <h2 class="title">简介</h2>
  17. <p class="para">
  18. The main Tokyo Tyrant class
  19. </p>
  20. </div>
  21. <div class="section" id="tokyotyrant.synopsis">
  22. <h2 class="title">类摘要</h2>
  23. <div class="classsynopsis">
  24. <div class="ooclass"></div>
  25. <div class="classsynopsisinfo">
  26. <span class="ooclass">
  27. <strong class="classname">TokyoTyrant</strong>
  28. </span>
  29. {</div>
  30. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 常量 */</div>
  31. <div class="fieldsynopsis">
  32. <span class="modifier">const</span>
  33. <span class="type">integer</span>
  34. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbdef-port"><var class="varname">RDBDEF_PORT</var></a></var>
  35. <span class="initializer"> = 1978</span>
  36. ;</div>
  37. <div class="fieldsynopsis">
  38. <span class="modifier">const</span>
  39. <span class="type">integer</span>
  40. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-streq"><var class="varname">RDBQC_STREQ</var></a></var>
  41. <span class="initializer"> = 0</span>
  42. ;</div>
  43. <div class="fieldsynopsis">
  44. <span class="modifier">const</span>
  45. <span class="type">integer</span>
  46. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-strinc"><var class="varname">RDBQC_STRINC</var></a></var>
  47. <span class="initializer"> = 1</span>
  48. ;</div>
  49. <div class="fieldsynopsis">
  50. <span class="modifier">const</span>
  51. <span class="type">integer</span>
  52. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-strbw"><var class="varname">RDBQC_STRBW</var></a></var>
  53. <span class="initializer"> = 2</span>
  54. ;</div>
  55. <div class="fieldsynopsis">
  56. <span class="modifier">const</span>
  57. <span class="type">integer</span>
  58. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-strew"><var class="varname">RDBQC_STREW</var></a></var>
  59. <span class="initializer"> = 3</span>
  60. ;</div>
  61. <div class="fieldsynopsis">
  62. <span class="modifier">const</span>
  63. <span class="type">integer</span>
  64. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-strand"><var class="varname">RDBQC_STRAND</var></a></var>
  65. <span class="initializer"> = 4</span>
  66. ;</div>
  67. <div class="fieldsynopsis">
  68. <span class="modifier">const</span>
  69. <span class="type">integer</span>
  70. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-stror"><var class="varname">RDBQC_STROR</var></a></var>
  71. <span class="initializer"> = 5</span>
  72. ;</div>
  73. <div class="fieldsynopsis">
  74. <span class="modifier">const</span>
  75. <span class="type">integer</span>
  76. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-stroreq"><var class="varname">RDBQC_STROREQ</var></a></var>
  77. <span class="initializer"> = 6</span>
  78. ;</div>
  79. <div class="fieldsynopsis">
  80. <span class="modifier">const</span>
  81. <span class="type">integer</span>
  82. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-strrx"><var class="varname">RDBQC_STRRX</var></a></var>
  83. <span class="initializer"> = 7</span>
  84. ;</div>
  85. <div class="fieldsynopsis">
  86. <span class="modifier">const</span>
  87. <span class="type">integer</span>
  88. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numeq"><var class="varname">RDBQC_NUMEQ</var></a></var>
  89. <span class="initializer"> = 8</span>
  90. ;</div>
  91. <div class="fieldsynopsis">
  92. <span class="modifier">const</span>
  93. <span class="type">integer</span>
  94. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numgt"><var class="varname">RDBQC_NUMGT</var></a></var>
  95. <span class="initializer"> = 9</span>
  96. ;</div>
  97. <div class="fieldsynopsis">
  98. <span class="modifier">const</span>
  99. <span class="type">integer</span>
  100. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numge"><var class="varname">RDBQC_NUMGE</var></a></var>
  101. <span class="initializer"> = 10</span>
  102. ;</div>
  103. <div class="fieldsynopsis">
  104. <span class="modifier">const</span>
  105. <span class="type">integer</span>
  106. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numlt"><var class="varname">RDBQC_NUMLT</var></a></var>
  107. <span class="initializer"> = 11</span>
  108. ;</div>
  109. <div class="fieldsynopsis">
  110. <span class="modifier">const</span>
  111. <span class="type">integer</span>
  112. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numle"><var class="varname">RDBQC_NUMLE</var></a></var>
  113. <span class="initializer"> = 12</span>
  114. ;</div>
  115. <div class="fieldsynopsis">
  116. <span class="modifier">const</span>
  117. <span class="type">integer</span>
  118. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numbt"><var class="varname">RDBQC_NUMBT</var></a></var>
  119. <span class="initializer"> = 13</span>
  120. ;</div>
  121. <div class="fieldsynopsis">
  122. <span class="modifier">const</span>
  123. <span class="type">integer</span>
  124. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-numoreq"><var class="varname">RDBQC_NUMOREQ</var></a></var>
  125. <span class="initializer"> = 14</span>
  126. ;</div>
  127. <div class="fieldsynopsis">
  128. <span class="modifier">const</span>
  129. <span class="type">integer</span>
  130. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-negate"><var class="varname">RDBQC_NEGATE</var></a></var>
  131. <span class="initializer"> = 16777216</span>
  132. ;</div>
  133. <div class="fieldsynopsis">
  134. <span class="modifier">const</span>
  135. <span class="type">integer</span>
  136. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqc-noidx"><var class="varname">RDBQC_NOIDX</var></a></var>
  137. <span class="initializer"> = 33554432</span>
  138. ;</div>
  139. <div class="fieldsynopsis">
  140. <span class="modifier">const</span>
  141. <span class="type">integer</span>
  142. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqo-strasc"><var class="varname">RDBQO_STRASC</var></a></var>
  143. <span class="initializer"> = 0</span>
  144. ;</div>
  145. <div class="fieldsynopsis">
  146. <span class="modifier">const</span>
  147. <span class="type">integer</span>
  148. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqo-strdesc"><var class="varname">RDBQO_STRDESC</var></a></var>
  149. <span class="initializer"> = 1</span>
  150. ;</div>
  151. <div class="fieldsynopsis">
  152. <span class="modifier">const</span>
  153. <span class="type">integer</span>
  154. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqo-numasc"><var class="varname">RDBQO_NUMASC</var></a></var>
  155. <span class="initializer"> = 2</span>
  156. ;</div>
  157. <div class="fieldsynopsis">
  158. <span class="modifier">const</span>
  159. <span class="type">integer</span>
  160. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqo-numdesc"><var class="varname">RDBQO_NUMDESC</var></a></var>
  161. <span class="initializer"> = 3</span>
  162. ;</div>
  163. <div class="fieldsynopsis">
  164. <span class="modifier">const</span>
  165. <span class="type">integer</span>
  166. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-lexical"><var class="varname">RDBIT_LEXICAL</var></a></var>
  167. <span class="initializer"> = 0</span>
  168. ;</div>
  169. <div class="fieldsynopsis">
  170. <span class="modifier">const</span>
  171. <span class="type">integer</span>
  172. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-decimal"><var class="varname">RDBIT_DECIMAL</var></a></var>
  173. <span class="initializer"> = 1</span>
  174. ;</div>
  175. <div class="fieldsynopsis">
  176. <span class="modifier">const</span>
  177. <span class="type">integer</span>
  178. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-token"><var class="varname">RDBIT_TOKEN</var></a></var>
  179. <span class="initializer"> = 2</span>
  180. ;</div>
  181. <div class="fieldsynopsis">
  182. <span class="modifier">const</span>
  183. <span class="type">integer</span>
  184. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-qgram"><var class="varname">RDBIT_QGRAM</var></a></var>
  185. <span class="initializer"> = 3</span>
  186. ;</div>
  187. <div class="fieldsynopsis">
  188. <span class="modifier">const</span>
  189. <span class="type">integer</span>
  190. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-opt"><var class="varname">RDBIT_OPT</var></a></var>
  191. <span class="initializer"> = 9998</span>
  192. ;</div>
  193. <div class="fieldsynopsis">
  194. <span class="modifier">const</span>
  195. <span class="type">integer</span>
  196. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-void"><var class="varname">RDBIT_VOID</var></a></var>
  197. <span class="initializer"> = 9999</span>
  198. ;</div>
  199. <div class="fieldsynopsis">
  200. <span class="modifier">const</span>
  201. <span class="type">integer</span>
  202. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbit-keep"><var class="varname">RDBIT_KEEP</var></a></var>
  203. <span class="initializer"> = 16777216</span>
  204. ;</div>
  205. <div class="fieldsynopsis">
  206. <span class="modifier">const</span>
  207. <span class="type">integer</span>
  208. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqcfts-ph"><var class="varname">RDBQCFTS_PH</var></a></var>
  209. <span class="initializer"> = 15</span>
  210. ;</div>
  211. <div class="fieldsynopsis">
  212. <span class="modifier">const</span>
  213. <span class="type">integer</span>
  214. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqcfts-and"><var class="varname">RDBQCFTS_AND</var></a></var>
  215. <span class="initializer"> = 16</span>
  216. ;</div>
  217. <div class="fieldsynopsis">
  218. <span class="modifier">const</span>
  219. <span class="type">integer</span>
  220. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqcfts-or"><var class="varname">RDBQCFTS_OR</var></a></var>
  221. <span class="initializer"> = 17</span>
  222. ;</div>
  223. <div class="fieldsynopsis">
  224. <span class="modifier">const</span>
  225. <span class="type">integer</span>
  226. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbqcfts-ex"><var class="varname">RDBQCFTS_EX</var></a></var>
  227. <span class="initializer"> = 18</span>
  228. ;</div>
  229. <div class="fieldsynopsis">
  230. <span class="modifier">const</span>
  231. <span class="type">integer</span>
  232. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbxolck-rec"><var class="varname">RDBXO_LCKREC</var></a></var>
  233. <span class="initializer"> = 1</span>
  234. ;</div>
  235. <div class="fieldsynopsis">
  236. <span class="modifier">const</span>
  237. <span class="type">integer</span>
  238. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbxolck-glb"><var class="varname">RDBXOLCK_GLB</var></a></var>
  239. <span class="initializer"> = 2</span>
  240. ;</div>
  241. <div class="fieldsynopsis">
  242. <span class="modifier">const</span>
  243. <span class="type">integer</span>
  244. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbrec-int"><var class="varname">RDBREC_INT</var></a></var>
  245. <span class="initializer"> = 1</span>
  246. ;</div>
  247. <div class="fieldsynopsis">
  248. <span class="modifier">const</span>
  249. <span class="type">integer</span>
  250. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbrec-dbl"><var class="varname">RDBREC_DBL</var></a></var>
  251. <span class="initializer"> = 2</span>
  252. ;</div>
  253. <div class="fieldsynopsis">
  254. <span class="modifier">const</span>
  255. <span class="type">integer</span>
  256. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbms-union"><var class="varname">RDBMS_UNION</var></a></var>
  257. <span class="initializer"> = 0</span>
  258. ;</div>
  259. <div class="fieldsynopsis">
  260. <span class="modifier">const</span>
  261. <span class="type">integer</span>
  262. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbms-isect"><var class="varname">RDBMS_ISECT</var></a></var>
  263. <span class="initializer"> = 1</span>
  264. ;</div>
  265. <div class="fieldsynopsis">
  266. <span class="modifier">const</span>
  267. <span class="type">integer</span>
  268. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbms-diff"><var class="varname">RDBMS_DIFF</var></a></var>
  269. <span class="initializer"> = 2</span>
  270. ;</div>
  271. <div class="fieldsynopsis">
  272. <span class="modifier">const</span>
  273. <span class="type">integer</span>
  274. <var class="fieldsynopsis_varname"><a href="class.tokyotyrant.html#tokyotyrant.constants.rdbt-recon"><var class="varname">RDBT_RECON</var></a></var>
  275. <span class="initializer"> = 1</span>
  276. ;</div>
  277. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
  278. <div class="methodsynopsis dc-description">
  279. <span class="modifier">public</span> <span class="type">number</span> <span class="methodname"><a href="tokyotyrant.add.html" class="methodname">add</a></span>
  280. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
  281. , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$increment</code></span>
  282. [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = 0</span></span>
  283. ] )</div>
  284. <div class="methodsynopsis dc-description">
  285. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.connect.html" class="methodname">connect</a></span>
  286. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
  287. [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = TokyoTyrant::RDBDEF_PORT</span></span>
  288. [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
  289. ]] )</div>
  290. <div class="methodsynopsis dc-description">
  291. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.connecturi.html" class="methodname">connectUri</a></span>
  292. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code></span>
  293. )</div>
  294. <div class="methodsynopsis dc-description">
  295. <span class="modifier">public</span> <span class="methodname"><a href="tokyotyrant.construct.html" class="methodname">__construct</a></span>
  296. ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
  297. [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = TokyoTyrant::RDBDEF_PORT</span></span>
  298. [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
  299. ]]] )</div>
  300. <div class="methodsynopsis dc-description">
  301. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.copy.html" class="methodname">copy</a></span>
  302. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
  303. )</div>
  304. <div class="methodsynopsis dc-description">
  305. <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="tokyotyrant.ext.html" class="methodname">ext</a></span>
  306. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  307. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
  308. , <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
  309. , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  310. )</div>
  311. <div class="methodsynopsis dc-description">
  312. <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrant.fwmkeys.html" class="methodname">fwmKeys</a></span>
  313. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span>
  314. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_recs</code></span>
  315. )</div>
  316. <div class="methodsynopsis dc-description">
  317. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.get.html" class="methodname">get</a></span>
  318. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  319. )</div>
  320. <div class="methodsynopsis dc-description">
  321. <span class="modifier">public</span> <span class="type">TokyoTyrantIterator</span> <span class="methodname"><a href="tokyotyrant.getiterator.html" class="methodname">getIterator</a></span>
  322. ( <span class="methodparam">void</span>
  323. )</div>
  324. <div class="methodsynopsis dc-description">
  325. <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyrant.num.html" class="methodname">num</a></span>
  326. ( <span class="methodparam">void</span>
  327. )</div>
  328. <div class="methodsynopsis dc-description">
  329. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.out.html" class="methodname">out</a></span>
  330. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  331. )</div>
  332. <div class="methodsynopsis dc-description">
  333. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.put.html" class="methodname">put</a></span>
  334. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  335. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code><span class="initializer"> = NULL</span></span>
  336. ] )</div>
  337. <div class="methodsynopsis dc-description">
  338. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putcat.html" class="methodname">putCat</a></span>
  339. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  340. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  341. ] )</div>
  342. <div class="methodsynopsis dc-description">
  343. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putkeep.html" class="methodname">putKeep</a></span>
  344. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  345. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  346. ] )</div>
  347. <div class="methodsynopsis dc-description">
  348. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putnr.html" class="methodname">putNr</a></span>
  349. ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
  350. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code><span class="initializer"> = NULL</span></span>
  351. ] )</div>
  352. <div class="methodsynopsis dc-description">
  353. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.putshl.html" class="methodname">putShl</a></span>
  354. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
  355. , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  356. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
  357. )</div>
  358. <div class="methodsynopsis dc-description">
  359. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.restore.html" class="methodname">restore</a></span>
  360. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$log_dir</code></span>
  361. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$timestamp</code></span>
  362. [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$check_consistency</code><span class="initializer"> = true</span></span>
  363. ] )</div>
  364. <div class="methodsynopsis dc-description">
  365. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.setmaster.html" class="methodname">setMaster</a></span>
  366. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
  367. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
  368. , <span class="methodparam"><span class="type">int</span> <code class="parameter">$timestamp</code></span>
  369. [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$check_consistency</code><span class="initializer"> = true</span></span>
  370. ] )</div>
  371. <div class="methodsynopsis dc-description">
  372. <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyrant.size.html" class="methodname">size</a></span>
  373. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
  374. )</div>
  375. <div class="methodsynopsis dc-description">
  376. <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrant.stat.html" class="methodname">stat</a></span>
  377. ( <span class="methodparam">void</span>
  378. )</div>
  379. <div class="methodsynopsis dc-description">
  380. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.sync.html" class="methodname">sync</a></span>
  381. ( <span class="methodparam">void</span>
  382. )</div>
  383. <div class="methodsynopsis dc-description">
  384. <span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.tune.html" class="methodname">tune</a></span>
  385. ( <span class="methodparam"><span class="type">float</span> <code class="parameter">$timeout</code></span>
  386. [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = TokyoTyrant::RDBT_RECON</span></span>
  387. ] )</div>
  388. <div class="methodsynopsis dc-description">
  389. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.vanish.html" class="methodname">vanish</a></span>
  390. ( <span class="methodparam">void</span>
  391. )</div>
  392. }</div>
  393. </div>
  394. <div class="section" id="tokyotyrant.constants">
  395. <h2 class="title">预定义常量</h2>
  396. <div class="section" id="tokyotyrant.constants.types">
  397. <h2 class="title">TokyoTyrant Constants</h2>
  398. <dl>
  399. <dt id="tokyotyrant.constants.rdbdef-port">
  400. <span class="term"><strong><code>TokyoTyrant::RDBDEF_PORT</code></strong></span>
  401. <dd>
  402. <p class="para">The default port of the Tokyo Tyrant database</p>
  403. </dd>
  404. </dt>
  405. <dt id="tokyotyrant.constants.rdbqc-streq">
  406. <span class="term"><strong><code>TokyoTyrant::RDBQC_STREQ</code></strong></span>
  407. <dd>
  408. <p class="para">string is equal to</p>
  409. </dd>
  410. </dt>
  411. <dt id="tokyotyrant.constants.rdbqc-strinc">
  412. <span class="term"><strong><code>TokyoTyrant::RDBQC_STRINC</code></strong></span>
  413. <dd>
  414. <p class="para">string is included in</p>
  415. </dd>
  416. </dt>
  417. <dt id="tokyotyrant.constants.rdbqc-strbw">
  418. <span class="term"><strong><code>TokyoTyrant::RDBQC_STRBW</code></strong></span>
  419. <dd>
  420. <p class="para">string begins with</p>
  421. </dd>
  422. </dt>
  423. <dt id="tokyotyrant.constants.rdbqc-strew">
  424. <span class="term"><strong><code>TokyoTyrant::RDBQC_STREW</code></strong></span>
  425. <dd>
  426. <p class="para">string ends with</p>
  427. </dd>
  428. </dt>
  429. <dt id="tokyotyrant.constants.rdbqc-strand">
  430. <span class="term"><strong><code>TokyoTyrant::RDBQC_STRAND</code></strong></span>
  431. <dd>
  432. <p class="para">string includes all tokens in</p>
  433. </dd>
  434. </dt>
  435. <dt id="tokyotyrant.constants.rdbqc-stror">
  436. <span class="term"><strong><code>TokyoTyrant::RDBQC_STROR</code></strong></span>
  437. <dd>
  438. <p class="para">string includes at least one token in</p>
  439. </dd>
  440. </dt>
  441. <dt id="tokyotyrant.constants.rdbqc-stroreq">
  442. <span class="term"><strong><code>TokyoTyrant::RDBQC_STROREQ</code></strong></span>
  443. <dd>
  444. <p class="para">string is equal to at least one token in</p>
  445. </dd>
  446. </dt>
  447. <dt id="tokyotyrant.constants.rdbqc-strrx">
  448. <span class="term"><strong><code>TokyoTyrant::RDBQC_STRRX</code></strong></span>
  449. <dd>
  450. <p class="para">string matches regular expressions of</p>
  451. </dd>
  452. </dt>
  453. <dt id="tokyotyrant.constants.rdbqc-numeq">
  454. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMEQ</code></strong></span>
  455. <dd>
  456. <p class="para">number is equal to</p>
  457. </dd>
  458. </dt>
  459. <dt id="tokyotyrant.constants.rdbqc-numgt">
  460. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMGT</code></strong></span>
  461. <dd>
  462. <p class="para">number is greater than</p>
  463. </dd>
  464. </dt>
  465. <dt id="tokyotyrant.constants.rdbqc-numge">
  466. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMGE</code></strong></span>
  467. <dd>
  468. <p class="para">number is greater than or equal to</p>
  469. </dd>
  470. </dt>
  471. <dt id="tokyotyrant.constants.rdbqc-numlt">
  472. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMLT</code></strong></span>
  473. <dd>
  474. <p class="para">number is less than</p>
  475. </dd>
  476. </dt>
  477. <dt id="tokyotyrant.constants.rdbqc-numle">
  478. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMLE</code></strong></span>
  479. <dd>
  480. <p class="para">number is less than or equal to</p>
  481. </dd>
  482. </dt>
  483. <dt id="tokyotyrant.constants.rdbqc-numbt">
  484. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMBT</code></strong></span>
  485. <dd>
  486. <p class="para">number is between two tokens of</p>
  487. </dd>
  488. </dt>
  489. <dt id="tokyotyrant.constants.rdbqc-numoreq">
  490. <span class="term"><strong><code>TokyoTyrant::RDBQC_NUMOREQ</code></strong></span>
  491. <dd>
  492. <p class="para">number is equal to at least one token in</p>
  493. </dd>
  494. </dt>
  495. <dt id="tokyotyrant.constants.rdbqc-negate">
  496. <span class="term"><strong><code>TokyoTyrant::RDBQC_NEGATE</code></strong></span>
  497. <dd>
  498. <p class="para">negation flag</p>
  499. </dd>
  500. </dt>
  501. <dt id="tokyotyrant.constants.rdbqc-noidx">
  502. <span class="term"><strong><code>TokyoTyrant::RDBQC_NOIDX</code></strong></span>
  503. <dd>
  504. <p class="para">no index flag</p>
  505. </dd>
  506. </dt>
  507. <dt id="tokyotyrant.constants.rdbqo-strasc">
  508. <span class="term"><strong><code>TokyoTyrant::RDBQO_STRASC</code></strong></span>
  509. <dd>
  510. <p class="para">string ascending</p>
  511. </dd>
  512. </dt>
  513. <dt id="tokyotyrant.constants.rdbqo-strdesc">
  514. <span class="term"><strong><code>TokyoTyrant::RDBQO_STRDESC</code></strong></span>
  515. <dd>
  516. <p class="para">string descending</p>
  517. </dd>
  518. </dt>
  519. <dt id="tokyotyrant.constants.rdbqo-numasc">
  520. <span class="term"><strong><code>TokyoTyrant::RDBQO_NUMASC</code></strong></span>
  521. <dd>
  522. <p class="para">number ascending</p>
  523. </dd>
  524. </dt>
  525. <dt id="tokyotyrant.constants.rdbqo-numdesc">
  526. <span class="term"><strong><code>TokyoTyrant::RDBQO_NUMDESC</code></strong></span>
  527. <dd>
  528. <p class="para">number descending</p>
  529. </dd>
  530. </dt>
  531. <dt id="tokyotyrant.constants.rdbit-lexical">
  532. <span class="term"><strong><code>TokyoTyrant::RDBIT_LEXICAL</code></strong></span>
  533. <dd>
  534. <p class="para">lexical string</p>
  535. </dd>
  536. </dt>
  537. <dt id="tokyotyrant.constants.rdbit-decimal">
  538. <span class="term"><strong><code>TokyoTyrant::RDBIT_DECIMAL</code></strong></span>
  539. <dd>
  540. <p class="para">decimal string</p>
  541. </dd>
  542. </dt>
  543. <dt id="tokyotyrant.constants.rdbit-token">
  544. <span class="term"><strong><code>TokyoTyrant::RDBIT_TOKEN</code></strong></span>
  545. <dd>
  546. <p class="para">token inverted index (Tokyo Tyrant &gt;= 1.1.29)</p>
  547. </dd>
  548. </dt>
  549. <dt id="tokyotyrant.constants.rdbit-qgram">
  550. <span class="term"><strong><code>TokyoTyrant::RDBIT_QGRAM</code></strong></span>
  551. <dd>
  552. <p class="para">QGRAM inverted index (Tokyo Tyrant &gt;= 1.1.29)</p>
  553. </dd>
  554. </dt>
  555. <dt id="tokyotyrant.constants.rdbit-opt">
  556. <span class="term"><strong><code>TokyoTyrant::RDBIT_OPT</code></strong></span>
  557. <dd>
  558. <p class="para">optimize</p>
  559. </dd>
  560. </dt>
  561. <dt id="tokyotyrant.constants.rdbit-void">
  562. <span class="term"><strong><code>TokyoTyrant::RDBIT_VOID</code></strong></span>
  563. <dd>
  564. <p class="para">void</p>
  565. </dd>
  566. </dt>
  567. <dt id="tokyotyrant.constants.rdbit-keep">
  568. <span class="term"><strong><code>TokyoTyrant::RDBIT_KEEP</code></strong></span>
  569. <dd>
  570. <p class="para">keep existing index</p>
  571. </dd>
  572. </dt>
  573. <dt id="tokyotyrant.constants.rdbqcfts-ph">
  574. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_PH</code></strong></span>
  575. <dd>
  576. <p class="para">full-text search with the phrase of (Tokyo Tyrant &gt;= 1.1.29)</p>
  577. </dd>
  578. </dt>
  579. <dt id="tokyotyrant.constants.rdbqcfts-and">
  580. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_AND</code></strong></span>
  581. <dd>
  582. <p class="para">full-text search with all tokens in (Tokyo Tyrant &gt;= 1.1.29)</p>
  583. </dd>
  584. </dt>
  585. <dt id="tokyotyrant.constants.rdbqcfts-or">
  586. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_OR</code></strong></span>
  587. <dd>
  588. <p class="para">full-text search with at least one token in (Tokyo Tyrant &gt;= 1.1.29)</p>
  589. </dd>
  590. </dt>
  591. <dt id="tokyotyrant.constants.rdbqcfts-ex">
  592. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_EX</code></strong></span>
  593. <dd>
  594. <p class="para">full-text search with the compound expression of (Tokyo Tyrant &gt;= 1.1.29)</p>
  595. </dd>
  596. </dt>
  597. <dt id="tokyotyrant.constants.rdbms-union">
  598. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_AND</code></strong></span>
  599. <dd>
  600. <p class="para">Metasearch union between records (Tokyo Tyrant &gt;= 1.1.33)</p>
  601. </dd>
  602. </dt>
  603. <dt id="tokyotyrant.constants.rdbms-isect">
  604. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_OR</code></strong></span>
  605. <dd>
  606. <p class="para">Metasearch intersection between records (Tokyo Tyrant &gt;= 1.1.33)</p>
  607. </dd>
  608. </dt>
  609. <dt id="tokyotyrant.constants.rdbms-diff">
  610. <span class="term"><strong><code>TokyoTyrant::RDBQCFTS_EX</code></strong></span>
  611. <dd>
  612. <p class="para">Metasearch difference between records (Tokyo Tyrant &gt;= 1.1.33)</p>
  613. </dd>
  614. </dt>
  615. <dt id="tokyotyrant.constants.rdbt-recon">
  616. <span class="term"><strong><code>TokyoTyrant::RDBT_RECON</code></strong></span>
  617. <dd>
  618. <p class="para">Whether to reconnect on connection failure.
  619. It is recommended to have this parameter on for persistent connections</p>
  620. </dd>
  621. </dt>
  622. <dt id="tokyotyrant.constants.rdbxolck-rec">
  623. <span class="term"><strong><code>TokyoTyrant::RDBXOLCK_REC</code></strong></span>
  624. <dd>
  625. <p class="para">record locking</p>
  626. </dd>
  627. </dt>
  628. <dt id="tokyotyrant.constants.rdbxolck-glb">
  629. <span class="term"><strong><code>TokyoTyrant::RDBXOLCK_GLB</code></strong></span>
  630. <dd>
  631. <p class="para">global locking</p>
  632. </dd>
  633. </dt>
  634. <dt id="tokyotyrant.constants.rdbrec-int">
  635. <span class="term"><strong><code>TokyoTyrant::RDBREC_INT</code></strong></span>
  636. <dd>
  637. <p class="para">record type int</p>
  638. </dd>
  639. </dt>
  640. <dt id="tokyotyrant.constants.rdbrec-dbl">
  641. <span class="term"><strong><code>TokyoTyrant::RDBREC_DBL</code></strong></span>
  642. <dd>
  643. <p class="para">record type float (double)</p>
  644. </dd>
  645. </dt>
  646. <dt id="tokyotyrant.constants.tte-success">
  647. <span class="term"><strong><code>TokyoTyrant::TTE_SUCCESS</code></strong></span>
  648. <dd>
  649. <p class="para">success</p>
  650. </dd>
  651. </dt>
  652. <dt id="tokyotyrant.constants.tte-invalid">
  653. <span class="term"><strong><code>TokyoTyrant::TTE_INVALID</code></strong></span>
  654. <dd>
  655. <p class="para">invalid operation</p>
  656. </dd>
  657. </dt>
  658. <dt id="tokyotyrant.constants.tte-nohost">
  659. <span class="term"><strong><code>TokyoTyrant::TTE_NOHOST</code></strong></span>
  660. <dd>
  661. <p class="para">host not found</p>
  662. </dd>
  663. </dt>
  664. <dt id="tokyotyrant.constants.tte-refused">
  665. <span class="term"><strong><code>TokyoTyrant::TTE_REFUSED</code></strong></span>
  666. <dd>
  667. <p class="para">connection refused</p>
  668. </dd>
  669. </dt>
  670. <dt id="tokyotyrant.constants.tte-send">
  671. <span class="term"><strong><code>TokyoTyrant::TTE_SEND</code></strong></span>
  672. <dd>
  673. <p class="para">send error</p>
  674. </dd>
  675. </dt>
  676. <dt id="tokyotyrant.constants.tte-recv">
  677. <span class="term"><strong><code>TokyoTyrant::TTE_RECV</code></strong></span>
  678. <dd>
  679. <p class="para">recv error</p>
  680. </dd>
  681. </dt>
  682. <dt id="tokyotyrant.constants.tte-keep">
  683. <span class="term"><strong><code>TokyoTyrant::TTE_KEEP</code></strong></span>
  684. <dd>
  685. <p class="para">record exist</p>
  686. </dd>
  687. </dt>
  688. <dt id="tokyotyrant.constants.tte-norec">
  689. <span class="term"><strong><code>TokyoTyrant::TTE_NOREC</code></strong></span>
  690. <dd>
  691. <p class="para">no record found</p>
  692. </dd>
  693. </dt>
  694. <dt id="tokyotyrant.constants.tte-misc">
  695. <span class="term"><strong><code>TokyoTyrant::TTE_MISC</code></strong></span>
  696. <dd>
  697. <p class="para">miscellaneous error</p>
  698. </dd>
  699. </dt>
  700. </dl>
  701. </div>
  702. </div>
  703. </div>
  704. <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="tokyotyrant.add.html">TokyoTyrant::add</a> Adds to a numeric key</li><li><a href="tokyotyrant.connect.html">TokyoTyrant::connect</a> Connect to a database</li><li><a href="tokyotyrant.connecturi.html">TokyoTyrant::connectUri</a> Connects to a database</li><li><a href="tokyotyrant.construct.html">TokyoTyrant::__construct</a> Construct a new TokyoTyrant object</li><li><a href="tokyotyrant.copy.html">TokyoTyrant::copy</a> Copies the database</li><li><a href="tokyotyrant.ext.html">TokyoTyrant::ext</a> Execute a remote script</li><li><a href="tokyotyrant.fwmkeys.html">TokyoTyrant::fwmKeys</a> Returns the forward matching keys</li><li><a href="tokyotyrant.get.html">TokyoTyrant::get</a> The get purpose</li><li><a href="tokyotyrant.getiterator.html">TokyoTyrant::getIterator</a> Get an iterator</li><li><a href="tokyotyrant.num.html">TokyoTyrant::num</a> Number of records in the database</li><li><a href="tokyotyrant.out.html">TokyoTyrant::out</a> Removes records</li><li><a href="tokyotyrant.put.html">TokyoTyrant::put</a> Puts values</li><li><a href="tokyotyrant.putcat.html">TokyoTyrant::putCat</a> Concatenates to a record</li><li><a href="tokyotyrant.putkeep.html">TokyoTyrant::putKeep</a> Puts a record</li><li><a href="tokyotyrant.putnr.html">TokyoTyrant::putNr</a> Puts value</li><li><a href="tokyotyrant.putshl.html">TokyoTyrant::putShl</a> Concatenates to a record</li><li><a href="tokyotyrant.restore.html">TokyoTyrant::restore</a> Restore the database</li><li><a href="tokyotyrant.setmaster.html">TokyoTyrant::setMaster</a> Set the replication master</li><li><a href="tokyotyrant.size.html">TokyoTyrant::size</a> Returns the size of the value</li><li><a href="tokyotyrant.stat.html">TokyoTyrant::stat</a> Get statistics</li><li><a href="tokyotyrant.sync.html">TokyoTyrant::sync</a> Synchronize the database</li><li><a href="tokyotyrant.tune.html">TokyoTyrant::tune</a> Tunes connection values</li><li><a href="tokyotyrant.vanish.html">TokyoTyrant::vanish</a> Empties the database</li></ul>
  705. </div>
  706. <hr /><div class="manualnavbar" style="text-align: center;">
  707. <div class="prev" style="text-align: left; float: left;"><a href="tokyo-tyrant.examples.html">范例</a></div>
  708. <div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.add.html">TokyoTyrant::add</a></div>
  709. <div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
  710. <div class="home"><a href="index.html">PHP Manual</a></div>
  711. </div></body></html>