Skip to content

Commit 63f5b87

Browse files
authored
Merge pull request #262 from schveiguy/master
Fix doc build, update README
2 parents f22622f + c82c75c commit 63f5b87

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type based on whether Vibe.d is used in your project. (If you use
2525
Otherwise, you can use `-version=Have_vibe_d_core` to force Vibe.d sockets
2626
instead of Phobos ones.)
2727

28-
Should work on D compilers from 2.068 through to the latest release but the CI only tests against version 2.080.1 and above. For a full list see the builds on Github Actions.
28+
Should work on D compilers from 2.068 through to the latest release but the CI only tests against version 2.085.1 and above. For a full list see the builds on Github Actions. Note that dub from prior to 2.085.0 will not work, but this is not an issue with mysql-native. To build with prior compilers, use a newer version of dub.
2929

3030
In this document:
3131
* [API](#api)
@@ -39,6 +39,8 @@ See also:
3939
API
4040
---
4141

42+
*NOTE: the most recent release of mysql-native has been updated to be usable from `@safe` code, using the `mysql.safe` package. This document is still relevant, as the default is to use the unsafe API. Please see the [safe migration document](SAFE_MIGRATION.md) for more details*
43+
4244
[API Reference](https://mysql-d.github.io/mysql-native/)
4345

4446
The primary interfaces:

source/mysql/safe/connection.d

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ including parameter descriptions, and result set field descriptions,
3737
followed by an EOF packet.
3838
3939
Throws: `mysql.exceptions.MYX` if the server has a problem.
40+
41+
Params:
42+
conn = The connection to use.
43+
sql = The SQL statement to prepare.
4044
+/
4145
SafePrepared prepare(Connection conn, const(char[]) sql)
4246
{
@@ -53,6 +57,7 @@ Be careful that your `numArgs` is correct. If it isn't, you may get a
5357
Throws: `mysql.exceptions.MYX` if the server has a problem.
5458
5559
Params:
60+
conn = The connection to use.
5661
name = The name of the stored function.
5762
numArgs = The number of arguments the stored procedure takes.
5863
+/
@@ -74,6 +79,7 @@ Be careful that your `numArgs` is correct. If it isn't, you may get a
7479
Throws: `mysql.exceptions.MYX` if the server has a problem.
7580
7681
Params:
82+
conn = The connection to use.
7783
name = The name of the stored procedure.
7884
numArgs = The number of arguments the stored procedure takes.
7985

0 commit comments

Comments
 (0)