Skip to content

docs: use tidb_client.db_engine in README example (fixes #193)#195

Closed
haseebpvt wants to merge 1 commit intopingcap:mainfrom
haseebpvt:docs/fix-readme-engine
Closed

docs: use tidb_client.db_engine in README example (fixes #193)#195
haseebpvt wants to merge 1 commit intopingcap:mainfrom
haseebpvt:docs/fix-readme-engine

Conversation

@haseebpvt
Copy link
Copy Markdown
Contributor

Fixes #193

The README previously used an undefined engine variable in the
"Join Structured and Unstructured Data" example.

This change updates the code example to use tidb_client.db_engine,
making the example explicit and reducing confusion for new users.

Example after fix:

# Use the db_engine from TiDBClient when creating a Session
with Session(tidb_client.db_engine) as session:
    query = (
        select(Chunk)
        .join(User, Chunk.user_id == User.id)
        .where(User.name == "Alice")
    )
    chunks = session.exec(query).all()

@haseebpvt haseebpvt force-pushed the docs/fix-readme-engine branch 3 times, most recently from f7d8658 to e8ba100 Compare September 11, 2025 08:04
@haseebpvt haseebpvt force-pushed the docs/fix-readme-engine branch from e8ba100 to ad7aa1f Compare September 11, 2025 08:11
@haseebpvt
Copy link
Copy Markdown
Contributor Author

Somehow, even after adding the signing keys, my commits are still not showing the “Verified” badge. I’ll try one last time by closing this PR and reopening it from a fresh branch, since I’m not sure if the issue is related to all commits needing to be signed.

@haseebpvt haseebpvt closed this Sep 11, 2025
@haseebpvt haseebpvt deleted the docs/fix-readme-engine branch September 17, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Replace engine with tidb_client.db_engine in Join Structured and Unstructured Data example

1 participant