Skip to content

Commit 087ce49

Browse files
committed
docs enhanced TinyDrivers Features Summary
[skip ci]
1 parent b3af5b8 commit 087ce49

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,14 @@ The whole library is documented as markdown documents:
6565

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

68+
- can be used instead of the `QtSql` module
69+
- can be <ins>__swapped__</ins> at compile time 🤯
70+
- has __1:1__ API as the `QtSql` module 😮
71+
- swapping is controlled by the `qmake` and `CMake` build system options
72+
- was designed to drop the `QtSql` dependency while maintaining backward compatibility and without the need for any code changes after the swap
6873
- currently, only the `MySQL` database driver is supported and finished 😞
74+
- this is only true for our `TinyDrivers` library ❗
75+
- 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
6976
- both, normal and prepared statements are supported
7077
- 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) 🔥
7178
- 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))

docs/tinydrivers/getting-started.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ It was designed to drop the `QtSql` dependency while maintaining backward compat
4444
Currently, only the `MySQL` database driver is supported and finished. 😞
4545
:::
4646

47+
:::tip
48+
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.
49+
:::
50+
4751
:::note
4852
`TinyDrivers` library supports both build systems `qmake` and also `CMake`.
4953
:::

0 commit comments

Comments
 (0)