Skip to content

Commit 5bcf3c7

Browse files
committed
Start/Search: More copy-editing
- Add links where some were missing - Less bold - Native notes instead of blockquotes - Fix bogus SQL queries - More cross-linking - Muted teaser texts at top of pages - Less mixed case
1 parent efb75e9 commit 5bcf3c7

File tree

4 files changed

+45
-21
lines changed

4 files changed

+45
-21
lines changed

docs/start/query/search/fulltext.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
(start-fulltext)=
22
# Full-text search
33

4-
Unlike exact-match filters, full-text search allows **fuzzy, linguistic matching** on human language text. It tokenizes input, analyzes language, and searches for **tokens, stems, synonyms**, etc.
4+
:::{div} sd-text-muted
5+
CrateDB enables real-time full-text search at scale.
6+
:::
57

6-
CrateDB supports powerful **full-text search** capabilities directly via the `FULLTEXT` index and the `MATCH()` SQL predicate. This allows you to **combine unstructured search with structured filtering and aggregations**—all in one query, with no need for external search systems like Elasticsearch.
8+
Unlike exact-match filters, **full-text search** allows **fuzzy, linguistic matching** on human language text. It tokenizes input, analyzes language, and searches for **tokens, stems, synonyms**, etc.
79

8-
Whether you're working with log messages, customer feedback, machine-generated data, or IoT event streams, CrateDB enables **real-time full-text search at scale**.
10+
CrateDB supports powerful full-text search capabilities directly via the `FULLTEXT` index and the `MATCH()` SQL predicate. This allows you to **combine unstructured search with structured filtering and aggregations**—all in one query, with no need for external search systems like Elasticsearch.
11+
12+
CrateDB supports you whether you are working with log messages, customer feedback, machine-generated data, or IoT event streams.
913

1014
## Why CrateDB for Full-text Search?
1115

docs/start/query/search/geo.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
(start-geospatial)=
22
# Geospatial search
33

4-
CrateDB enables geospatial search using **Lucene’s Prefix Tree** and **BKD Tree** indexing structures. With CrateDB, you can:
4+
:::{div} sd-text-muted
5+
Query geospatial data through SQL, combining ease of use with advanced capabilities.
6+
:::
7+
8+
CrateDB enables geospatial search using **Lucene’s prefix tree** and **BKD tree** indexing structures. With CrateDB, you can:
59

610
* Store and index geographic **points** and **shapes**
711
* Perform spatial queries using **bounding boxes**, **circles**, **donut shapes**, and more
812
* Filter, sort, or boost results by **distance**, **area**, or **spatial relationship**
913

10-
You interact with geospatial data through SQL, combining ease of use with advanced capabilities.
11-
12-
See the Data Modelling (!!! add link) section for details of Data Types and how to insert data.
14+
See the {ref}`data-modelling` section for details of data types and how to insert data.
1315

1416
## Querying Geospatial Data
1517

@@ -70,7 +72,7 @@ You can choose and configure the indexing method when defining your table schema
7072

7173
While CrateDB can perform **exact computations** on complex geometries (e.g. large polygons, geometry collections), these can be computationally expensive. Choose your index strategy carefully based on your query patterns.
7274

73-
For full details, refer to the Geo Shape Column Definition section (!!! add link) in the reference.
75+
For full details, refer to the Geo Shape column definition section in the reference documentation.
7476

7577
## Further reading
7678

docs/start/query/search/hybrid.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
(start-hybrid)=
22
# Hybrid search
33

4+
:::{div} sd-text-muted
5+
Combine vector similarity (kNN) and term-based full-text (BM25)
6+
searches in a single SQL query.
7+
:::
8+
49
While **vector search** provides powerful semantic retrieval based on machine learning models, it's not always optimal, especially when models are not fine-tuned for a specific domain. On the other hand, **traditional full-text search** (e.g., BM25 scoring) offers high precision on exact or keyword-based queries, with strong performance out of the box. **Hybrid search** blends these approaches, combining semantic understanding with keyword relevance to deliver more accurate, robust, and context-aware search results.
510

6-
Hybrid search is particularly effective for **Knowledge bases, Product or document search, Multilingual content search, FAQ bots and semantic assistants**, and **AI-powered search experiences.** It allows applications to go beyond keyword matching, incorporating vector similarity while still respecting domain-specific terms.
11+
Hybrid search is particularly effective for **knowledge bases, product or document search, multilingual content search, FAQ bots and semantic assistants**, and **AI-powered search experiences.** It allows applications to go beyond keyword matching, incorporating vector similarity while still respecting domain-specific terms.
712

