Package net.bugreaper.modules.db.jdbc.interfaces

Interface SqlConfig<T extends SqlConfig<T>>

All Known Implementing Classes:
CustomDb, JdbcExecutor, MariaDb, MsSQL, MySQL, OracleDb, PostgreSQL
public interface SqlConfig<T extends SqlConfig<T>>
Defines configuration accessors for SQL execution components.

This interface contains only configuration methods.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getConfigSummary()
    Returns a human-readable summary of the current SQL configuration.
    T
    setAwaitMs(int awaitMs)
    Configures the global await timeout for assertions that use await.
    T
    setTemplatesDirectory(String templatePath)
    Configures the directory in resources containing tables templates.
    T
    withAwaitMs(int awaitMs)
    Sets a custom await timeout for the next assertion.

  • Method Details

    • setAwaitMs

      T setAwaitMs(int awaitMs)
      Configures the global await timeout for assertions that use await.
      Parameters:
      awaitMs - await timeout in milliseconds
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if the provided timeout is invalid or less than 200 milliseconds

    • withAwaitMs

      T withAwaitMs(int awaitMs)
      Sets a custom await timeout for the next assertion.

      After the operation is completed, the timeout is reset to the global value configured by setAwaitMs(int).

      Parameters:
      awaitMs - await timeout in milliseconds
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if the timeout is invalid

    • setTemplatesDirectory

      T setTemplatesDirectory(String templatePath)
      Configures the directory in resources containing tables templates.
      Parameters:
      templatePath - path to the templates directory in resources (example: "my_dir/sub_dir/")
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - if the provided path is invalid

    • getConfigSummary

      String getConfigSummary()
      Returns a human-readable summary of the current SQL configuration.

      The returned string typically includes all configuration values such as query text, parameters, execution options, timeouts, or any other settings managed by the implementing class.

      As a side effect, this method logs the generated summary at the INFO level. This can be useful for debugging or tracing configuration usage during test execution.

      Returns:
      a string containing a formatted summary of all configuration values