Skip to content

Commit 5e77dfa

Browse files
felipenorisquinnj
authored andcommitted
update MySQL.connect docstring (#119)
1 parent 4449ae1 commit 5e77dfa

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Contributions are very welcome, as are feature requests and suggestions. Please
6060
#### MySQL.connect
6161

6262
```julia
63-
MySQL.connect(host::String, user::String, passwd::String; db::String = "", port = "3306", socket::String = MySQL.API.MYSQL_DEFAULT_SOCKET, opts = Dict())
63+
MySQL.connect(host::String, user::String, passwd::String; db::String="", port::Integer=3306, unix_socket::String=API.MYSQL_DEFAULT_SOCKET, client_flag=API.CLIENT_MULTI_STATEMENTS, opts = Dict())
6464
```
6565
Connect to a mysql database. Returns a [`MySQL.Connection`](#mysqlconnection) object to be passed to other API functions.
6666

@@ -156,7 +156,7 @@ Get the insert id of the most recently executed SQL statement.
156156
#### MySQL.Connection
157157

158158
```julia
159-
MySQL.connect(host::String, user::String, passwd::String; db::String = "", port = "3306", socket::String = MySQL.API.MYSQL_DEFAULT_SOCKET, opts = Dict())
159+
MySQL.connect(host::String, user::String, passwd::String; db::String="", port::Integer=3306, unix_socket::String=API.MYSQL_DEFAULT_SOCKET, client_flag=API.CLIENT_MULTI_STATEMENTS, opts = Dict())
160160
```
161161
A connection to a MySQL database.
162162

src/MySQL.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ function setoptions!(ptr, opts)
2424
end
2525

2626
"""
27-
MySQL.connect(host::String, user::String, passwd::String; db::String = "", port = "3306", socket::String = MySQL.API.MYSQL_DEFAULT_SOCKET, opts = Dict())
27+
MySQL.connect(host::String, user::String, passwd::String; db::String="", port::Integer=3306, unix_socket::String=API.MYSQL_DEFAULT_SOCKET, client_flag=API.CLIENT_MULTI_STATEMENTS, opts = Dict())
2828
2929
Connect to a MySQL database.
3030
"""

0 commit comments

Comments
 (0)