update prisma-adapter (#20794) #20801
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
area/tidb-cloud
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@shiyuhang0 This PR has conflicts, I have hold it. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request updates the prisma-adapter example in the documentation. The changes include updating the @prisma/client, @tidbcloud/prisma-adapter, and @tidbcloud/serverless dependencies to their latest versions. Additionally, the initialization of the Prisma Client has been updated to reflect changes in the prisma-adapter v6.6.0 and later, where the connection is now established directly using the DATABASE_URL environment variable instead of using the connect function from @tidbcloud/serverless.
Highlights
- Dependency Updates: The pull request updates the versions of
@prisma/client,@tidbcloud/prisma-adapter, and@tidbcloud/serverlessto their latest releases. - Prisma Client Initialization: The initialization of Prisma Client in the example has been updated to align with changes introduced in
@tidbcloud/prisma-adapterv6.6.0 and later, using theDATABASE_URLdirectly. - Code Simplification: The
connectfunction from@tidbcloud/serverlessis no longer needed for Prisma Client initialization with newer versions of@tidbcloud/prisma-adapter, simplifying the code.
Changelog
- tidb-cloud/serverless-driver-prisma-example.md
- Updated
@prisma/clientdependency from^5.5.2to^6.6.0. - Updated
@tidbcloud/prisma-adapterdependency from^5.5.2to^6.6.0. - Updated
@tidbcloud/serverlessdependency from^0.0.7to^0.1.0. - Updated
prismadevDependency from^5.5.2to^6.6.0. - Modified Prisma Client initialization to use
DATABASE_URLdirectly for@tidbcloud/prisma-adapterv6.6.0 and later. - Removed the import of
connectfrom@tidbcloud/serverlessas it's no longer needed.
- Updated
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Adapters connect,
Prisma to TiDB's cloud,
Data flows with ease.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
ti-chi-bot
bot
added
size/M
There was a problem hiding this comment.
Code Review
This pull request updates the @tidbcloud/prisma-adapter version in the example documentation and provides instructions for different versions of the adapter. The changes seem reasonable and improve the clarity of the documentation.
Merge Readiness
The changes look good and improve the documentation. I recommend merging this pull request after addressing the review comments. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.
| @@ -41,7 +41,9 @@ datasource db { | |||
|
|
|||
| ## Initialize Prisma Client | |||
|
|
|||
| Before using Prisma Client, you need to initialize it with `@tidbcloud/prisma-adapter`. For example: | |||
| Before using Prisma Client, you need to initialize it with `@tidbcloud/prisma-adapter`. | |||
There was a problem hiding this comment.
Consider adding a brief explanation of why different versions of @tidbcloud/prisma-adapter require different initialization methods. This would provide more context for users and help them understand the changes.
| For `@tidbcloud/prisma-adapter` v6.6.0 or a later version: | ||
|
|
||
| ```js | ||
| import { PrismaTiDBCloud } from '@tidbcloud/prisma-adapter'; | ||
| import { PrismaClient } from '@prisma/client'; | ||
|
|
||
| // Initialize Prisma Client | ||
| const adapter = new PrismaTiDBCloud({ url: ${DATABASE_URL} }); |
There was a problem hiding this comment.
The ${DATABASE_URL} syntax looks a bit odd in the code block. It might be clearer to use a placeholder like YOUR_DATABASE_URL and explain that users should replace it with their actual database URL. This will prevent confusion about whether the dollar sign and curly braces are part of the actual code.
| For `@tidbcloud/prisma-adapter` v6.6.0 or a later version: | |
| ```js | |
| import { PrismaTiDBCloud } from '@tidbcloud/prisma-adapter'; | |
| import { PrismaClient } from '@prisma/client'; | |
| // Initialize Prisma Client | |
| const adapter = new PrismaTiDBCloud({ url: ${DATABASE_URL} }); | |
| const adapter = new PrismaTiDBCloud({ url: YOUR_DATABASE_URL }); |
| @@ -187,7 +204,6 @@ To complete this tutorial, you need the following: | |||
| 1. Create a file named `hello-word.js` and add the following code to initialize Prisma Client: | |||
|
|
|||
| ```js | |||
| import { connect } from '@tidbcloud/serverless'; | |||
| import { PrismaTiDBCloud } from '@tidbcloud/prisma-adapter'; | |||
There was a problem hiding this comment.
Consider adding a comment explaining why the connect import is removed here. This will help users understand the change and avoid confusion.
|
@ti-chi-bot: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
This is an automated cherry-pick of #20794
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?