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 In-Depth Explanation for Database Adapter Models #12018

Open
User5842 opened this issue Oct 10, 2024 · 3 comments
Open

Add In-Depth Explanation for Database Adapter Models #12018

User5842 opened this issue Oct 10, 2024 · 3 comments
Labels
docs Relates to documentation good first issue Good issue to take for first time contributors

Comments

@User5842
Copy link

What is the improvement or update you wish to see?

I'd like to see a more in-depth explanation of the models used for the database adapters. I don't want to speak for everyone else, but I am curious if most of us simply copy the models, paste them into our code base, and forget about them. That's great for quick prototyping and getting things up and running, but I'd like to understand why those models are used, why they are necessary, why the specific data types and relations were chosen, etc. Either way, Auth.js is a fantastic tool, and I am excited about its future. Thanks!

Is there any context that might help us understand?

I don't have anything extra to add. I hope the above was clear enough, but I would happily add more if the team needs it; thank you.

Does the docs page already exist? Please link to it.

https://authjs.dev/getting-started/adapters/prisma

@User5842 User5842 added the triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. label Oct 10, 2024
@balazsorban44
Copy link
Member

balazsorban44 commented Oct 10, 2024

Hi @User5842, the full explanation is here https://authjs.dev/guides/creating-a-database-adapter

Maybe the guide name is confusing. 🤔

Other than that, it should give you a breakdown of every model, what adapter functions they relate to, how to expand the data with custom fields, and which one of them you need for certain functionality.

Anything missing there though in your opinion?

@balazsorban44 balazsorban44 added docs Relates to documentation good first issue Good issue to take for first time contributors and removed triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. labels Oct 15, 2024
@balazsorban44
Copy link
Member

@User5842 what do you think about the above?

@User5842
Copy link
Author

Whoops, sorry for the delay in responding! That document looks excellent; thanks for linking me to it. I must have missed it while looking through the documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Relates to documentation good first issue Good issue to take for first time contributors
Projects
None yet
Development

No branches or pull requests

2 participants