ARK2/Cache - Revision history

John Layt: /* Implementation */

2017-07-19T12:57:15Z

‎Implementation

John Layt: /* Configuration */

2017-07-19T12:56:52Z

‎Configuration

John Layt: /* Cache */

2017-07-19T12:56:31Z

‎Cache

John Layt: /* Cache */

2016-12-28T10:22:55Z

‎Cache

John Layt: /* Commands */

2016-12-27T19:44:56Z

‎Commands

John Layt at 16:38, 27 December 2016

2016-12-27T16:38:11Z

John Layt: /* Implementation */

2016-12-27T16:15:57Z

‎Implementation

John Layt: Created page with "= Cache = Caching can greatly improve performance of ARK, especially for configuration and metadata, but also the data and database access. ARK provides a flexible caching sy..."

2016-12-27T15:27:11Z

Created page with "= Cache = Caching can greatly improve performance of ARK, especially for configuration and metadata, but also the data and database access. ARK provides a flexible caching sy..."

New page

= Cache =

Caching can greatly improve performance of ARK, especially for configuration and metadata, but also the data and database access. ARK provides a flexible caching system based on Doctrine Cache, Symphony Cache, and the PSR-6 Caching standard, and supporting filesystem, APCu, or Redis caches (others are possible but not officially supported).

By default, ARK will use APCu for caching if your server has APCu installed, otherwise a filesystem cache will be used. For high-volume sites and APIs, Redis is recommended using either Predis or PHPRedis. Redis can also be used as a Spatial cache to speed up spatial searches.

== Configuration ==

If caching is not explicitly configured in the site.json file, then ARK will check if APCu is available, and if not will fall back to the filesystem. To fractionally improve performance, you can use site.json to explicitly set 'apcu' or 'file'.

If using Redis you need to explicitly set site.json to use 'redis' and the url of the Redis instance.

If Debug mode is enabled, the the cache is disabled.

== Implementation ==

The Doctrine ORM requires the use of the Doctrine Cache component to cache database access, however it is not PSR-6 compliant and is primarily designed for database caching. The Symfony Cache component provides a PSR-6 implementation designed for a wider use case, and provides a bridge to the Doctrine Cache. ARK creates a Doctrine Cache object which is then passed to the Symfony Cache.

@@ Line 18: / Line 18: @@
 Two caches are provided, the System and Application caches:
-* System: An APCu/APC cache primarily for PHP compilable items or smaller static items such as config and metadata.
+* System: An APCu cache primarily for PHP compilable items or smaller static items such as config and metadata.
 * App: A cache for application data.

@@ Line 7: / Line 7: @@
 == Configuration ==
-If caching is not explicitly configured in the site.json file, then ARK will check if APCu or APC is available, and if not will fall back to the filesystem. To fractionally improve performance, you can use site.json to explicitly set 'apc' or 'file'.
+If caching is not explicitly configured in the site.json file, then ARK will check if APCu is available, and if not will fall back to the filesystem. To fractionally improve performance, you can use site.json to explicitly set 'apc' or 'file'.
 If using Redis you need to explicitly set site.json to use 'redis' and the url of the Redis instance.

@@ Line 3: / Line 3: @@
 Caching can greatly improve performance of ARK, especially for configuration and metadata, but also the data and database access. ARK provides a flexible caching system based on Doctrine Cache, Symphony Cache, and the PSR-6 Caching standard, and supporting filesystem, APCu, or Redis caches (others are possible but not officially supported).
-By default, ARK will use APCu for caching if your server has APCu installed, otherwise a filesystem cache will be used. For high-volume sites and APIs, Redis is recommended using either Predis or PHPRedis. Redis can also be used as a Spatial cache to speed up spatial searches.
+By default, ARK will use APC/APCu for caching if your server has APCu/APC installed, otherwise a filesystem cache will be used. For high-volume sites and APIs, Redis is recommended using either Predis or PHPRedis. Redis can also be used as a Spatial cache to speed up spatial searches.
 == Configuration ==
