From 765f2a2cd708f0d156c40824ad782e174a12154a Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Fri, 3 May 2024 12:57:19 -0300 Subject: [PATCH 1/7] Update file --- LICENSE.md | 6 +++--- README.md | 30 +++++++++--------------------- 2 files changed, 12 insertions(+), 24 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d60..c48bcea7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of Yii Software nor the names of its + * Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index c0bc92e6..ab393a0a 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ It is used in [Yii Framework] but can be used separately. ## Support version -| PHP |Mysql/MariaDb| CI-Actions -|:-----------:|:-----------:|:------------:| +| PHP | Mysql/MariaDb | CI-Actions +|-----------|-----------|------------| | **8.0-8.2** |**5.7-8.0**/**10.4-10.10**|[![build](https://github.com/yiisoft/db-mysql/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-mysql/actions/workflows/build.yml) [![ansi-mode](https://github.com/yiisoft/db-mysql/actions/workflows/ansi-mode.yml/badge.svg)](https://github.com/yiisoft/db-mysql/actions/workflows/ansi-mode.yml) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdb-mysql%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-mysql/master) [![static analysis](https://github.com/yiisoft/db-mysql/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-mysql/actions/workflows/static.yml) ## Installation @@ -45,25 +45,20 @@ composer require yiisoft/db-mysql ## Documentation -English: - - [Connection config for MySQL and MariaDb](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md). - [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. - -Português - Brasil: - -- Para configurar a conexão com Mysql, MariaDb leia [Connecting MySQL/MariaDb](https://github.com/yiisoft/db/blob/master/docs/pt-BR/connection/mysql.md). -- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/pt-BR/README.md) para aprender como usar. - -Testing: - - [Internals](docs/internals.md) -## Support - If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). +## License + +The Yii DataBase MySQL, MariaDb Extension is free software. It is released under the terms of the BSD License. +Please see [`LICENSE`](./LICENSE.md) for more information. + +Maintained by [Yii Software](https://www.yiiframework.com/). + ## Support the project [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft) @@ -75,10 +70,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en) [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk) [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack) - -## License - -The Yii DataBase MySQL, MariaDb Extension is free software. It is released under the terms of the BSD License. -Please see [`LICENSE`](./LICENSE.md) for more information. - -Maintained by [Yii Software](https://www.yiiframework.com/). From ae700dc44077231c13ed04273e9970fb64c0bfd7 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Fri, 3 May 2024 13:02:52 -0300 Subject: [PATCH 2/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ab393a0a..29f4c51e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- + From 01fe3a6fa9a9aedbf3e41b2351072f1fa0a34820 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Sat, 4 May 2024 06:04:50 -0300 Subject: [PATCH 3/7] Update internals.md --- docs/internals.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/internals.md b/docs/internals.md index 35d48c72..72ef3891 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -29,9 +29,7 @@ docker compose -f docker-compose-mariadb.yml up -d ## Unit testing -The package is tested with [PHPUnit](https://phpunit.de/). - -The following steps are required to run the tests: +The package is tested with [PHPUnit](https://phpunit.de/). To run tests: 1. Run the docker container for the dbms. 2. Install the dependencies of the project with composer. From f9adfadaaed7d09e633b033fccf26fa16c05d9a1 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 6 May 2024 07:03:38 -0300 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29f4c51e..366ce8e5 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ It is used in [Yii Framework] but can be used separately. ## Installation -The package could be installed via composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell composer require yiisoft/db-mysql From 5fd4abcbcfe19e11160b3bc25f69fa8da271eb5b Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Sat, 11 May 2024 11:08:24 -0300 Subject: [PATCH 5/7] Fix docs --- README.md | 37 ++++++++++++++++++++----------------- composer.json | 16 +++++++++++++--- docs/internals.md | 12 ++++++------ 3 files changed, 39 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 366ce8e5..e3d96e51 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,30 @@

- + Yii - + MySQL -

MySQL and MariaDB driver for Yii Database

+ + MariaDB + +

Yii Database MySQL and MariaDB driver


