Skip to content

Commit

Permalink
docs enhanced TinyDrivers Features Summary
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
silverqx committed Aug 26, 2024
1 parent b3af5b8 commit 087ce49
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,14 @@ The whole library is documented as markdown documents:

The following list summarizes all the `TinyDrivers` and `TinyMySql` libraries' features. 🆕

- can be used instead of the `QtSql` module
- can be <ins>__swapped__</ins> at compile time 🤯
- has __1:1__ API as the `QtSql` module 😮
- swapping is controlled by the `qmake` and `CMake` build system options
- was designed to drop the `QtSql` dependency while maintaining backward compatibility and without the need for any code changes after the swap
- currently, only the `MySQL` database driver is supported and finished 😞
- this is only true for our `TinyDrivers` library ❗
- all database drivers described in the [Database](https://www.tinyorm.org/database/getting-started#introduction) documentation are supported when linking against the [`QtSql`](https://doc.qt.io/qt/qtsql-index.html) module
- both, normal and prepared statements are supported
- TLS/SSL connections using [`MYSQL_OPT_SSL_MODE`](https://dev.mysql.com/doc/c-api/9.0/en/mysql-options.html) (verify_ca, verify_identity) 🔥
- setting many other MySQL connection options (see [`mysqldriver_p.cpp`](https://github.com/silverqx/TinyORM/blob/main/drivers/mysql/src/orm/drivers/mysql/mysqldriver_p.cpp))
Expand Down
4 changes: 4 additions & 0 deletions docs/tinydrivers/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ It was designed to drop the `QtSql` dependency while maintaining backward compat
Currently, only the `MySQL` database driver is supported and finished. 😞
:::

:::tip
All database drivers described in the [Database](database/getting-started.mdx#introduction) documentation are supported when linking against the [`QtSql`](https://doc.qt.io/qt/qtsql-index.html) module.
:::

:::note
`TinyDrivers` library supports both build systems `qmake` and also `CMake`.
:::
Expand Down

0 comments on commit 087ce49

Please sign in to comment.