v6 docs updates #4195

SpencerKaiser · 2023-04-06T18:36:05Z

Adding a warning icon to the upgrade notes about typescript
Separating .load into a dedicated section for clarity
Removing stale references to BaseEntity

B4nan · 2023-04-06T18:37:20Z

i just finished rebasing v6, sry about that

SpencerKaiser · 2023-04-06T18:59:06Z

Sorry about the mess of commits; I'm not really sure what I can do on my end to clean up that history aside from making a new branch. If you'd prefer that, let me know, but I imagine you're squash merging anyways.

codecov · 2023-04-06T19:08:27Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (9c3e4c4) 99.48% compared to head (8ed9a4b) 99.48%.

❗ Current head 8ed9a4b differs from pull request most recent head 728c693. Consider uploading reports for the commit 728c693 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##               v6    #4195   +/-   ##
=======================================
  Coverage   99.48%   99.48%           
=======================================
  Files         219      219           
  Lines       14361    14361           
  Branches     3277     3277           
=======================================
  Hits        14287    14287           
  Misses         73       73           
  Partials        1        1

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

B4nan · 2023-04-06T19:26:05Z

Reset the changes, stash it and create new branch from v6.

B4nan · 2023-04-06T19:26:23Z

Or in the end, I will be squash merging, so as long as I can do that, it should be fine.

B4nan · 2023-04-06T19:31:39Z

docs/docs/type-safe-relations.md

+const author = await book2.author.load();
+author.name; // sync safe access


this is not really sync-safe access - that is the $ property from Loaded type. those two examples are doing exactly the same, both using the return value of the ref.load() method

Yea I struggled with the verbiage there; what I was trying to highly was that you can save a copy of the newly loaded entity... if you'd prefer to have only one of the two, I'd advocate for the second as I think it's clearer. Thoughts?

SpencerKaiser · 2023-04-06T19:52:41Z

I just deleted the local branch, created a new one from your v6, cherry-picked, and force pushed... all clean now 😬

SpencerKaiser · 2023-04-06T22:58:37Z

@B4nan FYI I added a new section; I just tried to create a migrations after upgrading as a sanity check and it tried to generate a migration switching everything from timestampz(0) to timestampz. If that was intentional (I'm assuming it was), there's now a comment in the upgrading doc.

docs/docs/upgrading-v5-to-v6.md

SpencerKaiser · 2023-04-13T15:19:06Z

@B4nan just added the mention about discouraging the use of eager with large collections. Anything else you'd like in this PR?

B4nan · 2023-04-20T14:51:22Z

docs/docs/decorators.md

+|--------------|------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `entity`     | `string` &#124; `() => EntityName` | yes | Set target entity type.                                                                                                           |
+| `cascade`    | `Cascade[]` | yes | Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)).|
+| `eager`      | `boolean` | yes | Always load the relationship. (Discouraged for use with large collections)                                                                                 |


maybe better this way? i would really discourage it for any to-many relations, simply because any collection can get large over time, turning this into a timebomb basically.

Suggested change

| `eager` | `boolean` | yes | Always load the relationship. (Discouraged for use with large collections) |

| `eager` | `boolean` | yes | Always load the relationship. (Discouraged for use with to-many relations.) |

docs/docs/upgrading-v5-to-v6.md

B4nan

one last nit, and we can merge 👍

docs/docs/decorators.md

Adding a warning icon to make the header more obvious Removing stale references to BaseEntity Adding a section dedicated to .load Adding a comment about the changing default for timestamps Adding note to discourage eager with large collections Co-authored-by: Martin Adámek <banan23@gmail.com>

SpencerKaiser · 2023-04-21T17:14:50Z

docs/docs/decorators.md

+|--------------|------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `entity`     | `string` &#124; `() => EntityName` | yes | Set target entity type.                                                                                                           |
+| `cascade`    | `Cascade[]` | yes | Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)).|
+| `eager`      | `boolean` | yes | Always load the relationship. (Discouraged for use with to-many relations.)                                                                                 |


@B4nan do the periods there bug you? If so, I can fix

docs/docs/upgrading-v5-to-v6.md

