Skip to content

CHANGELOG.md

Latest commit

 

History

History
264 lines (188 loc) · 8.54 KB

CHANGELOG.md

File metadata and controls

264 lines (188 loc) · 8.54 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased v2.x

Added

  • Path validation for JSON fields
  • Helper function get current RedisJSON version + (abstraction)
  • (dev) More unit tests

Changed

  • (dev) Update PHP-CS-Fixer to version 3.12.0

2.2.0

Added

  • Documentation on paginated responses
  • Throw custom exception is client is missing
  • Add compatibility for Predis version 2.x
  • LOAD ALL option on Aggregate command (RediSearch 2.0.13)
  • Profile command (RediSearch 2.2.0) (Issue#4)
  • Vector feature (RediSearch 2.4.0 / 2.4.2)
  • Add DIALECT option (RediSearch 2.4.3) (Issue#35)
  • (dev) Add make clean to remove all generated files
  • (dev) Add code coverage to \MacFJA\RediSearch\Index
  • (dev) Add integration test for document insertion

Fixed

  • Missing default values on highlight option (Issue#38)
  • Don't throw an exception if the result of the index definition is incorrect (Issue#46)
  • Phpredis extension don't return raw response (Issue#46)
  • Error with version reading if MODULE LIST command is protected (PR#42)

Changed

  • Rework paginated responses
  • Add warning for Predis commands initialization
  • Lazy load RediSearch version and index information in \MacFJA\RediSearch\Index
  • Allow to provide RediSearch version manually to \MacFJA\RediSearch\Index
  • (dev) Remove deprecated --no-suggest option of Composer in the Makefile
  • (dev) Update PHP-CS-Fixer version

Deprecated

  • \MacFJA\RediSearch\Redis\Response\AggregateResponseItem::getValue (use \MacFJA\RediSearch\Redis\Response\AggregateResponseItem::getFieldValue instead)

2.1.2

Fixed

  • Allow Phpredis raw command to have 0 arguments (Issue#39)

Changed

  • (dev) Update version and rules of PHP-CS-Fixer and PHPStan

2.1.1

Fixed

  • Summarize Search option enabled by default (without possibility to disable it) (Issue#26)
  • Highlight Search option enabled by default (without possibility to disable it) (Issue#26)
  • Fix error when parsing response from Search with NOCONTENT flag
  • Make PaginatedResponse valid iterator function work

2.1.0

Added

  • Support from JSON document (require RediSearch 2.2)
  • (dev) GitHub Actions
  • Protection against division by 0

Fixed

  • (dev) Code coverage with XDebug 3
  • (dev) Defined list of allowed Composer plugins
  • Fix PaginatedResponse index (now start at 0, and have a linear progression)

2.0.2

Added

  • reset method for builder (\MacFJA\RediSearch\IndexBuilder and \MacFJA\RediSearch\Query\Builder)
  • Allow PHP 8.0
  • (dev) Allow podman (in addition to docker) as container runner for integration test

Changed

  • APPLY option of Aggregate command is now dependent of the last inserted option (if the option have a meaning for APPLY)
  • (dev) Update phpstan (from 0.12 to 1.2)

Fixed

  • Fix the APPLY option of the Aggregate command

2.0.1

Fixed

  • (doc) Fix GPS coordinate (should be longitude first)
  • AmpRedisClient pipeline not sequential

2.0.0

Added

  • Allow multiple connector for Redis (PR#17)
  • Allow specific feature of RediSearch depending of its version (Issue#6)
  • Add more language (Issue#5)
  • Add more language (Issue#5)
  • Add SORTABLE flag on GEO field (Issue#5)
  • Add CASESENSITIVE flag on fields (Issue#5)
  • Add UNF flag on fields (Issue#5)

Changed

  • Remove hard dependency on Predis (Issue#16)
  • Full rework of the library

Unreleased v1.x

1.4.0

Added

  • Implementation of SLOP parameter (PR#8)

Fixed

1.3.0

Added

  • Shorthand for Reducer functions
  • Add Deprecated section in CHANGELOG.md
  • Add Redis pipeline support
  • Prefix properties name with @ in Aggregation's SortBy (keep BC)
  • Add more unit tests (Aggregation options, Field creation, DataHelper, RedisHelper)
  • (dev) Add mutation testing

Changed

  • Allow GROUPBY with no properties
  • Allow GROUPBY with no reducers
  • (dev) Replace php-parallel-lint lib.
  • (dev) Add Php-Cs-Fixer on tests/
  • (dev) Improve Makefile

Fixed

  • Fix namespace of tests
  • Aggregation result can now be an array
  • Fix Index builder options not preserved (PR#3)
  • Aggregation SortBy allow 0 (not limit) as value for Max
  • Fix helper removing "nullish" values (array_filter is too lax by default)
  • Fix order in fields creation not being correct
  • Don't allow empty facet in search query

Deprecated

  • MacFJA\RediSearch\Aggregate\Exception\NotEnoughPropertiesException
  • MacFJA\RediSearch\Aggregate\Exception\NotEnoughReducersException

1.2.0

Fixed

  • Bad copy/paste in the README file
  • Allow null value in Aggregate result
  • Use correct namespace in the README file

Added

  • Detection of syntax error from Redis response
  • Allow multiple level of fuzziness
  • Escape values in the query builder

1.1.0

Fixed

  • Wrong output of the NumericFacet (Issue#2, PR#1)
  • Missing Composer plugin
  • Missing getSeperator method in TagField
  • Missing total number of result
  • Fix typo in search parameter (RETURN)
  • Fix prefixes data from index information

Added

  • Unit test on NumericFacet (PR#1)
  • Index stats can return fields as object.
  • Fields implements Comparable interface
  • Paginate results.
  • Syntax error detection in search.

Changed

  • Rename Index::addFromArray to Index::addDocumentFromArray for consistency (Depreciation, keeping BC)
  • Rename namespace from MacFJA\RedisSearch to MacFJA\RediSearch(Depreciation, keeping BC)
  • Uniformize Builder interface (Deprecation, keeping BC)

Deprecated

  • The whole namespace MacFJA\RedisSearch (replaced by MacFJA\RediSearch)
  • MacFJA\RediSearch\Aggregate::aggregate
  • MacFJA\RediSearch\Index::addFromArray
  • MacFJA\RediSearch\Index\Builder::create
  • MacFJA\RediSearch\Search::search

1.0.0 - 2020-12-05

First version