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

Feature: Get a list of all available records/events/rpcs #1101

Closed
redlock opened this issue Mar 24, 2021 · 6 comments
Closed

Feature: Get a list of all available records/events/rpcs #1101

redlock opened this issue Mar 24, 2021 · 6 comments

Comments

@redlock
Copy link
Contributor

redlock commented Mar 24, 2021

Hello,
A much needed use case that I often face is to query the server for a list of available records (or other objects). Currently I can't find a way to do it. It helps a lot for debugging while in development; to see if a record was created and why some record is missing (record name misspelled, etc).
Some metadata that can come along with the query, such as when the record was created and when it was last updated and the size of the record.

Thanks

@slachtar
Copy link
Contributor

slachtar commented Mar 24, 2021 via email

@redlock
Copy link
Contributor Author

redlock commented Mar 24, 2021

Hi,
Right now my clients connect to a metadata server to get a list of records that they can subscribe to. This metadata server won't be needed if I can simply query Deepstream for all available records. Also, sometimes you can't find a record and the reason is because there was a typo or the record name is different in some minor way. Having a list of available records you can quickly see where the fault lies.

Another use case is while in development you want to test whether you can subscribe to a record in your dev Deepstream instance, but you aren't sure what records are available (because it is a dev server use for testing). Every time I face this scenario I have to either guess the records name from memory or start some other client to create a new record.

Implementation wise it does seem like an easy feature to add.

@slachtar
Copy link
Contributor

slachtar commented Mar 24, 2021 via email

@yasserf
Copy link
Contributor

yasserf commented Mar 24, 2021

So the server already contains all of this logic inside of the state registries, the easiest thing to do would be to add a HTTP request that just dumps it out if the correct auth token is there. That way you don't need to add anything to clients or realtime protocols.

@redlock
Copy link
Contributor Author

redlock commented Mar 25, 2021

Another use case is that this allows for creating an admin console for a Deepstream server. Someone can build something similar to Firebase admin console, where you can inspect, browse and update data in a nifty web ui.

@jaime-ez
Copy link
Collaborator

jaime-ez commented Apr 5, 2021

Hi, if someone want's to implement this please make a pull request following yasser suggestion.
Thanks!

@jaime-ez jaime-ez closed this as completed Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants