Merge pull request #75 from Anirudh-Muthukumar/Update-documentation-f…

…or-SqlQuery-execute- Update documentation for SqlQuery.execute() and StatementPreparer.exe…
lucidsoftware · Feb 28, 2022 · da42bf2 · da42bf2
2 parents 6f27bf0 + 1e3afbc
commit da42bf2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/relate/src/main/scala/com/lucidchart/relate/SqlQuery.scala b/relate/src/main/scala/com/lucidchart/relate/SqlQuery.scala
@@ -81,7 +81,7 @@ trait Sql extends CollectionsSql {
   /**
    * Execute a statement
    * @param connection the db connection to use when executing the query
-   * @return whether the query succeeded in its execution
+   * @return true if the first result is a ResultSet object; false if the first result is an update count or there is no result
    */
   def execute()(implicit connection: Connection): Boolean = normalStatement.execute()
 

diff --git a/relate/src/main/scala/com/lucidchart/relate/StatementPreparer.scala b/relate/src/main/scala/com/lucidchart/relate/StatementPreparer.scala
@@ -32,7 +32,7 @@ private[relate] sealed trait StatementPreparer {
 
   /**
    * Execute the query and close
-   * @return if the query succeeded or not
+   * @return true if the first result is a ResultSet object; false if the first result is an update count or there is no result
    */
   def execute(): Boolean = {
     try {