add function to get the driver name #1591

demoManito · 2024-05-22T09:04:06Z

Description

Used to get the current driver name

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

coderabbitai · 2024-05-22T09:04:13Z

Warning

Rate Limit Exceeded

@demoManito has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 45 minutes and 14 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 96db8c1 and 08013ac.

Walkthrough

The recent update enhances the codebase by introducing a new function, DriverName(), in driver.go to retrieve the driver's name. Additionally, a test function TestName has been included in driver_test.go to ensure the accuracy of DriverName(). These changes streamline the process of obtaining the driver name and reinforce its reliability through testing.

Changes

File	Change Summary
`driver.go`	Added `DriverName()` function to return the driver name.
`driver_test.go`	Added `TestName` function to verify the correctness of `DriverName()`.

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

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 testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @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.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

driver_test.go (1)
Line range hint 1495-1497: Ensure TLS configuration specifies a minimum version.

The TLS configuration used in the test setup does not specify a minimum version, which could potentially allow connections using older, less secure versions of TLS. It's recommended to set the minimum TLS version to TLS 1.3 to ensure better security. Here's a suggested change:
- tls.Config{ InsecureSkipVerify: true }
+ tls.Config{ InsecureSkipVerify: true, MinVersion: tls.VersionTLS13 }

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between af8d793 and b8f5ca0.

Files selected for processing (2)

driver.go (1 hunks)
driver_test.go (1 hunks)

Files skipped from review due to trivial changes (1)

driver.go

Additional comments not posted (3)

driver_test.go (3)

3356-3361: The test for verifying the driver name is correctly implemented.

Line range hint 3362-3373: The test for creating a new connector and checking database connectivity is correctly implemented.

Line range hint 3374-3408: The test for handling timeouts during connector opening is correctly implemented.

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

driver_test.go (1)
Line range hint 1495-1497: Ensure TLS configuration specifies a minimum version.

The TLS configuration used in the test setup does not specify a minimum version. It's recommended to set the minimum TLS version to TLS 1.3 to ensure stronger security. Here's the suggested change:
- tls.Config{ InsecureSkipVerify: true }
+ tls.Config{ InsecureSkipVerify: true, MinVersion: tls.VersionTLS13 }

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b8f5ca0 and 96db8c1.

Files selected for processing (1)

driver_test.go (1 hunks)

Additional comments not posted (3)

driver_test.go (3)

3356-3361: This test for the driver name is correctly implemented.

Line range hint 3362-3375: The test for creating a new connector and establishing a database connection is correctly implemented.

Line range hint 3376-3408: The test for connector timeouts during connection opening is correctly implemented.

methane · 2024-05-22T09:26:31Z

Please provide background information when you are proposing some new API.

Why do you need it?
Does the database/sql/driver recommend it?
Any other drivers provide it?

demoManito · 2024-05-22T10:34:06Z

Please provide background information when you are proposing some new API.

Why do you need it? Does the database/sql/driver recommend it? Any other drivers provide it?

hello @methane

Why do you need it?

When we create a link every time we need to enter it manually (for example: sql.Open("mysql", dsn)). the driver name you specify may be different from the name in the driver. If you don’t read the source code, the driver name is It is opaque, so the driver needs to provide a method to obtain the default driver name.

Use cases?

Use sql.Open(mysql.DriverName(), dsn). Or you can use ent.Open(mysql.DriverName(), dsn) when opening with ORM. I think this is a better way to call.

Any other drivers provide it?

These are some Java drivers that can get the driver name. Golang drivers rarely expose drivers.
https://github.com/xerial/sqlite-jdbc/blob/ce109578d710e696ddc8ddae119bfd8f6f455a82/src/main/java/org/sqlite/jdbc3/JDBC3DatabaseMetaData.java#L222
https://github.com/pgjdbc/pgjdbc/blob/450488c142fdc368cab54e8257407603acc18c4f/pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java#L170

demoManito · 2024-05-22T10:41:29Z

Please provide background information when you are proposing some new API.

Why do you need it? Does the database/sql/driver recommend it? Any other drivers provide it?

And driverName can be changed through build parameters. If the driver name is manually specified by an external layer, the code needs to be modified and rebuilt. Providing an externally exposed method to obtain driverName can solve these problems.

