Skip to content

docs: audit SQL module page#19

Merged
demengc merged 1 commit intomainfrom
docs/audit-sql-module
Mar 24, 2026
Merged

docs: audit SQL module page#19
demengc merged 1 commit intomainfrom
docs/audit-sql-module

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • Fixed batch.bind() -> batch.batch() bug (method name did not match BatchBuilder API)
  • Simplified constructor examples to use null defaults instead of manually building the JDBC URL string
  • Documented Sql.MYSQL_DRIVER, Sql.MYSQL_LEGACY_DRIVER, and Sql.DEFAULT_JDBC_URL constants in a reference table
  • Added async operations section with sync/async method mapping table
  • Replaced manual Schedulers.async() wrapping in examples with the built-in executeAsync/queryAsync methods
  • Documented SqlCredentials.of(ConfigurationSection) factory method
  • Documented low-level access methods (stream(), getConnection(), getHikari())
  • Documented BatchBuilder.execute() and BatchBuilder.reset() methods
  • Corrected cleanup section: Sql implements ISql which extends Terminable (not directly AutoCloseable)
  • Used no-preparer overloads of execute(String) and query(String, SqlFunction) where appropriate
  • Removed redundant inline comments and filler text throughout

Test plan

  • Verify all code examples match the current API signatures in source
  • Confirm markdown renders correctly on GitBook

Fix batch.bind() -> batch.batch() bug, simplify constructor examples to
use null defaults instead of manual JDBC URL building, document async
method variants with table, add constants reference, document low-level
access methods, correct interface hierarchy in cleanup section, use
built-in executeAsync/queryAsync instead of Schedulers.async() wrapper
in examples, and restructure page for information density.
@demengc demengc merged commit 94708cf into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the docs/audit-sql-module branch March 24, 2026 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant