From 4952a488f2233cec83554979f7fcaf4a15918e5b Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Tue, 10 Sep 2019 17:35:08 -0500 Subject: [PATCH] Add more docs for Conn.Query --- conn.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/conn.go b/conn.go index 0e72db21..cde42a8f 100644 --- a/conn.go +++ b/conn.go @@ -561,6 +561,10 @@ type QueryResultFormatsByOID map[uint32]int16 // Query executes sql with args. If there is an error the returned Rows will be returned in an error state. So it is // allowed to ignore the error returned from Query and handle it in Rows. +// +// For extra control over how the query is executed, the types QuerySimpleProtocol, QueryResultFormats, and +// QueryResultFormatsByOID may be used as the first args to control exactly how the query is executed. This is rarely +// needed. See the documentation for those types for details. func (c *Conn) Query(ctx context.Context, sql string, args ...interface{}) (Rows, error) { var resultFormats QueryResultFormats var resultFormatsByOID QueryResultFormatsByOID