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)
    Configure global await for asserts with await
    T
    setTemplatesDirectory(String templatePath)
    Configure directory in resources for tables templates
    T
    withAwaitMs(int awaitMs)
    Configure await for next assert with await (than await rollback to global) global setAwaitMs(int) will be ignored

  • Method Details

    • setAwaitMs

      T setAwaitMs(int awaitMs)
      Configure global await for asserts with await
      Parameters:
      awaitMs - ms await
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - on invalid setup

    • withAwaitMs

      T withAwaitMs(int awaitMs)
      Configure await for next assert with await (than await rollback to global) global setAwaitMs(int) will be ignored
      Parameters:
      awaitMs - ms await
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - on invalid setup

    • setTemplatesDirectory

      T setTemplatesDirectory(String templatePath)
      Configure directory in resources for tables templates
      Parameters:
      templatePath - path in resources "my_dir/sub_dir/"
      Returns:
      this instance for method chaining
      Throws:
      IllegalArgumentException - on invalid setup

    • 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