8-
CrateDB supports **hybrid search** by combining **vector similarity search** (kNN) and **term-based full-text search** (BM25) in a single SQL query. CrateDB lets you implement hybrid search natively in SQL using **Common Table Expressions (CTEs)** and **scoring fusion techniques**, such as:
13+
CrateDB supports **hybrid search** by combining **vector similarity search** (kNN) and **term-based full-text search** (BM25) in a single SQL query. CrateDB lets you implement hybrid search natively in SQL using **common table expressions (CTEs)** and **scoring fusion techniques**, such as:
914

1015
* **Convex combination** (weighted sum of scores)
11-
* **Reciprocal Rank Fusion (RRF)**
16+
* **Reciprocal rank fusion (RRF)**
1217

1318
## Supported Search Capabilities in CrateDB
1419

1520
| Search Type | Function | Description |
16-
| --------------------- | ------------- | ---------------------------------------------- |
21+
| --------------------- | ------------- |------------------------------------------------|
1722
| **Vector search** | `KNN_MATCH()` | Finds vectors closest to a given vector |
1823
| **Full-text search** | `MATCH()` | Uses Lucene's BM25 scoring |
19-
| **Geospatial search** | `MATCH()` | For shapes and points (see: Geospatial Search) |
24+
| **Geospatial search** | `MATCH()` | For shapes and points (see: Geospatial search) |
2025

2126
CrateDB enables all three through **pure SQL**, allowing flexible combinations and advanced analytics.
2227

@@ -74,7 +79,11 @@ You can adjust the weighting (`0.5`) depending on your desired balance between k
7479
| 0.03105 | 7 | 2 | Searching On Multiple Columns |
7580
| 0.03057 | 8 | 3 | Usage |
7681

77-
> RRF rewards documents that rank highly across multiple methods, regardless of exact score values.
82+
:::{note}
83+
RRF rewards documents that rank highly across multiple methods,
84+
regardless of exact score values.
85+
:::
86+
7887
## Further reading
7988

8089
:::::{grid} 1 3 3 3
@@ -101,7 +110,11 @@ You can adjust the weighting (`0.5`) depending on your desired balance between k
101110

102111
::::{grid-item-card} {material-outlined}`read_more;1.5em` Read more
103112
:columns: 6
113+
- [Doing Hybrid Search in CrateDB]
104114
- {ref}`Hybrid search feature details <hybrid-search>`
105115
::::
106116

107117
:::::
118+
119+
120+
[Doing Hybrid Search in CrateDB]: https://cratedb.com/blog/hybrid-search-explained

docs/start/query/search/vector.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
(start-vector)=
22
# Vector search
33

4-
Vector search retrieves the most semantically similar items to a query vector using **Approximate Nearest Neighbor (ANN)** algorithms (e.g., HNSW via Lucene).&#x20;
4+
:::{div} sd-text-muted
5+
Store, manage, and search vector embeddings at scale.
6+
:::
7+
8+
Vector search retrieves the most semantically similar items to a query vector using **approximate nearest neighbor (ANN)** algorithms (e.g., HNSW via Lucene).&#x20;
59

610
CrateDB supports **native vector search**, enabling you to perform **similarity-based retrieval** directly in SQL, without needing a separate vector database or search engine.
711

8-
Whether you're powering **semantic search**, **recommendation engines**, **anomaly detection**, or **AI-enhanced applications**, CrateDB lets you store, manage, and search vector embeddings at scale **right alongside your structured, JSON, and full-text data.**
12+
Whether you're powering **semantic search**, **recommendation engines**, **anomaly detection**, or **AI-enhanced applications**, CrateDB lets you manage vector data **right alongside your structured, JSON, and full-text data.**
913

1014
## Why CrateDB for Vector Search?
1115

12-
| FLOAT\_VECTOR | Store embeddings up to 2048 dimensions |
13-
| ------------------ | ------------------------------------------------------------ |
14-
| KNN\_MATCH | SQL-native k-nearest neighbor function with `_score` support |
15-
| VECTOR\_SIMILARITY | Compute similarity scores between vectors in queries |
16+
| Feature | Benefit |
17+
|--------------------|--------------------------------------------------------------|
18+
| FLOAT_VECTOR | Store embeddings up to 2048 dimensions |
19+
| KNN_MATCH | SQL-native k-nearest neighbor function with `_score` support |
20+
| VECTOR_SIMILARITY | Compute similarity scores between vectors in queries |
1621
| Real-time indexing | Fresh vectors are immediately searchable |
1722
| Hybrid queries | Combine vector search with filters, full-text, and JSON |
1823

@@ -35,7 +40,7 @@ Returns top 3 most similar embeddings.
3540
SELECT product_name, _score
3641
FROM products
3742
WHERE category = 'shoes'
38-
AND KNN_MATCH(features, [0.2, 0.1, ], 5)
43+
AND KNN_MATCH(features, [0.2, 0.1, 0.3], 5)
3944
ORDER BY _score DESC;
4045
```
4146

0 commit comments

Comments
 (0)