Skip to content

Commit

Permalink
clarify changelog and adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dbu committed Feb 16, 2024
1 parent 65b9878 commit 0f1a43a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Changelog
When instantiating the client, you need to provide at least the cache instance for metadata, as CachedClient does not know which implementation to pick.
* Support for new Symfony versions.
* Support for doctrine/dbal 4.
* For MySQL/MariaDB, it is now required to configure `collate` or `charset` in the Doctrine connection, or alternatively
* For MySQL/MariaDB, it is now required to configure `defaultTableOptions`.`collate` or `charset` in the Doctrine connection, or alternatively
set the encoding explicitly with `Client::setCaseSensitiveEncoding('')` (e.g. `utf8mb4_bin`).
* If you are on PHP 8.0 and install Jackalope with `symfony/cache`, you need to restrict `psr/simple-cache` to `^1.0 || ^2.0` in your application because Symfony 5 does not declare a conflict with it, but fails at runtime.
* Drop support for PHP 7.
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ Note that you need at least version 5.1.5 of MySQL, otherwise you will get ``SQL
$ mysqladmin -u root -p create database jackalope
$ echo "grant all privileges on jackalope.* to 'jackalope'@'localhost' identified by '1234test'; flush privileges;" | mysql -u root -p
```

Also note that with MySQL/MariaDB, you need to configure the encoding to be used (see "bootstrapping" below).

### PostgreSQL

```sh
Expand Down Expand Up @@ -136,10 +139,11 @@ $driver = 'pdo_mysql'; // pdo_pgsql | pdo_sqlite
$host = 'localhost';
$user = 'admin'; // only used for recording information about the node creator
$sqluser = 'jackalope';
$sqlpass = '';
$sqlpass = 'xxxx';
$database = 'jackalope';
// $path = 'jackalope.db'; // for SQLite
$workspace = 'default';
$charset = 'utf8mb4'; // only for MySQL/MariaDB

// Bootstrap Doctrine
$connection = DriverManager::getConnection([
Expand All @@ -149,6 +153,7 @@ $connection = DriverManager::getConnection([
'password' => $sqlpass,
'dbname' => $database,
// 'path' => $path, // for SQLite
'charset => $charset, // only for MySQL/MariaDB
]);

$factory = new RepositoryFactoryDoctrineDBAL();
Expand Down

0 comments on commit 0f1a43a

Please sign in to comment.