From: Daniel Theophanes <kardianos@gmail.com>
Date: Thu, 29 Mar 2018 17:01:27 +0000 (-0700)
Subject: database/sql: clarify behavior of DB.Close
X-Git-Tag: go1.11beta1~870
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=7a7b63f3e749e3608ee16b1807349a778d562c08;p=gostls13.git

database/sql: clarify behavior of DB.Close

It wasn't clear for existing docs if DB.Close forcefully closed
connections or waited for them to finish.

Fixes #23753

Change-Id: Id7df31224c93181c8d01bab7b0b23da25b42a288
Reviewed-on: https://go-review.googlesource.com/103397
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
---

diff --git a/src/database/sql/sql.go b/src/database/sql/sql.go
index c8666653ba..355b6aa300 100644
--- a/src/database/sql/sql.go
+++ b/src/database/sql/sql.go
@@ -738,7 +738,9 @@ func (db *DB) Ping() error {
 	return db.PingContext(context.Background())
 }
 
-// Close closes the database, releasing any open resources.
+// Close closes the database and prevents new queries from starting.
+// Close then waits for all queries that have started processing on the server
+// to finish.
 //
 // It is rare to Close a DB, as the DB handle is meant to be
 // long-lived and shared between many goroutines.