Document when NoData error is not returned. (#295)

edgedb · Feb 1, 2024 · 4ee5a78 · 4ee5a78
1 parent 2a31436
commit 4ee5a78
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/internal/client/client.go b/internal/client/client.go
@@ -355,7 +355,8 @@ func (p *Client) Query(
 
 // QuerySingle runs a singleton-returning query and returns its element.
 // If the query executes successfully but doesn't return a result
-// a NoDataError is returned.
+// a NoDataError is returned. If the out argument is an optional type the out
+// argument will be set to missing instead of returning a NoDataError.
 func (p *Client) QuerySingle(
 	ctx context.Context,
 	cmd string,

diff --git a/internal/client/transaction.go b/internal/client/transaction.go
@@ -175,7 +175,8 @@ func (t *Tx) Query(
 
 // QuerySingle runs a singleton-returning query and returns its element.
 // If the query executes successfully but doesn't return a result
-// a NoDataError is returned.
+// a NoDataError is returned. If the out argument is an optional type the out
+// argument will be set to missing instead of returning a NoDataError.
 func (t *Tx) QuerySingle(
 	ctx context.Context,
 	cmd string,