feat: update examples and dependencies for pytidb version 0.0.13.dev8

- Updated `.env.example` files across various examples to reflect new database names.
- Modified `reqs.txt` files in examples to use the latest `pytidb` version 0.0.13.dev8.
- Added a new rule in `.cursor/rules/update-examples.mdc` for updating `pytidb` dependencies in example projects.
- Introduced a custom embedding example using the BGE-M3 model in `examples/custom_embedding`.
- Refactored existing examples to ensure compatibility with the latest changes in the `pytidb` library.
- Enhanced README files to provide clearer instructions and updated information.

Author: Mini256

.cursor/rules/update-examples.mdc

@@ -0,0 +1,27 @@
+---
+alwaysApply: false
+---
+
+Update the `pytidb` dependency in all example projects (e.g., `examples/auto_embedding/reqs.txt`) and verify that they work with the latest version.
+
+### Steps
+
+1. List all examples
+2. Using `todo_write` tool to add each example to the ToDo list.
+3. Process each example as following steps one by one.
+   1. Check the latest `pytidb` version in `pyproject.toml`.
+   2. Update the `reqs.txt` files accordingly.
+   3. Create a virtual environment (If not exists):
+
+      ```bash
+      python -m venv .venv
+      source .venv/bin/activate
+      ```
+
+   4. Install dependencies:
+
+      ```bash
+      pip install -q -r reqs.txt
+      ```
+
+   5. Run the example entry point (python main.py or streamlit run app.py) to confirm functionality.

.gitignore

@@ -172,3 +172,6 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# Claude
+.claude/settings.local.json

examples/auto_embedding/.env.example

@@ -3,7 +3,7 @@ TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
 TIDB_PORT=4000
 TIDB_USERNAME={prefix}.root
 TIDB_PASSWORD={password}
-TIDB_DATABASE=test
+TIDB_DATABASE=auto_embedding_example
 
 EMBEDDING_PROVIDER=tidbcloud_free # No API key required
 OPENAI_API_KEY=

examples/auto_embedding/README.md

@@ -39,7 +39,7 @@ TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
 TIDB_PORT=4000
 TIDB_USERNAME={prefix}.root
 TIDB_PASSWORD={password}
-TIDB_DATABASE=test
+TIDB_DATABASE=auto_embedding_example
 
 # Using TiDB Cloud Free embedding model by default, which is no required to set up any API key
 EMBEDDING_PROVIDER=tidbcloud_free
@@ -56,7 +56,7 @@ python main.py
 
 ```plain
 === Define embedding function ===
-Embedding function (model id: tidbcloud_free/amazon/titan-embed-text-v2) defined
+Embedding function (model name: tidbcloud_free/amazon/titan-embed-text-v2) defined
 
 === Define table schema ===
 Table created

examples/auto_embedding/main.py

@@ -14,7 +14,7 @@
     port=int(os.getenv("TIDB_PORT", "4000")),
     username=os.getenv("TIDB_USERNAME", "root"),
     password=os.getenv("TIDB_PASSWORD", ""),
-    database=os.getenv("TIDB_DATABASE", "pytidb_auto_embedding"),
+    database=os.getenv("TIDB_DATABASE", "auto_embedding_example"),
     ensure_db=True,
 )
 
@@ -86,7 +86,7 @@
 else:
     raise ValueError(f"Invalid embedding provider: {provider}")
 
-print(f"Embedding function (model id: {embed_func.model_name}) defined")
+print(f"Embedding function (model name: {embed_func.model_name}) defined")
 
 # Define table schema
 print("\n=== Define table schema ===")

examples/auto_embedding/reqs.txt

@@ -1,3 +1,3 @@
-pytidb==0.0.12
-pytidb[models]==0.0.12
+pytidb==0.0.13.dev8
+pytidb[models]==0.0.13.dev8
 python-dotenv

examples/basic/.env.example

@@ -3,4 +3,4 @@ TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
 TIDB_PORT=4000
 TIDB_USERNAME={prefix}.root
 TIDB_PASSWORD={password}
-TIDB_DATABASE=test
+TIDB_DATABASE=basic_example

examples/basic/README.md

@@ -38,7 +38,7 @@ TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
 TIDB_PORT=4000
 TIDB_USERNAME={prefix}.root
 TIDB_PASSWORD={password}
-TIDB_DATABASE=test
+TIDB_DATABASE=basic_example
 EOF
 ```
 

examples/basic/main.py

@@ -15,7 +15,7 @@
     port=int(os.getenv("TIDB_PORT", "4000")),
     username=os.getenv("TIDB_USERNAME", "root"),
     password=os.getenv("TIDB_PASSWORD", ""),
-    database=os.getenv("TIDB_DATABASE", "pytidb_basic"),
+    database=os.getenv("TIDB_DATABASE", "basic_example"),
     ensure_db=True,
 )
 

examples/basic/reqs.txt

@@ -1,2 +1,2 @@
-pytidb==0.0.10.post1
+pytidb==0.0.13.dev7
 python-dotenv