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

Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly #56

Open
ansgarkonermann opened this issue Sep 25, 2018 · 1 comment

Comments

@ansgarkonermann
Copy link

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.

@joel-costigliola
Copy link
Member

@ansgarkonermann I'm not really involved in that module, @regis1512 is the man!

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

No branches or pull requests

2 participants