Zend_Cache-Backends.xml 23 KB

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