Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for MariaDB users #5706

Closed
wants to merge 2 commits into from
Closed

Conversation

ottok
Copy link
Contributor

@ottok ottok commented Mar 10, 2024

Describe this PR

I have never used Prisma before, and it took me quite a lot of extra effort to figure out if Prisma supports MariaDB at all because the documentation was only mentioning MySQL. After some digging, I found that indeed Prisma uses both https://www.npmjs.com/package/mariadb for the connector and https://hub.docker.com/_/mariadb as part of the CI, and MariaDB support is actually excellent.

Sequalize has very clear MariaDB documentation, and if you merge this PR then Prisma will be on-par.

Changes

Each commit is atomic and carefully documented - please review this PR by looking commit-by-commit looking at the message and the change at the same time.

Looking at git log in 500-databases and e.g. 4358a41 seems you prefer to squash when merging. Please merge this PR as-is without squashing to avoid loosing the per-commit documentation.

I am also happy to iterate on the contents of this PR based on your feedback. I am also happy to rebase frequently.

Copy link

vercel bot commented Mar 10, 2024

@ottok is attempting to deploy a commit to the Prisma Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Member

@janpio janpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is the best way to mention MariaDB in our docs, so I am using "Request changes" as a way to prevent an accidental merge.

We should find a more lightweight way to make sure our users can know that for us MariaDB and MySQL are the same.

@ottok
Copy link
Contributor Author

ottok commented Mar 11, 2024 via email

Copy the MySQL doc without any changes so that git can be properly used
to track the history of the file (e.g. `git log --follow` and
`git blame -C -C -C`) and also to make sure the next commits will clearly
show how the MariaDB doc deviates from the MySQL doc.
The existing page about MySQL does not mention MariaDB at all, and thus it
is unclear to users of MariaDB if Prisma properly supports MariaDB or not.
With a new MariaDB-specific page it is easy for users to find that Prisma
does indeed support MariaDB, and even has MariaDB in the CI for Prisma.

Creating two separate pages for MySQL and MariaDB is useful as future
versions of MySQL 8.4 and MariaDB 11.5 are likely to start diverging and
thus Prisma users need to have separate pages that give them instructions
that are guaranteed to work specifically with the database they use.
@ottok
Copy link
Contributor Author

ottok commented Mar 22, 2024

Closing this as #5713 was merged.

@ottok ottok closed this Mar 22, 2024
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.

None yet

2 participants