orientechnologies / orientechnologies/orientdb-docs
SQL Reference page's "JOINs" section is misleading/lacking
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 59
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
In the JOINs section of the SQL Reference page, the only method mentioned is "dot notation". The examples compare a typical SQL join of two different tables to the OrientDB concept of accessing an object that is linked with a LINK property from the parent object. First, to a new reader, it's not exactly clear that that is what's happening, so I think a quick schema definition of the classes involved would help a lot there. Second, accessing related vertices via edges is not mentioned. I think it would be tremendously helpful to at least link to the functions that allow a query to traverse edges, such as in(), out(), and both().
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the JOINs section of the linked SQL Reference page. Clarify the schema behind the dot-notation examples and add links to the in(), out(), and both() functions; done means the section explains the relationship model and points readers to edge traversal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100