Skip to content

Commit 8b595fa

Browse files
author
Philio
committed
updating documentation for 0.3-beta
1 parent 754bd5a commit 8b595fa

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.markdown

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Tested on versions of MySQL 4.x, 5.x (including 5.5), MariaDB and Percona.
7676
Thread Safety
7777
-------------
7878

79-
As of version 0.3 of the client, the thread safe functionality was removed from the library, but the inherited functions from sync.Mutex were retained. The reasons for this is that the inclusions of locking/unlocking within the client itself conflicted with the new functionality that had been added and it was clear that locking should be performed within the calling program and not the library. For convenience to the programmer, the mutex functions were retained allowing for Client.Lock() and Client.Unlock() to be used for thread safe operations.
79+
As of version 0.3, the thread safe functionality was removed from the library, but the inherited functions from sync.Mutex were retained. The reasons for this is that the inclusions of locking/unlocking within the client itself conflicted with the new functionality that had been added and it was clear that locking should be performed within the calling program and not the library. For convenience to the programmer, the mutex functions were retained allowing for Client.Lock() and Client.Unlock() to be used for thread safe operations.
8080

8181
In older versions of the client from 0.1.8 - 0.2.x internal locking remains, however it is not recommended to use these versions as version 0.3.x is a much better implementation.
8282

@@ -158,6 +158,17 @@ Client properties
158158
**Client.Warnings** - The number of warnings generated by the last operation (if applicable).
159159

160160

161+
Client methods
162+
--------------
163+
164+
**mysql.NewClient(protocol ...uint8) (c *Client)** - Get a new client instance, optionally specifying the protocol.
165+
166+
**mysql.DialTCP(raddr, user, passwd string, dbname ...string) (c *Client, err os.Error)** - Connect to the server using TCP.
167+
168+
**mysql.DialUnix(raddr, user, passwd string, dbname ...string) (c *Client, err os.Error)** - Connect to the server using unix socket.
169+
170+
**Client.Connect(network, raddr, user, passwd string, dbname ...string) (err os.Error)** - Connect to the server using the provided details.
171+
161172
Result Functions
162173
----------------
163174

0 commit comments

Comments
 (0)