- Adding a warning icon to the upgrade notes about typescript - Separating `.load` into a dedicated section for clarity - Removing stale references to `BaseEntity` <img width="1139" alt="image" src="https://user-images.githubusercontent.com/6445731/230470881-5a2b8e24-685b-4029-9737-1ca36792c079.png"> --------- Co-authored-by: Martin Adámek <banan23@gmail.com>

SpencerKaiser marked this pull request as ready for review April 6, 2023 18:58

SpencerKaiser changed the title ~~V6 docs updates~~ v6 docs updates Apr 6, 2023

B4nan reviewed Apr 6, 2023

View reviewed changes

SpencerKaiser force-pushed the v6-docs branch from 0519206 to 081cc6a Compare April 6, 2023 19:46

B4nan reviewed Apr 7, 2023

View reviewed changes

docs/docs/upgrading-v5-to-v6.md Outdated Show resolved Hide resolved

B4nan reviewed Apr 7, 2023

View reviewed changes

docs/docs/upgrading-v5-to-v6.md Outdated Show resolved Hide resolved

B4nan force-pushed the v6 branch 2 times, most recently from 5165c10 to c8676e7 Compare April 12, 2023 17:50

SpencerKaiser force-pushed the v6-docs branch 9 times, most recently from 6832e20 to e98a184 Compare April 18, 2023 15:37

SpencerKaiser requested a review from B4nan April 18, 2023 15:37

B4nan reviewed Apr 20, 2023

View reviewed changes

B4nan approved these changes Apr 21, 2023

View reviewed changes

docs/docs/decorators.md Show resolved Hide resolved

SpencerKaiser force-pushed the v6-docs branch from 6bf21c6 to 8ed9a4b Compare April 21, 2023 17:13

SpencerKaiser requested a review from B4nan April 21, 2023 17:14

SpencerKaiser commented Apr 21, 2023

View reviewed changes

B4nan reviewed Apr 21, 2023

View reviewed changes

docs/docs/upgrading-v5-to-v6.md Outdated Show resolved Hide resolved

Update docs/docs/upgrading-v5-to-v6.md

728c693

B4nan merged commit bc820e8 into mikro-orm:v6 Apr 21, 2023
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v6 docs updates #4195

v6 docs updates #4195

SpencerKaiser commented Apr 6, 2023 •

edited

B4nan commented Apr 6, 2023

SpencerKaiser commented Apr 6, 2023

codecov bot commented Apr 6, 2023 •

edited

B4nan commented Apr 6, 2023

B4nan commented Apr 6, 2023

B4nan Apr 6, 2023

SpencerKaiser Apr 6, 2023

SpencerKaiser commented Apr 6, 2023

SpencerKaiser commented Apr 6, 2023

SpencerKaiser commented Apr 13, 2023 •

edited

B4nan Apr 20, 2023

B4nan left a comment

SpencerKaiser Apr 21, 2023

		const author = await book2.author.load();
		author.name; // sync safe access

	\| `eager` \| `boolean` \| yes \| Always load the relationship. (Discouraged for use with large collections) \|
	\| `eager` \| `boolean` \| yes \| Always load the relationship. (Discouraged for use with to-many relations.) \|

v6 docs updates #4195

v6 docs updates #4195

Conversation

SpencerKaiser commented Apr 6, 2023 • edited

B4nan commented Apr 6, 2023

SpencerKaiser commented Apr 6, 2023

codecov bot commented Apr 6, 2023 • edited

Codecov Report

B4nan commented Apr 6, 2023

B4nan commented Apr 6, 2023

B4nan Apr 6, 2023

Choose a reason for hiding this comment

SpencerKaiser Apr 6, 2023

Choose a reason for hiding this comment

SpencerKaiser commented Apr 6, 2023

SpencerKaiser commented Apr 6, 2023

SpencerKaiser commented Apr 13, 2023 • edited

B4nan Apr 20, 2023

Choose a reason for hiding this comment

B4nan left a comment

Choose a reason for hiding this comment

SpencerKaiser Apr 21, 2023

Choose a reason for hiding this comment

SpencerKaiser commented Apr 6, 2023 •

edited

codecov bot commented Apr 6, 2023 •

edited

SpencerKaiser commented Apr 13, 2023 •

edited