Class JDBCPrepareOptions

java.lang.Object
io.vertx.sqlclient.PrepareOptions
io.vertx.jdbcclient.JDBCPrepareOptions
public class JDBCPrepareOptions extends PrepareOptions
Options for preparing JDBC statements.

This class extends PrepareOptions and adds JDBC-specific options for controlling auto-generated keys retrieval during statement execution.

  • Field Details

    • DEFAULT_AUTO_GENERATED_KEYS

      public static final boolean DEFAULT_AUTO_GENERATED_KEYS
      Default value for auto-generated keys retrieval.
      See Also:

  • Constructor Details

    • JDBCPrepareOptions

      public JDBCPrepareOptions()
      Creates a new instance with default values.

    • JDBCPrepareOptions

      public JDBCPrepareOptions(JDBCPrepareOptions other)
      Creates a new instance by copying another instance.
      Parameters:
      other - the instance to copy

    • JDBCPrepareOptions

      public JDBCPrepareOptions(JsonObject json)
      Creates a new instance from JSON.
      Parameters:
      json - the JSON object

  • Method Details

    • createFrom

      public static JDBCPrepareOptions createFrom(PrepareOptions options)
      Creates a JDBC-specific instance from generic prepare options.
      Parameters:
      options - the generic prepare options
      Returns:
      a new JDBCPrepareOptions instance

    • isAutoGeneratedKeys

      public boolean isAutoGeneratedKeys()
      Returns whether auto-generated keys should be retrieved.
      Returns:
      true if auto-generated keys should be retrieved, false otherwise

    • setAutoGeneratedKeys

      public JDBCPrepareOptions setAutoGeneratedKeys(boolean autoGeneratedKeys)
      Sets whether auto-generated keys should be retrieved.

      This is particularly useful for Oracle databases where batch operations do not support DML returning clauses for generated keys.

      Parameters:
      autoGeneratedKeys - true to retrieve auto-generated keys, false to disable
      Returns:
      a reference to this, so the API can be used fluently

    • getAutoGeneratedKeysIndexes

      public JsonArray getAutoGeneratedKeysIndexes()
      Returns the indexes of auto-generated keys to retrieve.
      Returns:
      the indexes or column names, or null if not set

    • setAutoGeneratedKeysIndexes

      public JDBCPrepareOptions setAutoGeneratedKeysIndexes(JsonArray autoGeneratedKeysIndexes)
      Sets the indexes or column names of auto-generated keys to retrieve.

      The array can contain either integers (column indexes) or strings (column names).

      Parameters:
      autoGeneratedKeysIndexes - the indexes or column names
      Returns:
      a reference to this, so the API can be used fluently