SeaQL / SeaQL/seaql.github.io

Documentation still features Expr::tbl though it's been removed since Dec 2022

Open
#112 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
24
Forks
68
PR merge metrics
No merged PRs in 30d

Description

Description

The custom joins documentation suggests the use of the function Expr::tbl though it has been removed in 2022.

See here: https://www.sea-ql.org/SeaORM/docs/advanced-query/custom-joins/

Expected Behavior

Since it has been replaced, we should use Expr::col with a tuple to mimic the once intended behavior.

Actual Behavior

The documented code does not work, and the tbl function is out of the documentation, way past deprecation

Versions

Haven't looked, but as aforementionned, the breaking change has been done in december 2022.

Additional Information

I am in quite the hurry right now working on a project, but I can/will change the doc once I am done with my current work.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the custom joins documentation page linked in the issue and search for uses of Expr::tbl. Replace the outdated example with Expr::col using a tuple as described, then check the page for any remaining references to tbl and confirm the documented code matches the current SeaORM API.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.