+[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-mysql/v/stable.png)](https://packagist.org/packages/yiisoft/db-mysql) +[![Total Downloads](https://poser.pugx.org/yiisoft/db-mysql/downloads.png)](https://packagist.org/packages/yiisoft/db-mysql) +[![rector](https://github.com/yiisoft/db-mysql/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-mysql/actions/workflows/rector.yml) +[![codecov](https://codecov.io/gh/yiisoft/db-mysql/branch/master/graph/badge.svg?token=gsKVx3WQt4)](https://codecov.io/gh/yiisoft/db-mysql) +[![StyleCI](https://github.styleci.io/repos/145220107/shield?branch=master)](https://github.styleci.io/repos/145220107?branch=master) +[![type-coverage](https://shepherd.dev/github/yiisoft/db-mysql/coverage.svg)](https://shepherd.dev/github/yiisoft/db-mysql) + MySQL driver for [Yii Database](https://github.com/yiisoft/db) allows developers to access and interact with [MySQL] -and [MariaDb] databases. -It provides a set of classes and methods for connecting to a [MySQL] and [MariaDb] database, +and [MariaDB] databases. +It provides a set of classes and methods for connecting to a [MySQL] and [MariaDB] database, executing SQL queries, and managing data within the database. The package is designed to be easy to use and integrate, -and supports a wide range of [MySQL], [MariaDb] features and functions. +and supports a wide range of [MySQL], [MariaDB] features and functions. It also includes support for transactions, database schema management, and error handling. It is used in [Yii Framework] but can be used separately. @@ -22,17 +32,10 @@ It is used in [Yii Framework] but can be used separately. [MariaDB]: https://mariadb.org/ [MySQL]: https://www.mysql.com/ -[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-mysql/v/stable.png)](https://packagist.org/packages/yiisoft/db-mysql) -[![Total Downloads](https://poser.pugx.org/yiisoft/db-mysql/downloads.png)](https://packagist.org/packages/yiisoft/db-mysql) -[![rector](https://github.com/yiisoft/db-mysql/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-mysql/actions/workflows/rector.yml) -[![codecov](https://codecov.io/gh/yiisoft/db-mysql/branch/master/graph/badge.svg?token=gsKVx3WQt4)](https://codecov.io/gh/yiisoft/db-mysql) -[![StyleCI](https://github.styleci.io/repos/145220107/shield?branch=master)](https://github.styleci.io/repos/145220107?branch=master) -[![type-coverage](https://shepherd.dev/github/yiisoft/db-mysql/coverage.svg)](https://shepherd.dev/github/yiisoft/db-mysql) - ## Support version -| PHP | Mysql/MariaDb | CI-Actions -|-----------|-----------|------------| +| PHP | MySQL/MariaDB Version | CI-Actions | +|-----------|-----------------------|------------| | **8.0-8.2** |**5.7-8.0**/**10.4-10.10**|[![build](https://github.com/yiisoft/db-mysql/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-mysql/actions/workflows/build.yml) [![ansi-mode](https://github.com/yiisoft/db-mysql/actions/workflows/ansi-mode.yml/badge.svg)](https://github.com/yiisoft/db-mysql/actions/workflows/ansi-mode.yml) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdb-mysql%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-mysql/master) [![static analysis](https://github.com/yiisoft/db-mysql/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-mysql/actions/workflows/static.yml) ## Installation @@ -45,7 +48,7 @@ composer require yiisoft/db-mysql ## Documentation -- [Connection config for MySQL and MariaDb](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md). +- [Connection config for MySQL and MariaDB](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md). - [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. - [Internals](docs/internals.md) @@ -54,7 +57,7 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. ## License -The Yii DataBase MySQL, MariaDb Extension is free software. It is released under the terms of the BSD License. +The Yii Database MySQL and MariaDB driver is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). diff --git a/composer.json b/composer.json index c8bf50ca..cd0a9980 100644 --- a/composer.json +++ b/composer.json @@ -13,13 +13,23 @@ "homepage": "https://www.yiiframework.com/", "license": "BSD-3-Clause", "support": { + "issues": "https://github.com/yiisoft/db-mysql/issues?state=open", "source": "https://github.com/yiisoft/db-mysql", - "issues": "https://github.com/yiisoft/db-mysql/issues", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", - "chat": "https://t.me/yii3en", - "irc": "ircs://irc.libera.chat:6697/yii" + "irc": "ircs://irc.libera.chat:6697/yii", + "chat": "https://t.me/yii3en" }, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/yiisoft" + }, + { + "type": "github", + "url": "https://github.com/sponsors/yiisoft" + } + ], "require": { "php": "^8.0", "ext-ctype": "*", diff --git a/docs/internals.md b/docs/internals.md index 72ef3891..62ea1ed1 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -10,18 +10,18 @@ All our packages have github actions by default, so you can test your [contribut For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder. -1. [MySQL 8](../../../docker-compose.yml) -2. [MariaDB 10.11](../../../docker-compose-mariadb.yml) +1. [MySQL 8](../docker-compose.yml) +2. [MariaDB 10.11](../docker-compose-mariadb.yml) For running the docker containers you can use the following command: -MySQL 8.0. +MySQL: ```shell docker compose up -d ``` -MariaDB 10.11. +MariaDB: ```shell docker compose -f docker-compose-mariadb.yml up -d @@ -56,7 +56,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Rector +## Code style Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: @@ -65,7 +65,7 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Composer require checker +## Dependencies This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. From ee71e67e209a0ab000b028f046bb1d1ed90bf408 Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Thu, 16 May 2024 14:21:35 +0300 Subject: [PATCH 6/7] fix --- README.md | 7 ++++--- docs/internals.md | 5 ++--- phpunit.xml.dist | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e3d96e51..737c8a76 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Yii + Yii MySQL @@ -48,8 +48,9 @@ composer require yiisoft/db-mysql ## Documentation -- [Connection config for MySQL and MariaDB](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md). -- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. +[Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage + +- [Connection config for MySQL and MariaDB](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. diff --git a/docs/internals.md b/docs/internals.md index 62ea1ed1..58b48ef3 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -67,9 +67,8 @@ use either newest or any specific version of PHP: ## Dependencies -This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. - -To run the checker, execute the following command: +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if +all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command: ```shell ./vendor/bin/composer-require-checker diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 4bc8a5cb..e572721e 100755 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,5 +1,5 @@ - + From 94b114dbea20c304aa4b08823823798b1e782de5 Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Thu, 16 May 2024 14:23:45 +0300 Subject: [PATCH 7/7] fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 737c8a76..d9308b2d 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,9 @@ composer require yiisoft/db-mysql ## Documentation -[Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage +[Check the documentation](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage -- [Connection config for MySQL and MariaDB](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md) +- [Connection config for MySQL and MariaDB](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/mysql.md) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.