Completed version 8

Author: TheCelavi

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)and this project adheres to
+[Semantic Versioning](http://semver.org/).
+
+## Changelog
+
+## [8.0.0] - 2024-08-14
+
+### Added
+
+- New API for interacting with query resources loader,
+  `RunOpenCode\Bundle\QueryResourcesLoader\Contract\QueryResourcesLoaderInterface`.
+- Support for middleware in query resources loader.
+- Support for caching of query results.
+
+### Deprecated
+
+- `RunOpenCode\Bundle\QueryResourcesLoader\Contract\ManagerInterface` is deprecated and will be removed in version 9.
+- `RunOpenCode\Bundle\QueryResourcesLoader\Contract\ExecutorInterface` is deprecated and will be removed in version 9.
+- No support for `iterate()` method in `ManagerInterface`.
+
+### Removed
+
+- Support for iterating over records/tables in library.

README.md

@@ -30,6 +30,9 @@ application that deals with reporting.
   You can control transaction isolation level for current statements within transaction.
 - **Distributed transactions**. You can execute multiple queries within same transaction against different databases. If
 - **Caching**. You can cache your query results, so they are not loaded from database on each execution.
+- **Middlewares**. You can use middlewares to manipulate query before execution, or to manipulate result after
+  execution. You can switch to other database if query fails, you can add monitoring, logging, load balancing on several
+  databases, etc...
 
 Read the documentation [here](docs/index.md).
 
@@ -141,5 +144,3 @@ For other details about this bundle, as well as for tips on how to use it, read
 ## TODO
 
 - Add profiling for middlewares and query execution.
-- Add changelog.
-- Improve documentation.

docs/doctrine-dbal-executor-result.md

@@ -26,4 +26,4 @@ for more details.
 
 Note that `ExecutionResultInterface` implements `\Traversable` and `\Countable`.
 
-[<< Using manager](using-manager.md) | [Table of contents](index.md) | [Transaction support >>](transactions.md)
+[<< Twig support](legacy-support) | [Table of contents](index.md) | [Transaction support >>](transactions.md)

docs/faq.md

@@ -18,5 +18,16 @@ That being said, `dmaicher/doctrine-test-bundle`tracks transactions of `Connecti
 `START TRANSACTION` statement in your query, `dmaicher/doctrine-test-bundle` is not able to roll back them, because
 those are not explicitly tracked by `Connection` object.
 
+## Legacy support
+
+Prior to version 8, main interface of the library was
+`RunOpenCode\Bundle\QueryResourcesLoader\Contract\ManagerInterface`. This interface is replaced with
+`RunOpenCode\Bundle\QueryResourcesLoader\Contract\QueryResourcesLoaderInterface` which should be used from now on.
+
+However, to support gradual migration, interface `ManagerInterface` is still available and can be used, but without
+`iterate()` method which is not supported in legacy interface. API for iterating over records/tables will not be
+introduced in future versions as part of this library.
+
+Support for `ManagerInterface` will be removed in version 9.
 
 [FAQ](faq.md) | [Table of contents](index.md)

docs/index.md

@@ -16,7 +16,7 @@ of entities first, and then use those identifiers to fetch entities themselves.
 
 - [Introduction](introduction.md)
 - [Proposed solution](proposed-solution.md)
-- [Using manager](using-manager.md)
+- [Using manager](legacy-support)
 - [Twig support](twig-support.md)
 - [DoctrineDbalExecutorResult](doctrine-dbal-executor-result.md)
 - [Transaction support](transactions.md)