crate: Ping: Commented on how Ping method works

Signed-off-by: John Andersen <[email protected]>
herenow · Oct 1, 2017 · f634f54 · f634f54
1 parent fbfe7a1
commit f634f54
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crate.go b/crate.go
@@ -35,6 +35,8 @@ func (c *CrateDriver) Open(crate_url string) (driver.Conn, error) {
 	return c, nil
 }
 
+// Ping checks if we can connect to the cluster by selecting its name
+// from sys.cluster. If the select fails we return an error.
 func (c *CrateDriver) Ping(ctx context.Context) error {
 	_, err := c.Exec("SELECT name FROM sys.cluster", nil)
 	if err != nil && strings.Contains(err.Error(), "dial tcp") {