[docs]: Fix issues with Rust code snippets in "quick start" (#1047)

The renaming of `vectordb` to `lancedb` broke the [quick start docs](https://lancedb.github.io/lancedb/basic/#__tabbed_5_3) (it's pointing to a non-existent directory). This PR fixes the code snippets and the paths in the docs page. Additionally, more fixes related to indexing docs below 👇🏽.
2026-10-27 05:56:14 +00:00 · 2024-04-05 16:31:36 -07:00
parent 7f9ef0d329
commit f9c244e608
4 changed files with 57 additions and 66 deletions
@@ -46,7 +46,7 @@

    !!! info "Please also make sure you're using the same version of Arrow as in the [vectordb crate](https://github.com/lancedb/lancedb/blob/main/Cargo.toml)"

-## How to connect to a database
+## Connect to a database

 === "Python"

@@ -69,17 +69,22 @@
    ```rust
    #[tokio::main]
    async fn main() -> Result<()> {
-        --8<-- "rust/vectordb/examples/simple.rs:connect"
+        --8<-- "rust/lancedb/examples/simple.rs:connect"
    }
    ```

-    !!! info "See [examples/simple.rs](https://github.com/lancedb/lancedb/tree/main/rust/vectordb/examples/simple.rs) for a full working example."
+    !!! info "See [examples/simple.rs](https://github.com/lancedb/lancedb/tree/main/rust/lancedb/examples/simple.rs) for a full working example."

 LanceDB will create the directory if it doesn't exist (including parent directories).

 If you need a reminder of the uri, you can call `db.uri()`.

-## How to create a table
+## Create a table
+
+### Directly insert data to a new table
+
+If you have data to insert into the table at creation time, you can simultaneously create a 
+table and insert the data to it.

 === "Python"

@@ -118,17 +123,18 @@ If you need a reminder of the uri, you can call `db.uri()`.
    use arrow_schema::{DataType, Schema, Field};
    use arrow_array::{RecordBatch, RecordBatchIterator};

-    --8<-- "rust/vectordb/examples/simple.rs:create_table"
+    --8<-- "rust/lancedb/examples/simple.rs:create_table"
    ```

    If the table already exists, LanceDB will raise an error by default.

-!!! info "Under the hood, LanceDB is converting the input data into an Apache Arrow table and persisting it to disk in [Lance format](https://www.github.com/lancedb/lance)."
+!!! info "Under the hood, LanceDB converts the input data into an Apache Arrow table and persists it to disk using the [Lance format](https://www.github.com/lancedb/lance)."

-### Creating an empty table
+### Create an empty table

 Sometimes you may not have the data to insert into the table at creation time.
-In this case, you can create an empty table and specify the schema.
+In this case, you can create an empty table and specify the schema, so that you can add
+data to the table at a later time (such that it conforms to the schema).

 === "Python"

@@ -147,12 +153,12 @@ In this case, you can create an empty table and specify the schema.
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:create_empty_table"
+    --8<-- "rust/lancedb/examples/simple.rs:create_empty_table"
    ```

-## How to open an existing table
+## Open an existing table

-Once created, you can open a table using the following code:
+Once created, you can open a table as follows:

 === "Python"

@@ -169,7 +175,7 @@ Once created, you can open a table using the following code:
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:open_with_existing_file"
+    --8<-- "rust/lancedb/examples/simple.rs:open_with_existing_file"
    ```

 If you forget the name of your table, you can always get a listing of all table names:
@@ -189,12 +195,12 @@ If you forget the name of your table, you can always get a listing of all table
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:list_names"
+    --8<-- "rust/lancedb/examples/simple.rs:list_names"
    ```

-## How to add data to a table
+## Add data to a table

-After a table has been created, you can always add more data to it using
+After a table has been created, you can always add more data to it as follows:

 === "Python"

@@ -219,12 +225,12 @@ After a table has been created, you can always add more data to it using
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:add"
+    --8<-- "rust/lancedb/examples/simple.rs:add"
    ```

-## How to search for (approximate) nearest neighbors
+## Search for nearest neighbors

-Once you've embedded the query, you can find its nearest neighbors using the following code:
+Once you've embedded the query, you can find its nearest neighbors as follows:

 === "Python"

@@ -245,11 +251,12 @@ Once you've embedded the query, you can find its nearest neighbors using the fol
    ```rust
    use futures::TryStreamExt;

-    --8<-- "rust/vectordb/examples/simple.rs:search"
+    --8<-- "rust/lancedb/examples/simple.rs:search"
    ```

 By default, LanceDB runs a brute-force scan over dataset to find the K nearest neighbours (KNN).
 For tables with more than 50K vectors, creating an ANN index is recommended to speed up search performance.
+LanceDB allows you to create an ANN index on a table as follows:

 === "Python"

@@ -266,12 +273,17 @@ For tables with more than 50K vectors, creating an ANN index is recommended to s
 === "Rust"

    ```rust
-     --8<-- "rust/vectordb/examples/simple.rs:create_index"
+     --8<-- "rust/lancedb/examples/simple.rs:create_index"
    ```

-Check [Approximate Nearest Neighbor (ANN) Indexes](/ann_indices.md) section for more details.
+!!! note "Why do I need to create an index manually?"
+    LanceDB does not automatically create the ANN index, for two reasons. The first is that it's optimized
+    for really fast retrievals via a disk-based index, and the second is that data and query workloads can
+    be very diverse, so there's no one-size-fits-all index configuration. LanceDB provides many parameters
+    to fine-tune index size, query latency and accuracy. See the section on
+    [ANN indexes](ann_indexes.md) for more details.

-## How to delete rows from a table
+## Delete rows from a table

 Use the `delete()` method on tables to delete rows from a table. To choose
 which rows to delete, provide a filter that matches on the metadata columns.
@@ -292,7 +304,7 @@ This can delete any number of rows that match the filter.
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:delete"
+    --8<-- "rust/lancedb/examples/simple.rs:delete"
    ```

 The deletion predicate is a SQL expression that supports the same expressions
@@ -307,7 +319,7 @@ To see what expressions are supported, see the [SQL filters](sql.md) section.

      Read more: [vectordb.Table.delete](javascript/interfaces/Table.md#delete)

-## How to remove a table
+## Drop a table

 Use the `drop_table()` method on the database to remove a table.

@@ -333,7 +345,7 @@ Use the `drop_table()` method on the database to remove a table.
 === "Rust"

    ```rust
-    --8<-- "rust/vectordb/examples/simple.rs:drop_table"
+    --8<-- "rust/lancedb/examples/simple.rs:drop_table"
    ```

 !!! note "Bundling `vectordb` apps with Webpack"