Skip to content

Document how to replace the SqlClientPool using services #157

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

Closed
DavideD opened this issue May 21, 2020 · 7 comments
Closed

Document how to replace the SqlClientPool using services #157

DavideD opened this issue May 21, 2020 · 7 comments
Labels

Comments

@DavideD
Copy link
Member

DavideD commented May 21, 2020

Now that we have #155 we need to remember to add an explanation with example on how to do that in the documentation (When we start to work on one)

@DavideD DavideD added the documentation Words label May 21, 2020
@gavinking
Copy link
Member

Yes, I agree, but perhaps we need to be a little bit careful about that because I'm not sure that the ReactiveConnection interface is 100% cooked. In principle, future changes to it could break user code.

So I was thinking of leaving it undocumented for now, and just having it there so that people who ask for it explicitly can be pointed to it with a big caveat that they should not rely on it not breaking.

@DavideD
Copy link
Member Author

DavideD commented May 21, 2020

Sounds good. It's not something we need immediately.

ORM uses some annotation to highlight features that are quite experimental and might change in the future. We can introduce something similar.

I will just keep the issue as a reminder for when we release the first final.
I would like to have at least a test for this at some point.

@gavinking
Copy link
Member

ORM uses some annotation to highlight features that are quite experimental and might change in the future. We can introduce something similar.

That sounds like a good idea.

But why can't we just use the same annotations? We already have a hard dependency on Hibernate ORM.

@DavideD
Copy link
Member Author

DavideD commented May 21, 2020

Yes, of course :)
The annotation is @Incubating

@gavinking
Copy link
Member

@DavideD would you consider it sufficient documentation that this is described in the Javadoc for ReactiveConnectionPool, including a code example?

@DavideD
Copy link
Member Author

DavideD commented May 27, 2020

ok

@gavinking
Copy link
Member

ok

soooo .... does that mean we can close this? :-)

@DavideD DavideD closed this as completed May 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants