Writing method which are using ReturningMode.NONE return the number of affected rows instead.

What a write answers with when it returns no rows. On, it is the number of rows the statement changed; off, the method is void.

The count is worth having: an update that changed no rows is usually a bug the caller can act on, and there is nowhere else to learn that. Turn it off for a statement whose count is meaningless — a create table, or DDL generally.

This applies to returning none only. A write that returns rows answers with them.

Configuration Options

Option: ’true'

The default. The caller can see how many rows the statement changed:

public final class TenantRepository {

    public int insertTenant(final UUID id, final String slug) {
        // ... rest of generated code
    }

}

Option: ‘false’

The count is dropped:

public final class TenantRepository {

    public void insertTenant(final UUID id, final String slug) {
        // ... rest of generated code
    }

}

Related Options

Also in this group: allowedCallPrefixes , allowedReadPrefixes , allowedWritePrefixes , basePackageName , catchAndRethrow , createConnection , executeBatch , executeOnce , generateConnectionOverloads , generateInterfaces , injectConverters , throwOnMultipleResults , validateMethodNamePrefixes .

Tooling

Ant

In order to use YoSQL together with Ant , take a look at the tooling documentation for Ant .

Bazel

In order to use YoSQL together with Bazel , take a look at the tooling documentation for Bazel .

CLI

In order to use YoSQL on the command line, take a look at the tooling documentation for CLI .

yosql --repositories-writes-return-update-count=configValue

As long as the name of the config option is unique across all configuration groups, you can use the shorter form:

yosql --writes-return-update-count=configValue

Gradle

In order to use YoSQL together with Gradle , take a look at the tooling documentation for Gradle . The writesReturnUpdateCount setting can be configured using Gradle in Kotlin syntax like this:

plugins {
  java
  id("wtf.metio.yosql") version "2023.2.22"
}

yosql {
  repositories {
    writesReturnUpdateCount.set(configValue)
  }
}

or in Groovy syntax like this:

plugins {
  id "java"
  id "wtf.metio.yosql" version "2023.2.22"
}

yosql {
  repositories {
    writesReturnUpdateCount = configValue
  }
}

Maven

In order to use YoSQL together with Maven , take a look at the tooling documentation for Maven . The writesReturnUpdateCount setting can be configured using Maven like this:

<build>
  <plugins>
    <plugin>
      <groupId>wtf.metio.yosql</groupId>
      <artifactId>yosql-tooling-maven</artifactId>
      <version>2023.2.22</version>
      <configuration>
        <repositories>
          <writesReturnUpdateCount>configValue</writesReturnUpdateCount>
        </repositories>
      </configuration>
    </plugin>
  </plugins>
</build>