-
Notifications
You must be signed in to change notification settings - Fork 696
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: EXPOSED-532 Split the DAO topic into subtopics #2254
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Split looks good to me. Left some comments.
<include from="DAO-Table-Types.topic" element-id="dao-table-example-sql"/> | ||
</tab> | ||
</tabs> | ||
<chapter title="Configuring a custom table name" id="name-from-object"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a thought about content for the future (outside the scope of this PR):
We should probably have a section similar to this for all Exposed naming conventions during table definition, but at minimum definitely for column names.
For example, quite a few sample code blocks use a column registered as varchar("name", 50)
, so when we show related SQL (using H2) it translates to "name" VARCHAR(50)
. Users may not get the implication that Exposed auto-quotes (& retains case-sensitivity of) all keywords used as names. This would probably be a prudent addition somewhere later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, I created a new issue for this at EXPOSED-571 so we don't forget.
documentation-website/Writerside/topics/DAO-CRUD-Operations.topic
Outdated
Show resolved
Hide resolved
<chapter title="Auto-fill created and updated columns on entity change" id="auto-fill-created-and-updated-columns-on-entity-change"> | ||
<p>See example by @PaulMuriithi <a href="https://github.com/PaulMuriithi/ExposedDatesAutoFill/blob/master/src/main/kotlin/app/Models.kt">here</a>.</p> | ||
</chapter> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Outside this PR, if you think it's worth doing, we could rewrite this using our own sample code and avoid having to link externally. Would probably be a good opportunity to include content on table/entity inheritance and interceptors, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, we should definitely do something about this. I created a new issue at EXPOSED-572. If you could help with writing the sample, it would be great 🙏
086dfce
to
381649d
Compare
Description
Split the 'Deep dive into DAO' topic into the following new subtopics:
Because of the newly introduced 'Table types' subtopic for DAO, I made some changes to the topics covering table definition as well (as described in EXPOSED-535). These changes aim to improve clarity and interlinking of the relevant topics.
Note: The content in 'Field transformation' seems to be outdated, but I will cover this in a separate PR.
Type of Change
Checklist
Related Issues
EXPOSED-532
EXPOSED-535