CHANGELOG 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. v0.6.6 (2011-xx-xx)
  2. * Some performance improvements for multibulk replies (parsing them is about
  3. 16% faster than the previous version).
  4. * Add support for connecting to Redis using UNIX domain sockets (ISSUE #25).
  5. * ZUNIONSTORE and ZINTERSTORE can accept an array to specify a list of the
  6. source keys to be used to populate the destination key.
  7. * The "read_write_timeout" connection parameter can now be set to 0 or false
  8. to disable read and write timeouts on connections. The old behaviour of -1
  9. is still intact.
  10. v0.6.5 (2011-02-12)
  11. * FIX: due to an untested internal change introduced in v0.6.4, a wrong
  12. handling of bulk reads of zero-length values was producing protocol
  13. desynchronization errors (ISSUE #20).
  14. v0.6.4 (2011-02-12)
  15. * Various performance improvements (15% ~ 25%) especially when dealing with
  16. long multibulk replies or when using clustered connections.
  17. * Added the "on_retry" option to Predis\MultiExecBlock that can be used to
  18. specify an external callback (or any callable object) that gets invoked
  19. whenever a transaction is aborted by the server.
  20. * Added inline (p)subscribtion via options when initializing an instance of
  21. Predis\PubSubContext.
  22. v0.6.3 (2011-01-01)
  23. * New commands available in the Redis v2.2 profile (dev):
  24. - Strings: SETRANGE, GETRANGE, SETBIT, GETBIT
  25. - Lists : BRPOPLPUSH
  26. * The abstraction for MULTI/EXEC transactions has been dramatically improved
  27. by providing support for check-and-set (CAS) operations when using Redis >=
  28. 2.2. Aborted transactions can also be optionally replayed in automatic up
  29. to a user-defined number of times, after which a Predis\AbortedMultiExec
  30. exception is thrown.
  31. v0.6.2 (2010-11-28)
  32. * Minor internal improvements and clean ups.
  33. * New commands available in the Redis v2.2 profile (dev):
  34. - Strings: STRLEN
  35. - Lists : LINSERT, RPUSHX, LPUSHX
  36. - ZSets : ZREVRANGEBYSCORE
  37. - Misc. : PERSIST
  38. * WATCH also accepts a single array parameter with the keys that should be
  39. monitored during a transaction.
  40. * Improved the behaviour of Predis\MultiExecBlock in certain corner cases.
  41. * Improved parameters checking for the SORT command.
  42. * FIX: the STORE parameter for the SORT command didn't work correctly when
  43. using '0' as the target key (ISSUE #13).
  44. * FIX: the methods for UNWATCH and DISCARD do not break anymore method
  45. chaining with Predis\MultiExecBlock.
  46. v0.6.1 (2010-07-11)
  47. * Minor internal improvements and clean ups.
  48. * New commands available in the Redis v2.2 profile (dev):
  49. - Misc. : WATCH, UNWATCH
  50. * Optional modifiers for ZRANGE, ZREVRANGE and ZRANGEBYSCORE queries are
  51. supported using an associative array passed as the last argument of their
  52. respective methods.
  53. * The LIMIT modifier for ZRANGEBYSCORE can be specified using either:
  54. - an indexed array: array($offset, $count)
  55. - an associative array: array('offset' => $offset, 'count' => $count)
  56. * The method Predis\Client::__construct() now accepts also instances of
  57. Predis\ConnectionParameters.
  58. * Predis\MultiExecBlock and Predis\PubSubContext now throw an exception
  59. when trying to create their instances using a profile that does not
  60. support the required Redis commands or when the client is connected to
  61. a cluster of connections.
  62. * Various improvements to Predis\MultiExecBlock:
  63. - fixes and more consistent behaviour across various usage cases.
  64. - support for WATCH and UNWATCH when using the current development
  65. profile (Redis v2.2) and aborted transactions.
  66. * New signature for Predis\Client::multiExec() which is now able to accept
  67. an array of options for the underlying instance of Predis\MultiExecBlock.
  68. Backwards compatibility with previous releases of Predis is ensured.
  69. * New signature for Predis\Client::pipeline() which is now able to accept
  70. an array of options for the underlying instance of Predis\CommandPipeline.
  71. Backwards compatibility with previous releases of Predis is ensured.
  72. The method Predis\Client::pipelineSafe() is to be considered deprecated.
  73. * FIX: The WEIGHT modifier for ZUNIONSTORE and ZINTERSTORE was handled
  74. incorrectly with more than two weights specified.
  75. v0.6.0 (2010-05-24)
  76. * Switched to the new multi-bulk request protocol for all of the commands
  77. in the Redis 1.2 and Redis 2.0 profiles. Inline and bulk requests are now
  78. deprecated as they will be removed in future releases of Redis.
  79. * The default server profile is "2.0" (targeting Redis 2.0.x). If you are
  80. using older versions of Redis, it is highly recommended that you specify
  81. which server profile the client should use (e.g. "1.2" when connecting
  82. to instances of Redis 1.2.x).
  83. * Support for Redis 1.0 is now optional and it is provided by requiring
  84. 'Predis_Compatibility.php' before creating an instance of Predis\Client.
  85. * New commands added to the Redis 2.0 profile since Predis 0.5.1:
  86. - Strings: SETEX, APPEND, SUBSTR
  87. - ZSets : ZCOUNT, ZRANK, ZUNIONSTORE, ZINTERSTORE, ZREMBYRANK, ZREVRANK
  88. - Hashes : HSET, HSETNX, HMSET, HINCRBY, HGET, HMGET, HDEL, HEXISTS,
  89. HLEN, HKEYS, HVALS, HGETALL
  90. - PubSub : PUBLISH, SUBSCRIBE, UNSUBSCRIBE
  91. - Misc. : DISCARD, CONFIG
  92. * Introduced client-level options with the new Predis\ClientOptions class.
  93. Options can be passed to Predis\Client::__construct in its second argument
  94. as an array or an instance of Predis\ClientOptions. For brevity's sake and
  95. compatibility with older versions, the constructor of Predis\Client still
  96. accepts an instance of Predis\RedisServerProfile in its second argument.
  97. The currently supported client options are:
  98. - profile [default: "2.0" as of Predis 0.6.0]
  99. specifies which server profile to use when connecting to Redis. This
  100. option accepts an instance of Predis\RedisServerProfile or a string
  101. that indicates the target version.
  102. - key_distribution [default: Predis\Distribution\HashRing]
  103. specifies which key distribution strategy to use to distribute keys
  104. among the servers that compose a cluster. This option accepts an
  105. instance of Predis\Distribution\IDistributionStrategy so that users
  106. can implement their own key distribution strategy. Optionally, the new
  107. Predis\Distribution\KetamaPureRing class also provides a pure-PHP
  108. implementation of the same algorithm used by libketama.
  109. - throw_on_error [default: TRUE]
  110. server errors can optionally be handled "silently": instead of throwing
  111. an exception, the client returns an error response type.
  112. - iterable_multibulk [EXPERIMENTAL - default: FALSE]
  113. in addition to the classic way of fetching a whole multibulk reply
  114. into an array, the client can now optionally stream a multibulk reply
  115. down to the user code by using PHP iterators. It is just a little bit
  116. slower, but it can save a lot of memory in certain scenarios.
  117. * New parameters for connections:
  118. - alias [default: not set]
  119. every connection can now be identified by an alias that is useful to
  120. get a certain connection when connected to a cluster of Redis servers.
  121. - weight [default: not set]
  122. allows the client to balance the keys asymmetrically across multiple
  123. servers. This might be useful when you have servers with different
  124. amounts of memory and you want to distribute the load of your keys
  125. accordingly.
  126. - connection_async [default: FALSE]
  127. estabilish connections to servers in a non-blocking way, so that the
  128. client is not blocked while the underlying resource performs the actual
  129. connection.
  130. - connection_persistent [default: FALSE]
  131. the underlying connection resource is left open when a script ends its
  132. lifecycle. Persistent connections can lead to unpredictable or strange
  133. behaviours, so they should be used with extreme care.
  134. * Introduced the Predis\Pipeline\IPipelineExecutor interface. Classes that
  135. implements this interface are used internally by the Predis\CommandPipeline
  136. class to change the behaviour of the pipeline when writing/reading commands
  137. from one or multiple servers. Here is the list of the default executors:
  138. - Predis\Pipeline\StandardExecutor
  139. Exceptions generated by server errors might be thrown depending on the
  140. options passed to the client (see "throw_on_error"). Instead, protocol
  141. or network errors always throw exceptions. This is the default executor
  142. for single and clustered connections and shares the same behaviour of
  143. Predis 0.5.x.
  144. - Predis\Pipeline\SafeExecutor
  145. Exceptions generated by server, protocol or network errors are not
  146. thrown, instead they are returned in the response array as instances of
  147. ResponseError or CommunicationException.
  148. - Predis\Pipeline\SafeClusterExecutor
  149. This executor shares the same behaviour of Predis\Pipeline\SafeExecutor
  150. but it is geared towards clustered connections.
  151. * Support for PUBSUB is handled by the new Predis\PubSubContext class, which
  152. could also be used to build a callback dispatcher for PUBSUB scenarios.
  153. * When connected to a cluster of connections, it is now possible to get a
  154. new Predis\Client instance for a single connection of the cluster by
  155. passing its alias/index to the new Predis\Client::getClientFor() method.
  156. * CommandPipeline and MultiExecBlock return their instances when invoking
  157. commands, thus allowing method chaining in pipelines and multi-exec blocks.
  158. * MultiExecBlock instances can handle the new DISCARD command.
  159. * Connections now support float values for the connection_timeout parameter
  160. to express timeouts with a microsecond resolution.
  161. * FIX: TCP connections now respect the read/write timeout parameter when
  162. reading the payload of server responses. Previously, stream_get_contents()
  163. was being used internally to read data from a connection but it looks like
  164. PHP does not honour the specified timeout for socket streams when inside
  165. this function.
  166. * FIX: The GET parameter for the SORT command now accepts also multiple key
  167. patterns by passing an array of strings. (ISSUE #1).
  168. * FIX: Replies to the DEL command return the number of elements deleted by
  169. the server and not 0 or 1 interpreted as a boolean response. (ISSUE #4).
  170. v0.5.1 (2010-01-23)
  171. * RPOPLPUSH has been changed from bulk command to inline command in Redis
  172. 1.2.1, so ListPopLastPushHead now extends InlineCommand. The old RPOPLPUSH
  173. behavior is still available via the ListPopLastPushHeadBulk class so that
  174. you can override the server profile if you need the old (and uncorrect)
  175. behaviour when connecting to a Redis 1.2.0 instance.
  176. * Added missing support for BGREWRITEAOF for Redis >= 1.2.0
  177. * Implemented a factory method for the RedisServerProfile class to ease the
  178. creation of new server profile instances based on a version string.
  179. v0.5.0 (2010-01-09)
  180. * First versioned release of Predis