Introduce timeTruncate parameter for time.Time arguments

[PauliusLozys]

Description

This introduces timeTruncate parameter that will truncate time.Time values in query arguments.

After #1121, Timestamp and Datetime indexes in MariaDB broke due to nanoseconds now being present in time.Time #1121 (comment).

Query without nanoseconds part:
On MariaDB v11.2.2

Same query on MySQL v8.3.0

Query with nanosecond part:
On MariaDB v11.2.2

On MySQL v8.3.0

Currently, to have correct timestamp/datetime index usage is to either use time.Truncate(time.Microsecond) or time.Round(time.Microsecond). This can be very repetitive and is very likely to be forgotten when writing the query.
Having a parameter that would truncate incoming time.Time values in the driver would prove useful and would remove the need to write time.Truncate methods every time a time value needs to be bound to an argument for MariaDB databases.

Checklist

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

Summary by CodeRabbit

• New Features
  • Introduced a new timeTruncate configuration option allowing users to truncate time values to a specified duration.
• Documentation
  • Updated README.md and AUTHORS files with new configuration options and contributor details.
• Tests
  • Added and modified tests to cover the new time truncation functionality.
• Refactor
  • Modified internal logic to support time value truncation based on the new timeTruncate configuration.

[coderabbitai]

Walkthrough

The overall change introduces a new feature that allows time values to be truncated to a specified duration across various parts of the system. This is achieved by adding a TimeTruncate configuration option and updating the relevant functions to accept this new parameter. The feature impacts how date-time values are processed and formatted, affecting database connection configurations, parameter interpolation, and utility functions. It extends the system's flexibility in handling time values according to user-specified precision.

Changes

Files	Change Summary
AUTHORS, README.md	Added a new author and introduced the timeTruncate configuration option in the documentation.
connection.go, packets.go, utils.go	Modified functions to include the TimeTruncate parameter, affecting date-time value processing.
dsn.go, dsn_test.go	Updated the Config struct to include TimeTruncate, enhanced DSN parsing and formatting to support this new field, and added relevant tests.
utils_test.go	Modified tests to incorporate time truncation testing, reflecting the new functionality.

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.

[coderabbitai]

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c48c0e7 and 5da00c5.

Files selected for processing (8)

• AUTHORS (1 hunks)
• README.md (1 hunks)
• connection.go (1 hunks)
• dsn.go (3 hunks)
• dsn_test.go (1 hunks)
• packets.go (1 hunks)
• utils.go (1 hunks)
• utils_test.go (4 hunks)

Files skipped from review due to trivial changes (1)

• AUTHORS

Additional comments: 9

utils_test.go (1)

• 277-332: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [240-325]

The addition of timeTruncate to the test struct and its usage in appendDateTime function calls correctly implements the new feature for truncating time values to a specified duration. This change ensures that the TestAppendDateTime function now adequately tests the behavior of time truncation in addition to the existing functionality.

connection.go (1)

• 254-254: The addition of mc.cfg.TimeTruncate as an argument to appendDateTime correctly implements the feature for truncating time values based on the configuration. This ensures that date-time values are appended to a buffer with the desired precision.

dsn_test.go (1)

• 78-79: The new test case for the DSN parser with the timeTruncate parameter correctly verifies that the parser can handle and correctly parse the new timeTruncate configuration option. This ensures that the feature is correctly integrated and can be configured via DSN strings.

dsn.go (3)

• 51-51: The addition of the TimeTruncate field to the Config struct is correctly implemented.
• 266-268: The implementation of the TimeTruncate parameter in the FormatDSN method correctly checks if the duration is greater than 0 before adding it to the DSN string. This is a good practice to avoid unnecessary parameters in the DSN string.
• 510-516: The parsing of the timeTruncate parameter in the parseDSNParams function correctly uses time.ParseDuration to convert the string value to a time.Duration. This is the appropriate method for handling duration strings.

utils.go (1)

• 268-272: The modification to the appendDateTime function to accept a timeTruncate parameter and use it to truncate the time value if the duration is greater than 0 is correctly implemented. This allows for flexible truncation of time values based on the configuration.

README.md (1)

• 288-296: The addition of the timeTruncate parameter is well-documented, including its type, default value, and examples of valid values. This documentation aligns with the PR's objectives to introduce a feature for truncating time values to address database index issues. The explanation is clear and provides sufficient detail for users to understand how to use this new configuration option.

packets.go (1)

• 1175-1175: The addition of mc.cfg.TimeTruncate as a parameter to the appendDateTime function call within writeExecutePacket method is a key change. This modification allows for the truncation of time.Time values based on the provided configuration, addressing the issue with Timestamp and Datetime indexes in MariaDB and MySQL.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5da00c5 and c077868.

Files selected for processing (1)

• utils_test.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• utils_test.go

[methane]

mysql/connection.go

Lines 249 to 259 in c48c0e7

	case time.Time:
	if v.IsZero() {
	buf = append(buf, "'0000-00-00'"...)
	} else {
	buf = append(buf, '\'')
	buf, err = appendDateTime(buf, v.In(mc.cfg.Loc))
	if err != nil {
	return "", err
	}
	buf = append(buf, '\'')
	}

[methane]

I think t.Truncate() should be called in caller of appendDateTime.

Sorry. Adding truncate option to appendDateTime makes it easy to find a bug like missing truncate.
When caller don't need truncate, caller can pass 0.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c077868 and 22cf7ce.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• README.md

[PauliusLozys]

I think t.Truncate() should be called in caller of appendDateTime.

Sorry. Adding truncate option to appendDateTime makes it easy to find a bug like missing truncate. When caller don't need truncate, caller can pass 0.

Thanks for the review! I'm a little confused about the comment. Do you mean to keep the function as it is, or move the truncation logic outside appendDateTime?
I think having truncation inside appendDateTime would seem more appropriate as this function's purpose is to format time string. Having the ability to pass additional formatting parameters like truncation seems appropriate and would show that such option is available.
But if you think it's better to have it outside, I'll change it.

[methane]

Thanks for the review! I'm a little confused about the comment. Do you mean to keep the function as it is, or move the truncation logic outside appendDateTime?

Keep as it is.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 22cf7ce and e6f93d3.

Files selected for processing (1)

• dsn_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• dsn_test.go

[coveralls]

coverage: 82.17% (-0.001%) from 82.171%
when pulling e6f93d3 on PauliusLozys:master
into c48c0e7 on go-sql-driver:master.

[methane]

We may revert adding TimeTruncate to Config obj, although keeping this feature.

See #1548 for detail.