mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 15:22:30 +00:00
Jack Ye
b21fb2a4dc
The pages describing this code lived in lancedb/docs, a repository with ten stars that neither contributing guide mentioned. A user who hit a wrong page while reading the source had to find a separate, near-invisible repository to fix it. These 102 pages now sit beside the code, and a documentation fix is a pull request in the repository the reader already had open. `docs/web` is a complete Mintlify site: `cd docs/web && mint dev` serves it with no other checkout. Enterprise pages stay private and are merged in when the published site is assembled, so links into them do not resolve here — every open-source page does. `docs/web-tests` holds the tests the code examples are extracted from. They ran against a published wheel before; here they can run against this repository's own SDK, so an example that stops compiling fails the pull request that broke it rather than being noticed later. Both directories sit beside `docs/src` and are invisible to it: mkdocs reads `docs_dir: src`, so the SDK reference builds and deploys exactly as before.
25 lines
2.2 KiB
Plaintext
25 lines
2.2 KiB
Plaintext
{/* Auto-generated by scripts/mdx_snippets_gen.py. Do not edit manually. */}
|
|
|
|
export const RsAdd = "let new_data = create_some_records()?;\ntbl.add(new_data).execute().await.unwrap();\n";
|
|
|
|
export const RsConnect = "#[tokio::main]\nasync fn main() -> Result<()> {\n if std::path::Path::new(\"data\").exists() {\n std::fs::remove_dir_all(\"data\").unwrap();\n }\n // --8<-- [start:connect_uri]\n let uri = \"data/sample-lancedb\";\n let db = connect(uri).execute().await?;\n // --8<-- [end:connect_uri]\n\n // --8<-- [start:list_names]\n println!(\"{:?}\", db.table_names().execute().await?);\n // --8<-- [end:list_names]\n let tbl = create_table(&db).await?;\n create_index(&tbl).await?;\n let batches = search(&tbl).await?;\n println!(\"{:?}\", batches);\n\n create_empty_table(&db).await.unwrap();\n\n // --8<-- [start:delete]\n tbl.delete(\"id > 24\").await.unwrap();\n // --8<-- [end:delete]\n\n // --8<-- [start:drop_table]\n db.drop_table(\"my_table\").await.unwrap();\n // --8<-- [end:drop_table]\n Ok(())\n}\n";
|
|
|
|
export const RsConnectUri = "let uri = \"data/sample-lancedb\";\nlet db = connect(uri).execute().await?;\n";
|
|
|
|
export const RsCreateEmptyTable = "let schema = Arc::new(Schema::new(vec![\n Field::new(\"id\", DataType::Int32, false),\n Field::new(\"item\", DataType::Utf8, true),\n]));\ndb.create_empty_table(\"empty_table\", schema).execute().await\n";
|
|
|
|
export const RsCreateIndex = "table.create_index(&[\"vector\"], Index::Auto).execute().await\n";
|
|
|
|
export const RsCreateTable = "let initial_data = create_some_records()?;\nlet tbl = db\n .create_table(\"my_table\", initial_data)\n .execute()\n .await\n .unwrap();\n";
|
|
|
|
export const RsDelete = "tbl.delete(\"id > 24\").await.unwrap();\n";
|
|
|
|
export const RsDropTable = "db.drop_table(\"my_table\").await.unwrap();\n";
|
|
|
|
export const RsListNames = "println!(\"{:?}\", db.table_names().execute().await?);\n";
|
|
|
|
export const RsOpenExistingTbl = "let table = db.open_table(\"my_table\").execute().await.unwrap();\n";
|
|
|
|
export const RsSearch = "table\n .query()\n .limit(2)\n .nearest_to(&[1.0; 128])?\n .execute()\n .await?\n .try_collect::<Vec<_>>()\n .await\n";
|
|
|