Skip to content

Document MariaDB support in README #1504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robertsilen wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Document MariaDB support in README #1504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ The bot can handle updates with [**Webhook**](#webhook-installation) or [**getUp
| ---- | :----: | :----: |
| Description | Telegram sends the updates directly to your host | You have to fetch Telegram updates manually |
| Host with https | Required | Not required |
| MySQL | Not required | ([Not](#getupdates-without-database)) Required |
| MySQL / MariaDB | Not required | ([Not](#getupdates-without-database)) Required |

## Using a custom Bot API server

Expand Down Expand Up @@ -290,7 +290,7 @@ Edit *[unset.php]* with your bot credentials and execute it.

## getUpdates installation

For best performance, the MySQL database should be enabled for the `getUpdates` method!
For best performance, a MySQL or MariaDB database should be enabled for the `getUpdates` method!

Create *[getUpdatesCLI.php]* with the following contents:
```php
Expand Down Expand Up @@ -485,6 +485,8 @@ You can also broadcast a message to users, from the private chat with your bot.

### MySQL storage (Recommended)

MariaDB is supported via the same PDO `mysql` driver and `enableMySql()` setup (CI tests use a MariaDB image).

If you want to save messages/users/chats for further usage in commands, create a new database (`utf8mb4_unicode_520_ci`), import *[structure.sql]* and enable MySQL support BEFORE `handle()` method:

```php
Expand Down