Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start with the Concepts / Elements of the Database documentation and the JavaDoc for AbstractDbData and its subclasses. Make the data-snapshot purpose and the guidance to create a new Table after database updates explicit; done when readers are unlikely to interpret Table as a reloadable data object.
Written by the indexing model from the issue text.
Description
Dear AssertJ-DB team, Dear Joel,
I found one of my friends wrapping Table to allow for a "data reload feature". As I understand the JavaDoc of that class, the intended purpose of this class and the sibling AbstractDbData subclasses is to hold a snapshot of DB data and provide a fluent assertion API for this data snapshot.
The web site http://joel-costigliola.github.io/assertj/assertj-db-concepts.html states for e. g. Table and Request, that these objects represent a "Table in" or a "Request on" the database.
This probably misled my friend (who has a decent background in RDBMS) into thinking that a Table object could / should also be used in more complex query/update scenarios, whereas its original purpose is "only" to contain the data snapshot used for upcoming fluent assertions.
Would it be possible to make this intention of holding a data snapshot from different sources (Table, Request) more explicit in the "Concepts" / "Elements of the Database" page, maybe a "Caution" paragraph elaborating a bit on this? In particular, I consider a hint like "If you need to re-load data after DB update operations, please create a new Table instance" very useful.
Looking forward to your feedback. Thanks in advance & keep up the good work. Very much appreciated.
- Dominant language
- Java
- Stars
- 130
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from assertj/assertj-db
-
assertj/assertj-db#324 · 1 comment · 1 assignee ·
-
question
Difficulty 3/5 1-2 days Newbie friendliness 32/100
assertj/assertj-db#292 · 1 comment ·
-
question
Difficulty 3/5 1-2 days Newbie friendliness 35/100
assertj/assertj-db#290 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
assertj/assertj-db#259 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
assertj/assertj-db#206 ·
All issues in assertj/assertj-db
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cryptomator/hub#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
johanhaleby/occurrent#1120 ·