-If caching is not explicitly configured in the site.json file, then ARK will check if APCu is available, and if not will fall back to the filesystem. To fractionally improve performance, you can use site.json to explicitly set 'apcu' or 'file'.
+If caching is not explicitly configured in the site.json file, then ARK will check if APCu or APC is available, and if not will fall back to the filesystem. To fractionally improve performance, you can use site.json to explicitly set 'apc' or 'file'.
 If using Redis you need to explicitly set site.json to use 'redis' and the url of the Redis instance.
-If Debug mode is enabled, the the cache is disabled.
+If Debug mode is enabled, then the cache is disabled.
 == Implementation ==
-The Doctrine ORM requires the use of the Doctrine Cache component to cache database access, however it is not PSR-6 compliant and is primarily designed for database caching. The Symfony Cache component provides a PSR-6 implementation designed for a wider use case, and provides a bridge to the Doctrine Cache. ARK creates a Doctrine Cache object which is then passed to the Symfony Cache.
+ARK uses the Symfony Cache component for a PSR-6 compliant implementation. This also provides a bridge for the Doctrine ORM to use for caching.
 Two caches are provided, the System and Application caches:
-* System: Not persistent, not distributed, intended for static config, metadata, etc
+* System: An APCu/APC cache primarily for PHP compilable items or smaller static items such as config and metadata.
-* App: Persistent, Distributed,
+* App: A cache for application data.
 These caches are accessed via the container:
@@ Line 27: / Line 27: @@
 * $app['cache.orm.system']
-The Service object also provides access to the
+The global Service object also provides access to the cache.
 == Commands ==
-* cache::warmup - warms-up the System cache
+* cache::warmup - Warms-up the System cache
-* cache::clear - clears the System cache
+* cache::clear - Clears the System cache
-* cache::refresh - clears and warmsup the System cache
+* cache::refresh - Clears and warms-up the System cache
 * doctrine cache commands?
 Any cachable component should provide HTTP Kernel CacheWarmer and CacheClearer implementations and register these with the cache provider.

← Older revision		Revision as of 19:44, 27 December 2016
Line 35:		Line 35:
	* cache::refresh - clears and warmsup the System cache		* cache::refresh - clears and warmsup the System cache
	* doctrine cache commands?		* doctrine cache commands?
		+
		+	Any cachable component should provide HTTP Kernel CacheWarmer and CacheClearer implementations and register these with the cache provider.

@@ Line 18: / Line 18: @@
 Two caches are provided, the System and Application caches:
-* System: Not persistent, not distributed
+* System: Not persistent, not distributed, intended for static config, metadata, etc
-* App: Persistent, Distributed
+* App: Persistent, Distributed,
 == Commands ==
-Warmup, Clear, Status, etc
+* cache::warmup - warms-up the System cache

← Older revision		Revision as of 16:15, 27 December 2016
Line 16:		Line 16:

	The Doctrine ORM requires the use of the Doctrine Cache component to cache database access, however it is not PSR-6 compliant and is primarily designed for database caching. The Symfony Cache component provides a PSR-6 implementation designed for a wider use case, and provides a bridge to the Doctrine Cache. ARK creates a Doctrine Cache object which is then passed to the Symfony Cache.		The Doctrine ORM requires the use of the Doctrine Cache component to cache database access, however it is not PSR-6 compliant and is primarily designed for database caching. The Symfony Cache component provides a PSR-6 implementation designed for a wider use case, and provides a bridge to the Doctrine Cache. ARK creates a Doctrine Cache object which is then passed to the Symfony Cache.
		+
		+	Two caches are provided, the System and Application caches:
		+	* System: Not persistent, not distributed
		+	* App: Persistent, Distributed
		+
		+	== Commands ==
		+
		+	Warmup, Clear, Status, etc