methane · 2024-05-22T11:19:49Z

Why driver.Connector() is not enough?
If you want to directly depends on specific driver, you can use the Connector.
If you want to avoid to depends on specific driver, you can not use mysql.DriverName().

And if it is common requirements, any preceding driver implement it?

demoManito · 2024-05-22T11:43:47Z

Why driver.Connector() is not enough? If you want to directly depends on specific driver, you can use the Connector. If you want to avoid to depends on specific driver, you can not use mysql.DriverName().

And if it is common requirements, any preceding driver implement it?

Drivers in other languages have functions to obtain the provided driver name. Why only focus on the go language?

Would providing a function to get the default driver name cause any ill effects?

demoManito · 2024-05-22T11:52:30Z

Why driver.Connector() is not enough? If you want to directly depends on specific driver, you can use the Connector. If you want to avoid to depends on specific driver, you can not use mysql.DriverName().

And if it is common requirements, any preceding driver implement it?

Do you think ORM directly declaring mysql is a good choice? This is a common problem faced by many ORMs

methane · 2024-05-22T11:54:10Z

Drivers in other languages have functions to obtain the provided driver name. Why only focus on the go language?

Because they don't use database/sql. This problem is tightly coupled with database/sql design.

Are there any problems with getting the default driver name provided here?

Any one public API has maintenance cost. We cannot remove or change its signature until v2.
Unless the problem trying to solve is not specific to this driver or MySQL, we want to chose standard or common API.
That's why I am asking earlier implementations of the API in the other popular drivers.

methane · 2024-05-22T11:56:03Z

Do you think ORM directly declaring mysql is a good choice? This is a common problem faced by many ORMs

Yes. Changing the linkname is very uncommon. So directly use "mysql" doesn't have any problem.

dolmen · 2024-06-14T13:00:39Z

If the driver is registered via an alternate name, the developer who builds the program is aware of it and can provide it to anyone who needs it. We don't need to expose that flawed API in the driver.

By the way, it is also possible:

to not register the MySQL driver at all
to register the MySQL driver multiple times under multiple names
to write an alternate driver (probably with an alternate name) that returns a MySQL connector. Example: https://github.com/dolmen-go/mylogin-driver/blob/c72fdf8573ffba5c3def2f3d11e551a3292a0c91/driver.go#L42

The proposed API doesn't handle those cases.

So I'm completely opposed to that change.

Disclaimer: I'm the author patch #1499 that allows to change the driver name

Add function to get the driver name

b8f5ca0

demoManito changed the title ~~Add function to get the driver name~~ add function to get the driver name May 22, 2024

fix test func name

96db8c1

coderabbitai bot reviewed May 22, 2024

View reviewed changes

demoManito added 2 commits May 22, 2024 17:18

add AUTHORS

7ca57bd

add AUTHORS

08013ac

demoManito closed this Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add function to get the driver name #1591

add function to get the driver name #1591

demoManito commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

Rate Limit Exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

methane commented May 22, 2024

demoManito commented May 22, 2024 •

edited

Loading

demoManito commented May 22, 2024

methane commented May 22, 2024

demoManito commented May 22, 2024 •

edited

Loading

demoManito commented May 22, 2024

methane commented May 22, 2024

methane commented May 22, 2024

dolmen commented Jun 14, 2024 •

edited

Loading

add function to get the driver name #1591

add function to get the driver name #1591

Conversation

demoManito commented May 22, 2024 • edited Loading

Description

Checklist

coderabbitai bot commented May 22, 2024 • edited Loading

Rate Limit Exceeded

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

methane commented May 22, 2024

demoManito commented May 22, 2024 • edited Loading

Why do you need it?

Use cases?

Any other drivers provide it?

demoManito commented May 22, 2024

methane commented May 22, 2024

demoManito commented May 22, 2024 • edited Loading

demoManito commented May 22, 2024

methane commented May 22, 2024

methane commented May 22, 2024

dolmen commented Jun 14, 2024 • edited Loading

demoManito commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

demoManito commented May 22, 2024 •

edited

Loading

demoManito commented May 22, 2024 •

edited

Loading

dolmen commented Jun 14, 2024 •

edited

Loading