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

Interactive queries documentation #140

Closed
clvacher opened this issue Dec 1, 2023 · 3 comments
Closed

Interactive queries documentation #140

clvacher opened this issue Dec 1, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement This issue or pull request improves a feature

Comments

@clvacher
Copy link
Collaborator

clvacher commented Dec 1, 2023

Problem

Documentation on interactive queries does not showcase an actual implementation of an interactive query, leaving the users scratching their heads for it.

Suggestion

A detailled explanation on how to interact with a store in the README, at least mentioning the autowiring of the KafkaStreamsInitializer class to retrieve the kafkaStreams instance

A link to a side project (?) showcasing the feature

Additional Context

Integrating @loicgreffier 's work on the subject for internal showcases to Kstreamplify is probably a very good addition to the library.

@clvacher clvacher added documentation Improvements or additions to documentation enhancement This issue or pull request improves a feature labels Dec 1, 2023
@loicgreffier
Copy link
Collaborator

Linked with #141

@loicgreffier
Copy link
Collaborator

I definitely think that accessing the kafka streams instance should have its own documentation part in the Getting Started section as it can be use for multiple purposes, not only interactive queries. Like :

With this kind of code sample:

public class MyService {
    @Autowired
    private KafkaStreamsInitializer kafkaStreamsInitializer;

    public void doSomething() {
      kafkaStreamsInitializer.getKafkaStreams();
    }
}

@loicgreffier loicgreffier self-assigned this Dec 21, 2023
@loicgreffier
Copy link
Collaborator

Initialized by #204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement This issue or pull request improves a feature
Projects
None yet
Development

No branches or pull requests

2 participants