Permalink
Browse files

updating documentation for 0.3-beta

  • Loading branch information...
1 parent 754bd5a commit 8b595fa2e00096c4d2dccf00912b4d5dec079fa3 Philio committed Feb 24, 2011
Showing with 12 additions and 1 deletion.
  1. +12 −1 README.markdown
View
@@ -76,7 +76,7 @@ Tested on versions of MySQL 4.x, 5.x (including 5.5), MariaDB and Percona.
Thread Safety
-------------
-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.
+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.
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.
@@ -158,6 +158,17 @@ Client properties
**Client.Warnings** - The number of warnings generated by the last operation (if applicable).
+Client methods
+--------------
+
+**mysql.NewClient(protocol ...uint8) (c *Client)** - Get a new client instance, optionally specifying the protocol.
+
+**mysql.DialTCP(raddr, user, passwd string, dbname ...string) (c *Client, err os.Error)** - Connect to the server using TCP.
+
+**mysql.DialUnix(raddr, user, passwd string, dbname ...string) (c *Client, err os.Error)** - Connect to the server using unix socket.
+
+**Client.Connect(network, raddr, user, passwd string, dbname ...string) (err os.Error)** - Connect to the server using the provided details.
+
Result Functions
----------------

0 comments on commit 8b595fa

Please sign in to comment.