Make TimeTruncate functional option

[methane]

Description

Config.TimeTruncate just added 2 weeks ago and never released. This PR make the struct field private and introduce "Functional Options Pattern" instead.

See https://github.com/go-sql-driver/mysql/discussions/1548 for background.

Checklist

• [x] Code compiles correctly
• [ ] Created tests which fail without the change (if possible)
• [x] All tests passing
• [x] Extended the README / documentation, if necessary
• [ ] Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

• Refactor
  • Improved handling and configuration of date-time values in database connections.
• Documentation
  • Updated comments in the configuration structure for better clarity.
• New Features
  • Introduced a method to apply functional options for database configuration, including time truncation settings.

[coderabbitai[bot]]

Walkthrough

The changes primarily focus on enhancing the handling and configuration of time truncation within a database connection library. Key modifications include making timeTruncate a private field and introducing a functional option to configure it. This approach streamlines the process of setting time truncation preferences and encapsulates configuration details, improving code readability and maintainability. Modifications span across several files, reflecting a cohesive update to how time values are processed and configured in database queries.

Changes

File(s)	Summary of Changes
connection.go, packets.go	Updated access to timeTruncate from public to private within specific functions, aligning with encapsulation changes.
dsn.go, dsn_test.go	Enhanced the Config struct with comments, privacy adjustments, and a new SetOptions method. Introduced a TimeTruncate functional option and adjusted test settings.
result.go	Minor adjustments in code comment formatting related to database query results.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coveralls]

coverage: 81.919% (-0.3%) from 82.17% when pulling 5b603c9080a96c10ff699f1d0a89e77d6853f6b3 on methane:timetruncate-fop into 097fe6e3ad83bbd7c84debe810aec4c4a533bcaa on go-sql-driver:master.

[arnehormann]

+1 LGTM