Zend_Cache-Backends.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15207 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.cache.backends">
  5. <title>Zend_Cache Backends</title>
  6. <para>
  7. Es gibt zwei Arten von Backends: Standard und erweiterte. Natürlich bieten erweiterte Backends
  8. mehr Features.
  9. </para>
  10. <sect2 id="zend.cache.backends.file">
  11. <title>Zend_Cache_Backend_File</title>
  12. <para>
  13. Dieses (erweiterte) Backend speichert Cache Datensätze in Dateien (in einem gewählten Verzeichnis).
  14. </para>
  15. <para>
  16. Mögliche Optionen sind :
  17. </para>
  18. <table id="zend.cache.backends.file.table">
  19. <title>File Backend Optionen</title>
  20. <tgroup cols="4">
  21. <thead>
  22. <row>
  23. <entry>Option</entry>
  24. <entry>Daten Typ</entry>
  25. <entry>Standardwert</entry>
  26. <entry>Beschreibung</entry>
  27. </row>
  28. </thead>
  29. <tbody>
  30. <row>
  31. <entry><code>cache_dir</code></entry>
  32. <entry><code>string</code></entry>
  33. <entry><code>'/tmp/'</code></entry>
  34. <entry>
  35. Verzeichnis, in dem die Cache Dateien gespeichert werden
  36. </entry>
  37. </row>
  38. <row>
  39. <entry><code>file_locking</code></entry>
  40. <entry><code>boolean</code></entry>
  41. <entry><code>true</code></entry>
  42. <entry>
  43. Ein- / Ausschalten von file_locking: kann die Beschädigung des Caches
  44. unter schlechten Bedingungen verhindern, aber es hilft nicht bei
  45. Multithreaded Webservern oder bei NFS Filesystemen...
  46. </entry>
  47. </row>
  48. <row>
  49. <entry><code>read_control</code></entry>
  50. <entry><code>boolean</code></entry>
  51. <entry><code>true</code></entry>
  52. <entry>
  53. Ein- / Ausschalten von read_control: eingeschaltet wird ein Kontrollschlüssel
  54. im Cache File inkludiert und dieser Schlüssel wird mit dem Schlüssel
  55. verglichen, der nach dem Lesen berechnet wird.
  56. </entry>
  57. </row>
  58. <row>
  59. <entry><code>read_control_type</code></entry>
  60. <entry><code>string</code></entry>
  61. <entry><code>'crc32'</code></entry>
  62. <entry>
  63. Typ der Schreibkontrolle (nur wenn read_control eingeschaltet ist).
  64. Mögliche Werte sind :
  65. 'md5' (bestes, aber am Langsamsten), 'crc32' (etwas weniger sicher, aber schneller,
  66. beste Wahl), 'adler32' (neue Wahl, schneller als crc32), 'strlen' um nur die Länge
  67. zu testen (schnellstes).
  68. </entry>
  69. </row>
  70. <row>
  71. <entry><code>hashed_directory_level</code></entry>
  72. <entry><code>int</code></entry>
  73. <entry><code>0</code></entry>
  74. <entry>
  75. Level der gehashten Verzeichnis Struktur: 0 heißt "keine gehashte
  76. Verzeichnis Strutur, 1 heißt "ein Level von Verzeichnissen", 2 heißt
  77. "zwei Levels"...
  78. Diese Option kann den Cache nur dann schneller machen, wenn viele Tausende
  79. Cache Dateien verwendet werden. Nur spezielle Messungen können helfen, den perfekten
  80. Wert zu finden. Möglicherweise ist 1 oder 2 ein guter Anfang.
  81. </entry>
  82. </row>
  83. <row>
  84. <entry><code>hashed_directory_umask</code></entry>
  85. <entry><code>int</code></entry>
  86. <entry><code>0700</code></entry>
  87. <entry>
  88. Umask für die gehashte Verzeichnis Struktur
  89. </entry>
  90. </row>
  91. <row>
  92. <entry><code>file_name_prefix</code></entry>
  93. <entry><code>string</code></entry>
  94. <entry><code>'zend_cache'</code></entry>
  95. <entry>
  96. Präfix für Cache Dateien; man muss mit dieser Option sehr vorsichtig
  97. umgehen, weil ein zu generischer Wert in einem System Cache Verzeichnis
  98. (wie /tmp) kann beim Löschen des Caches zu großen Problemen führen.
  99. </entry>
  100. </row>
  101. <row>
  102. <entry><code>cache_file_umask</code></entry>
  103. <entry><code>int</code></entry>
  104. <entry><code>0700</code></entry>
  105. <entry>
  106. umask nach Cache Dateien
  107. </entry>
  108. </row>
  109. <row>
  110. <entry><code>metatadatas_array_max_size</code></entry>
  111. <entry><code>int</code></entry>
  112. <entry><code>100</code></entry>
  113. <entry>
  114. Interne maximale Größe für das Metadaten Array (dieser Wert sollte nicht
  115. geändert werden außer man weiß was man macht)
  116. </entry>
  117. </row>
  118. </tbody>
  119. </tgroup>
  120. </table>
  121. </sect2>
  122. <sect2 id="zend.cache.backends.sqlite">
  123. <title>Zend_Cache_Backend_Sqlite</title>
  124. <para>
  125. Dieses (erweiterte) Backend speichert die Cache Datensätze in einer SQLite Datenbank.
  126. </para>
  127. <para>
  128. Mögliche Optionen sind :
  129. </para>
  130. <table id="zend.cache.backends.sqlite.table">
  131. <title>Sqlite Backend Optionen</title>
  132. <tgroup cols="4">
  133. <thead>
  134. <row>
  135. <entry>Option</entry>
  136. <entry>Daten Typ</entry>
  137. <entry>Standardwert</entry>
  138. <entry>Beschreibung</entry>
  139. </row>
  140. </thead>
  141. <tbody>
  142. <row>
  143. <entry><code>cache_db_complete_path (mandatory)</code></entry>
  144. <entry><code>string</code></entry>
  145. <entry><code>null</code></entry>
  146. <entry>
  147. Der komplette Pfad (inklusive Dateiname) der SQLite Datenbank
  148. </entry>
  149. </row>
  150. <row>
  151. <entry><code>automatic_vacuum_factor</code></entry>
  152. <entry><code>int</code></entry>
  153. <entry><code>10</code></entry>
  154. <entry>
  155. Deaktiviere / stelle den automatischen Vakuumprozess ein.
  156. Der automatische Vakuumprozess defragmentiert die Datenbankdatei (und
  157. verkleinert sie) wenn clean() oder delete() aufgerufen wird:
  158. 0 bedeutet kein automatisches Vakuum;
  159. 1 bedeutet systematisches Vakuum (wenn die delete() or clean() Methoden aufgerufen werden;
  160. x (integer) > 1 => automatisches Vakuum zufällig einmal pro x clean() oder delete() Aufrufe.
  161. </entry>
  162. </row>
  163. </tbody>
  164. </tgroup>
  165. </table>
  166. </sect2>
  167. <sect2 id="zend.cache.backends.memcached">
  168. <title>Zend_Cache_Backend_Memcached</title>
  169. <para>
  170. Dieses (erweiterte) Backend speichert Cache Datensätze in einem Memcached Server. <ulink url="http://www.danga.com/memcached/">memcached</ulink>
  171. ist ein hoch-performantes, verteiltes Speicher Objekt Caching System. Um dieses Backend zu benutzen,
  172. wird ein Memcached Dämon benötigt und <ulink url="http://pecl.php.net/package/memcache">die Memcached PECL Erweiterung</ulink>.
  173. </para>
  174. <para>
  175. Vorsicht: mit diesem Backend werden zur Zeit "Marker" nicht unterstützt genauso wie das
  176. "doNotTestCacheValidity=true" Argument.
  177. </para>
  178. <para>
  179. Mögliche Optionen sind :
  180. </para>
  181. <table id="zend.cache.backends.memcached.table">
  182. <title>Memcached Backend Optionen</title>
  183. <tgroup cols="4">
  184. <thead>
  185. <row>
  186. <entry>Option</entry>
  187. <entry>Daten Typ</entry>
  188. <entry>Standardwert</entry>
  189. <entry>Beschreibung</entry>
  190. </row>
  191. </thead>
  192. <tbody>
  193. <row>
  194. <entry><code>servers</code></entry>
  195. <entry><code>array</code></entry>
  196. <entry>
  197. <code>
  198. array(array('host' => 'localhost','port' => 11211, 'persistent' => true, 'weight' => 1,
  199. 'timeout' => 5, 'retry_interval' => 15, 'status' => true, 'failure_callback' => '' ))
  200. </code>
  201. </entry>
  202. <entry>
  203. Ein Array von Memcached Servern; jeder Memcached Server wird durch ein
  204. assoziatives Array beschrieben :
  205. 'host' => (string) : Der Name des Memcached Servers,
  206. 'port' => (int) : Der Port des Memcached Servers,
  207. 'persistent' => (bool) : Persistente Verbindungen für diesen Memcached Server verwenden oder nicht
  208. 'weight' => (int) : Das Gewicht des Memcached Servers,
  209. 'timeout' => (int) : Das Timeout des Memcached Servers,
  210. 'retry_interval' => (int) : Das Wiederholungsintervall des Memcached Servers,
  211. 'status' => (bool) : Der Status des Memcached Servers,
  212. 'failure_callback' => (callback) : Der failure_callback des Memcached Servers
  213. </entry>
  214. </row>
  215. <row>
  216. <entry><code>compression</code></entry>
  217. <entry><code>boolean</code></entry>
  218. <entry><code>false</code></entry>
  219. <entry>
  220. true wenn on-the-fly Kompression verwendet werden soll
  221. </entry>
  222. </row>
  223. <row>
  224. <entry><code>compatibility</code></entry>
  225. <entry><code>boolean</code></entry>
  226. <entry><code>false</code></entry>
  227. <entry>
  228. true wenn man den Compatibility Modus mit alten Memcache Servern/Erweiterungen
  229. verwenden will
  230. </entry>
  231. </row>
  232. </tbody>
  233. </tgroup>
  234. </table>
  235. </sect2>
  236. <sect2 id="zend.cache.backends.apc">
  237. <title>Zend_Cache_Backend_Apc</title>
  238. <para>
  239. Dieses (erweiterte) Backend speichert Cache Datensätze im Shared Memory durch die
  240. <ulink url="http://pecl.php.net/package/APC">APC</ulink> (Alternativer PHP Cache) Erweiterung
  241. (welche natürlich für die Verwendung dieses Backends benötigt wird).
  242. </para>
  243. <para>
  244. Vorsicht: mit diesem Backend werden "Marker" zur Zeit nicht unterstützt genauso wie das
  245. "doNotTestCacheValidity=true" Argument.
  246. </para>
  247. <para>
  248. Es gibt keine Optionen für dieses Backend.
  249. </para>
  250. </sect2>
  251. <sect2 id="zend.cache.backends.xcache">
  252. <title>Zend_Cache_Backend_Xcache</title>
  253. <para>
  254. Dieses Backend speichert Cache Einträge im Shared Memory durch die
  255. <ulink url="http://xcache.lighttpd.net/">XCache</ulink> Erweiterung (welche natürlich
  256. benötigt wird, damit dieses Backend verwendet werden kann).
  257. </para>
  258. <para>
  259. Achtung: Bei diesem Backend werden "tags" aktuell nicht unterstützt sowie das
  260. "doNotTestCacheValidity=true" Argument.
  261. </para>
  262. <para>
  263. Mögliche Optionen sind:
  264. </para>
  265. <table id="zend.cache.backends.xcache.table">
  266. <title>Xcache backend options</title>
  267. <tgroup cols="4">
  268. <thead>
  269. <row>
  270. <entry>Option</entry>
  271. <entry>Daten Typ</entry>
  272. <entry>Standardwert</entry>
  273. <entry>Beschreibung</entry>
  274. </row>
  275. </thead>
  276. <tbody>
  277. <row>
  278. <entry><code>user</code></entry>
  279. <entry><code>string</code></entry>
  280. <entry><code>null</code></entry>
  281. <entry>
  282. xcache.admin.user, notwendig für die clean() Methode
  283. </entry>
  284. </row>
  285. <row>
  286. <entry><code>password</code></entry>
  287. <entry><code>string</code></entry>
  288. <entry><code>null</code></entry>
  289. <entry>
  290. xcache.admin.pass (in offener Form, nicht MD5), notwendig für die clean() Methode
  291. </entry>
  292. </row>
  293. </tbody>
  294. </tgroup>
  295. </table>
  296. </sect2>
  297. <sect2 id="zend.cache.backends.platform">
  298. <title>Zend_Cache_Backend_ZendPlatform</title>
  299. <para>
  300. Dieses Backend verwendet die Content Caching API des
  301. <ulink url="http://www.zend.com/products/platform">Zend Platform</ulink> Produktes.
  302. Natürlich muss man die Zend Platform installiert haben, um dieses Backend verwenden zu
  303. können.
  304. </para>
  305. <para>
  306. Dieses Backend unterstützt Tags, aber nicht den <code>CLEANING_MODE_NOT_MATCHING_TAG</code>
  307. Löschmodus.
  308. </para>
  309. <para>
  310. Bei Definition dieses Backends muß ein Trennzeichen -- '-', '.', ' ', oder '_'
  311. -- zwischen den Wörtern 'Zend' und 'Platform' definiert sein wenn die
  312. <classname>Zend_Cache::factory()</classname> Methode verwendet wird:
  313. </para>
  314. <programlisting role="php"><![CDATA[
  315. $cache = Zend_Cache::factory('Core', 'Zend Platform');
  316. ]]></programlisting>
  317. <para>
  318. Es gibt keine Optionen für dieses Backend.
  319. </para>
  320. </sect2>
  321. <sect2 id="zend.cache.backends.twolevels">
  322. <title>Zend_Cache_Backend_TwoLevels</title>
  323. <para>
  324. Dieses (erweiterte) Backend ist ein Hybrides. Es speichert Cache Einträge in zwei anderen
  325. Backends: Ein schnelles (aber limitiertes) wie Apc, Memcache... und ein "langsames" wie
  326. File, Sqlite...
  327. </para>
  328. <para>
  329. Dieses Backend verwendet den Priority Parameter (der auf Frontend Level angegeben wird wenn ein
  330. Eintrag gespeichert wird) und den verbleibenden Platz im schnellen Backend um die Verwendung
  331. dieser zwei Backends zu optimieren.
  332. FIXME
  333. </para>
  334. <para>
  335. Vorhandene Optionen sind:
  336. </para>
  337. <table id="zend.cache.backends.twolevels.table">
  338. <title>TwoLevels Backend Optionen</title>
  339. <tgroup cols="4">
  340. <thead>
  341. <row>
  342. <entry>Option</entry>
  343. <entry>Datentyp</entry>
  344. <entry>Standardwert</entry>
  345. <entry>Beschreibung</entry>
  346. </row>
  347. </thead>
  348. <tbody>
  349. <row>
  350. <entry><code>slow_backend</code></entry>
  351. <entry><code>string</code></entry>
  352. <entry><code>File</code></entry>
  353. <entry>
  354. Der "langsame" Backendname
  355. </entry>
  356. </row>
  357. <row>
  358. <entry><code>fast_backend</code></entry>
  359. <entry><code>string</code></entry>
  360. <entry><code>Apc</code></entry>
  361. <entry>
  362. Der "schnelle" Backendname
  363. </entry>
  364. </row>
  365. <row>
  366. <entry><code>slow_backend_options</code></entry>
  367. <entry><code>array</code></entry>
  368. <entry><code>array()</code></entry>
  369. <entry>
  370. Die "langsamen" Backendoptionen
  371. </entry>
  372. </row>
  373. <row>
  374. <entry><code>fast_backend_options</code></entry>
  375. <entry><code>array</code></entry>
  376. <entry><code>array()</code></entry>
  377. <entry>
  378. Die "schnellen" Backendoptionen
  379. </entry>
  380. </row>
  381. <row>
  382. <entry><code>slow_backend_custom_naming</code></entry>
  383. <entry><code>boolean</code></entry>
  384. <entry><code>false</code></entry>
  385. <entry>
  386. Wenn true, wird das slow_backend Argument als kompletter Klassenname verwendet;
  387. wenn false, wird das frontend Argument als Ende des
  388. "Zend_Cache_Backend_[...]" Klassennamens verwendet
  389. </entry>
  390. </row>
  391. <row>
  392. <entry><code>fast_backend_custom_naming</code></entry>
  393. <entry><code>boolean</code></entry>
  394. <entry><code>false</code></entry>
  395. <entry>
  396. Wenn true, wird das fast_backend Argument als kompletter Klassenname verwendet;
  397. wenn false, wird das frontend Argument als Ende des
  398. "Zend_Cache_Backend_[...]" Klassennamens verwendet
  399. </entry>
  400. </row>
  401. <row>
  402. <entry><code>slow_backend_autoload</code></entry>
  403. <entry><code>boolean</code></entry>
  404. <entry><code>false</code></entry>
  405. <entry>
  406. Wenn true, wird kein require_once für das langsame Backend verwendet
  407. (nur für eigene Backends nützlich)
  408. </entry>
  409. </row>
  410. <row>
  411. <entry><code>fast_backend_autoload</code></entry>
  412. <entry><code>boolean</code></entry>
  413. <entry><code>false</code></entry>
  414. <entry>
  415. Wenn true, wird kein require_once für das schnelle Backend verwendet
  416. (nur für eigene Backends nützlich)
  417. </entry>
  418. </row>
  419. <row>
  420. <entry><code>auto_refresh_fast_cache</code></entry>
  421. <entry><code>boolean</code></entry>
  422. <entry><code>true</code></entry>
  423. <entry>
  424. Wenn true, wird der schnelle Cache automatisch refresht wenn ein Cache
  425. Eintrag getroffen wird
  426. </entry>
  427. </row>
  428. <row>
  429. <entry><code>stats_update_factor</code></entry>
  430. <entry><code>integer</code></entry>
  431. <entry><code>10</code></entry>
  432. <entry>
  433. Ausschalten / Feintunen der Berechnung des Füll-Prozentsatzes des
  434. schnellen Backends (wenn ein Eintrag in den Cache gespeichert wird, die
  435. Berechnung des Füll-Prozentsatzes des schnellen Backends zufällig 1 mal bei
  436. x Cache Schreibvorgängen)
  437. </entry>
  438. </row>
  439. </tbody>
  440. </tgroup>
  441. </table>
  442. </sect2>
  443. <sect2 id="zend.cache.backends.zendserver">
  444. <title>Zend_Cache_Backend_ZendServer_Disk und Zend_Cache_Backend_ZendServer_ShMem</title>
  445. <para>
  446. Diese Backends speichern Cacheeinträge indem Sie die Caching Funktionalitäten von
  447. <ulink url="http://www.zend.com/en/products/server/downloads-all?zfs=zf_download">Zend Server</ulink>
  448. verwenden.
  449. </para>
  450. <para>
  451. Achtung: mit diesen Backends werden für den Moment "Tags" nicht unterstützt, wegen dem
  452. "doNotTestCacheValidity=true" Argument.
  453. </para>
  454. <para>
  455. Diese Backends arbeiten nur nur in einer Zend Server Umgebung für Seiten die über
  456. HTTP(S) angefragt wurden und nicht für Kommandozeilen Ausführung.
  457. </para>
  458. <para>
  459. Es gibt keine Optionen für diese Backends.
  460. </para>
  461. </sect2>
  462. </sect1>
  463. <!--
  464. vim:se ts=4 sw=4 et:
  465. +-->