diff --git a/README.rst b/README.rst index 86b274baf..5feee1128 100644 --- a/README.rst +++ b/README.rst @@ -7,7 +7,7 @@ Peewee is a simple and small ORM. It has few (but expressive) concepts, making i * a small, expressive ORM * python 2.7+ and 3.4+ -* supports sqlite, mysql, postgresql and cockroachdb +* supports sqlite, mysql, mariadb, postgresql and cockroachdb * tons of `extensions `_ New to peewee? These may help: diff --git a/docs/index.rst b/docs/index.rst index 5cbd59226..44d7ae8b4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ it easy to learn and intuitive to use. * a small, expressive ORM * python 2.7+ and 3.4+ -* supports sqlite, mysql, postgresql and cockroachdb +* supports sqlite, mysql, mariadb, postgresql and cockroachdb * :ref:`tons of extensions ` .. image:: postgresql.png @@ -24,6 +24,10 @@ it easy to learn and intuitive to use. :target: peewee/database.html#using-mysql :alt: mysql +.. image:: mariadb.png + :target: peewee/database.html#using-mariadb + :alt: mariadb + .. image:: sqlite.png :target: peewee/database.html#using-sqlite :alt: sqlite diff --git a/docs/mariadb.png b/docs/mariadb.png new file mode 100644 index 000000000..809868a5d Binary files /dev/null and b/docs/mariadb.png differ diff --git a/docs/peewee/database.rst b/docs/peewee/database.rst index f71dbc294..ed8e906c1 100644 --- a/docs/peewee/database.rst +++ b/docs/peewee/database.rst @@ -12,8 +12,8 @@ to open a connection to a database, and then can be used to: * Manage transactions (and savepoints). * Introspect tables, columns, indexes, and constraints. -Peewee comes with support for SQLite, MySQL and Postgres. Each database class -provides some basic, database-specific configuration options. +Peewee comes with support for SQLite, MySQL, MariaDB and Postgres. Each +database class provides some basic, database-specific configuration options. .. code-block:: python @@ -557,6 +557,14 @@ If you would like to use APSW, use the :py:class:`APSWDatabase` from the apsw_db = APSWDatabase('my_app.db') +.. _using_mariadb: + +Using MariaDB +----------- + +Peewee supports MariaDB. To use MariaDB, use the MySQL backend, which is shared +between the two. See :ref:`"Using MySQL" ` for more details. + .. _using_mysql: Using MySQL @@ -1773,11 +1781,11 @@ handler. Adding a new Database Driver ---------------------------- -Peewee comes with built-in support for Postgres, MySQL and SQLite. These -databases are very popular and run the gamut from fast, embeddable databases to -heavyweight servers suitable for large-scale deployments. That being said, -there are a ton of cool databases out there and adding support for your -database-of-choice should be really easy, provided the driver supports the +Peewee comes with built-in support for Postgres, MySQL, MariaDB and SQLite. +These databases are very popular and run the gamut from fast, embeddable +databases to heavyweight servers suitable for large-scale deployments. That +being said, there are a ton of cool databases out there and adding support for +your database-of-choice should be really easy, provided the driver supports the `DB-API 2.0 spec `_. .. warning::