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: EXPOSED-532 Split the DAO topic into subtopics #2254

Merged
merged 11 commits into from
Sep 27, 2024

Conversation

vnikolova
Copy link
Collaborator

@vnikolova vnikolova commented Sep 25, 2024

Description

Split the 'Deep dive into DAO' topic into the following new subtopics:

  1. Table Types
  2. CRUD operations
  3. Relationships
  4. Field transformations

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

  • Documentation update

Checklist

  • The build is green (including the Detekt check)

Related Issues

EXPOSED-532
EXPOSED-535

@vnikolova vnikolova requested review from bog-walk and e5l September 25, 2024 13:54
Copy link
Member

@bog-walk bog-walk left a 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">
Copy link
Member

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.

Copy link
Collaborator Author

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.

Comment on lines +250 to +258
<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>
Copy link
Member

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.

Copy link
Collaborator Author

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 🙏

@vnikolova vnikolova force-pushed the vnikolova/EXPOSED-532 branch from 086dfce to 381649d Compare September 26, 2024 17:32
@vnikolova vnikolova merged commit fb98340 into main Sep 27, 2024
5 checks passed
@vnikolova vnikolova deleted the vnikolova/EXPOSED-532 branch September 27, 2024 12:54
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.

3 participants