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

Docs: ORM? #1139

Closed
bendichter opened this issue Oct 2, 2024 · 4 comments · Fixed by #1145
Closed

Docs: ORM? #1139

bendichter opened this issue Oct 2, 2024 · 4 comments · Fixed by #1145
Assignees

Comments

@bendichter
Copy link
Contributor

The docs say that DJ is an ORM

# DataJoint is an "Object-relational mapping" tool, which means that it gives us

But DJ docs disagree: https://datajoint.com/docs/core/datajoint-python/0.14/faq/#is-datajoint-an-orm

@CBroz1
Copy link
Member

CBroz1 commented Oct 2, 2024

The linked doc describes the concessions of ORMs and then discusses DJ's approach to these issues

DataJoint remains absolutely data-centric, with the primary focus on the structure and integrity of the data pipeline. Other ORMs are more application-centric, primarily focusing on the application design while the database plays a secondary role supporting the application with object persistence and sharing.

I read the answer to the question 'is it an ORM?' as 'yes, but', especially given the use of the phrase 'Other ORMs'

@bendichter
Copy link
Contributor Author

Hmm, I took the "In contrast" to imply that DJ is not an ORM, though I see your point. I think this answer is a bit ambiguous. Though IMO DJ is not an ORM because it does not map to an object structure.

@CBroz1
Copy link
Member

CBroz1 commented Oct 2, 2024

I see what you mean. I wanted to provide the concept of an ORM for first-time users in this doc, go give them a sense of where the data lived and how Spyglass would be the interface.

I suppose there's some ambiguity in saying it is an 'ORM tool' rather than claiming it is an ORM. Is there other language you'd suggest?

@edeno
Copy link
Collaborator

edeno commented Oct 2, 2024

I would suggest that 99% of people reading this in the docs don't know or care what an ORM is, so I would be okay with removing the terminology (regardless if it is correct or not).

@CBroz1 CBroz1 self-assigned this Oct 2, 2024
CBroz1 added a commit to CBroz1/spyglass that referenced this issue Oct 2, 2024
@CBroz1 CBroz1 linked a pull request Oct 2, 2024 that will close this issue
7 tasks
edeno pushed a commit that referenced this issue Oct 2, 2024
* #1138, #1139

* Update changelog
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 a pull request may close this issue.

3 participants