Merge pull request #138 from ipfs/misc/query-string-comment

Add clarifying comments on Query#String()
ipfs · Nov 11, 2019 · 146d375 · 146d375
2 parents d0ca9bc + 089e515
commit 146d375
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/query/query.go b/query/query.go
@@ -68,6 +68,8 @@ type Query struct {
 	ReturnExpirations bool     // return expirations (see TTLDatastore)
 }
 
+// String returns a string represenation of the Query for debugging/validation
+// purposes. Do not use it for SQL queries.
 func (q Query) String() string {
 	s := "SELECT keys"
 	if !q.KeysOnly {