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

Enhance Clients And Connectors docs #299

Open
dpordomingo opened this issue Mar 6, 2019 · 0 comments
Open

Enhance Clients And Connectors docs #299

dpordomingo opened this issue Mar 6, 2019 · 0 comments
Labels
documentation empathy-sessions Issue filed as as part of empathy sessions enhancement New feature or request

Comments

@dpordomingo
Copy link
Contributor

dpordomingo commented Mar 6, 2019

discovered at https://github.com/src-d/empathy-sessions/issues/37#issuecomment-470046657
related to https://github.com/src-d/engine/issues/298

In Clients and Connectors section from docs, it is said that

to connect to the language parsing server (Babelfish) and analyzing the UAST, there are several language clients

I think it should be mentioned that:

  • it is feasible because Engine exposes gitbase and bblfsh containers under certain ports
  • gitbase is also reachable with many mysql clients

Until https://github.com/src-d/engine/issues/298 is not solved, it could be mentioned that the following workaround would run bblfsh and engine for you:

$ srcd ini
$ srcd sql "select *"

I also think it could be useful to provide some examples:

  • using native clients:
      $ mysql \
        --user=root \
        --host=127.0.0.1 \
        --port=3306 \
        --execute "SHOW tables"
  • and custom scripts, like for example using go-client and python commands like done by dpordomingo/empathy-sessions/4-engine/cmd.
@dpordomingo dpordomingo added enhancement New feature or request empathy-sessions Issue filed as as part of empathy sessions documentation labels Mar 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation empathy-sessions Issue filed as as part of empathy sessions enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant