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
Add example #215
Add example #215
Conversation
and Microsoft SQL Server is a work in progress. A subset of compiler features are available for | ||
these databases. See the [SQL](#sql) section for more details. | ||
## Features | ||
* **Databases and Query Languages:** We currently support a single database, OrientDB version 2.2.28+, and two query languages that OrientDB supports: the OrientDB dialect of gremlin, and OrientDB's own custom SQL-like query language that we refer to as MATCH, after the name of its graph traversal operator. With OrientDB, MATCH should be the preferred choice for most users, since it tends to run faster than gremlin, and has other desirable properties. See the Execution model section for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docs are a bit inconsistent. Here we say We currently support a single database, OrientDB
, but later in the SQL
section we say Relational databases are supported by compiling to SQLAlchemy
. @jmeulemans should we update this section to include SQL
as a backend, or do we wait for your branch to merge into master before we do that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an outstanding branch with the prototype SQL compiler, but that won't ever merge. The docs here are accurate, why are we removing the SQL details?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am sorry. I deleted the SQL details by mistake. Let me fix that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are your thoughts on including the example in the README? We should make a decision as to where examples go just for consistency, my SQL example should be moved out of the README if we think files are the better route.
Unless someone else has strong feelings otherwise, I'd probably keep the examples in the README for now, since I like having all info in one place when I open a new project's Github. @pmantica1, I'm a bit confused about this PR though -- it seems to be making a lot of (seemingly to me) unrelated changes: changes in test setup code, in adding GraphQL syntax highlighting, in docstrings across the codebase, adding more content to the README, and reordering existing README content. For the sake of easier reviewing and more focused discussion, would you mind splitting up these changes into smaller PRs that do one thing at a time? |
No description provided.