CHANGELOG 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. v0.7.0 (2010-xx-xx)
  2. * Support for long aliases (method names) for Redis commands has been dropped.
  3. * The Predis\MultiBulkCommand class has been merged into Predis\Command and
  4. thus removed. If you have code that extends Predis\MultiBulkCommand but
  5. you can not afford to update your code, you can always implement it again
  6. as an abstract class simply by extending Predis\Command.
  7. * The Predis\IConnection interface has been splitted in two different new
  8. interfaces: Predis\IConnectionSingle and Predis\IConnectionCluster.
  9. * Developers can now register their own classes that implements the
  10. Predis\IConnectionSingle interface to handle different URI schemes such as
  11. 'redis', 'tcp', 'udp' or anything else.
  12. * Added the new Predis\ICommand interface. The Predis\Command class now
  13. implements this interface that is used in the core bits of Predis.
  14. * Implicit extraction of arguments when the only argument passed to a
  15. multibulk command is an array is not supported anymore and must be done
  16. explicitly inside Predis\Command::filterArguments().
  17. v0.6.1 (2010-07-11)
  18. * Minor internal improvements and clean ups.
  19. * New commands available in the Redis v2.2 profile (dev):
  20. - Misc. : WATCH, UNWATCH
  21. * Optional modifiers for ZRANGE, ZREVRANGE and ZRANGEBYSCORE queries are
  22. supported using an associative array passed as the last argument of their
  23. respective methods.
  24. * The LIMIT modifier for ZRANGEBYSCORE can be specified using either:
  25. - an indexed array: array($offset, $count)
  26. - an associative array: array('offset' => $offset, 'count' => $count)
  27. * The method Predis\Client::__construct() now accepts also instances of
  28. Predis\ConnectionParameters.
  29. * Predis\MultiExecBlock and Predis\PubSubContext now throw an exception
  30. when trying to create their instances using a profile that does not
  31. support the required Redis commands or when the client is connected to
  32. a cluster of connections.
  33. * Various improvements to Predis\MultiExecBlock:
  34. - fixes and more consistent behaviour across various usage cases.
  35. - support for WATCH and UNWATCH when using the current development
  36. profile (Redis v2.2) and aborted transactions.
  37. * New signature for Predis\Client::multiExec() which is now able to accept
  38. an array of options for the underlying instance of Predis\MultiExecBlock.
  39. Backwards compatibility with previous releases of Predis is ensured.
  40. * New signature for Predis\Client::pipeline() which is now able to accept
  41. an array of options for the underlying instance of Predis\CommandPipeline.
  42. Backwards compatibility with previous releases of Predis is ensured.
  43. The method Predis\Client::pipelineSafe() is to be considered deprecated.
  44. * FIX: The WEIGHT modifier for ZUNIONSTORE and ZINTERSTORE was handled
  45. incorrectly with more than two weights specified.
  46. v0.6.0 (2010-05-24)
  47. * Switched to the new multi-bulk request protocol for all of the commands
  48. in the Redis 1.2 and Redis 2.0 profiles. Inline and bulk requests are now
  49. deprecated as they will be removed in future releases of Redis.
  50. * The default server profile is "2.0" (targeting Redis 2.0.x). If you are
  51. using older versions of Redis, it is highly recommended that you specify
  52. which server profile the client should use (e.g. "1.2" when connecting
  53. to instances of Redis 1.2.x).
  54. * Support for Redis 1.0 is now optional and it is provided by requiring
  55. 'Predis_Compatibility.php' before creating an instance of Predis\Client.
  56. * New commands added to the Redis 2.0 profile since Predis 0.5.1:
  57. - Strings: SETEX, APPEND, SUBSTR
  58. - ZSets : ZCOUNT, ZRANK, ZUNIONSTORE, ZINTERSTORE, ZREMBYRANK, ZREVRANK
  59. - Hashes : HSET, HSETNX, HMSET, HINCRBY, HGET, HMGET, HDEL, HEXISTS,
  60. HLEN, HKEYS, HVALS, HGETALL
  61. - PubSub : PUBLISH, SUBSCRIBE, UNSUBSCRIBE
  62. - Misc. : DISCARD, CONFIG
  63. * Introduced client-level options with the new Predis\ClientOptions class.
  64. Options can be passed to Predis\Client::__construct in its second argument
  65. as an array or an instance of Predis\ClientOptions. For brevity's sake and
  66. compatibility with older versions, the constructor of Predis\Client still
  67. accepts an instance of Predis\RedisServerProfile in its second argument.
  68. The currently supported client options are:
  69. - profile [default: "2.0" as of Predis 0.6.0]
  70. specifies which server profile to use when connecting to Redis. This
  71. option accepts an instance of Predis\RedisServerProfile or a string
  72. that indicates the target version.
  73. - key_distribution [default: Predis\Distribution\HashRing]
  74. specifies which key distribution strategy to use to distribute keys
  75. among the servers that compose a cluster. This option accepts an
  76. instance of Predis\Distribution\IDistributionStrategy so that users
  77. can implement their own key distribution strategy. Optionally, the new
  78. Predis\Distribution\KetamaPureRing class also provides a pure-PHP
  79. implementation of the same algorithm used by libketama.
  80. - throw_on_error [default: TRUE]
  81. server errors can optionally be handled "silently": instead of throwing
  82. an exception, the client returns an error response type.
  83. - iterable_multibulk [EXPERIMENTAL - default: FALSE]
  84. in addition to the classic way of fetching a whole multibulk reply
  85. into an array, the client can now optionally stream a multibulk reply
  86. down to the user code by using PHP iterators. It is just a little bit
  87. slower, but it can save a lot of memory in certain scenarios.
  88. * New parameters for connections:
  89. - alias [default: not set]
  90. every connection can now be identified by an alias that is useful to
  91. get a certain connection when connected to a cluster of Redis servers.
  92. - weight [default: not set]
  93. allows the client to balance the keys asymmetrically across multiple
  94. servers. This might be useful when you have servers with different
  95. amounts of memory and you want to distribute the load of your keys
  96. accordingly.
  97. - connection_async [default: FALSE]
  98. estabilish connections to servers in a non-blocking way, so that the
  99. client is not blocked while the underlying resource performs the actual
  100. connection.
  101. - connection_persistent [default: FALSE]
  102. the underlying connection resource is left open when a script ends its
  103. lifecycle. Persistent connections can lead to unpredictable or strange
  104. behaviours, so they should be used with extreme care.
  105. * Introduced the Predis\Pipeline\IPipelineExecutor interface. Classes that
  106. implements this interface are used internally by the Predis\CommandPipeline
  107. class to change the behaviour of the pipeline when writing/reading commands
  108. from one or multiple servers. Here is the list of the default executors:
  109. - Predis\Pipeline\StandardExecutor
  110. Exceptions generated by server errors might be thrown depending on the
  111. options passed to the client (see "throw_on_error"). Instead, protocol
  112. or network errors always throw exceptions. This is the default executor
  113. for single and clustered connections and shares the same behaviour of
  114. Predis 0.5.x.
  115. - Predis\Pipeline\SafeExecutor
  116. Exceptions generated by server, protocol or network errors are not
  117. thrown, instead they are returned in the response array as instances of
  118. ResponseError or CommunicationException.
  119. - Predis\Pipeline\SafeClusterExecutor
  120. This executor shares the same behaviour of Predis\Pipeline\SafeExecutor
  121. but it is geared towards clustered connections.
  122. * Support for PUBSUB is handled by the new Predis\PubSubContext class, which
  123. could also be used to build a callback dispatcher for PUBSUB scenarios.
  124. * When connected to a cluster of connections, it is now possible to get a
  125. new Predis\Client instance for a single connection of the cluster by
  126. passing its alias/index to the new Predis\Client::getClientFor() method.
  127. * CommandPipeline and MultiExecBlock return their instances when invoking
  128. commands, thus allowing method chaining in pipelines and multi-exec blocks.
  129. * MultiExecBlock instances can handle the new DISCARD command.
  130. * Connections now support float values for the connection_timeout parameter
  131. to express timeouts with a microsecond resolution.
  132. * FIX: TCP connections now respect the read/write timeout parameter when
  133. reading the payload of server responses. Previously, stream_get_contents()
  134. was being used internally to read data from a connection but it looks like
  135. PHP does not honour the specified timeout for socket streams when inside
  136. this function.
  137. * FIX: The GET parameter for the SORT command now accepts also multiple key
  138. patterns by passing an array of strings. (ISSUE #1).
  139. * FIX: Replies to the DEL command return the number of elements deleted by
  140. the server and not 0 or 1 interpreted as a boolean response. (ISSUE #4).
  141. v0.5.1 (2010-01-23)
  142. * RPOPLPUSH has been changed from bulk command to inline command in Redis
  143. 1.2.1, so ListPopLastPushHead now extends InlineCommand. The old RPOPLPUSH
  144. behavior is still available via the ListPopLastPushHeadBulk class so that
  145. you can override the server profile if you need the old (and uncorrect)
  146. behaviour when connecting to a Redis 1.2.0 instance.
  147. * Added missing support for BGREWRITEAOF for Redis >= 1.2.0
  148. * Implemented a factory method for the RedisServerProfile class to ease the
  149. creation of new server profile instances based on a version string.
  150. v0.5.0 (2010-01-09)
  151. * First versioned release of Predis