SeaQL / SeaQL/sea-orm

db.get_schema_registry("my_crate::entity::*") issue

Open
#2,899 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
9.9k
Forks
734
Avg merge
6h 36m
Merged PRs (30d)
8

Description

The documentation, for the EntityFirst approach, states that the schema_registry should be done with a ::* at the end, but this breaks registration:

// synchronizes database schema with entity definitions
db.get_schema_registry("my_crate::entity::*").sync(db).await?;

But the code that does the registration uses .starts_with:

    for entity in inventory::iter::<EntityRegistry>() {
        if entity.module_path.starts_with(module_path) {

it took me a while to figure out why nothing was working and I had to dig deep in code.
There are two fixes that might be worh.:

1 - fix the documentation (and blogposts) to remote the ::*
2 - add a print to stderr saying that the module path is unexpected, to help the development process.

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

Start by locating the EntityFirst documentation and blog posts that show db.get_schema_registry("my_crate::entity::*"), then compare those examples with the registration path that uses starts_with. Done means the published examples match the observed registration behavior and the issue's proposed stderr warning is resolved as an explicit decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
database, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.