Skip to content

Commit 06902cd

Browse files
authored
docs: Databricks example reference README.md
1 parent 97cd0eb commit 06902cd

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ The connector supports ingesting multiple named/unnamed, dense/sparse vectors.
183183

184184
## Databricks
185185

186+
> [!TIP]
187+
> Check out our [example](https://qdrant.tech/documentation/examples/databricks/) of using the Spark connector with Databricks.
188+
186189
You can use the connector as a library in Databricks to ingest data into Qdrant.
187190

188191
- Go to the `Libraries` section in your cluster dashboard.
@@ -197,23 +200,23 @@ The appropriate Spark data types are mapped to the Qdrant payload based on the p
197200

198201
## Options and Spark types
199202

200-
| Option | Description | Column DataType | Required |
201-
| :--------------------------- | :------------------------------------------------------------------ | :---------------------------- | :------- |
202-
| `qdrant_url` | GRPC URL of the Qdrant instance. Eg: <http://localhost:6334> | - ||
203-
| `collection_name` | Name of the collection to write data into | - ||
204-
| `schema` | JSON string of the dataframe schema | - ||
205-
| `embedding_field` | Name of the column holding the embeddings | `ArrayType(FloatType)` ||
206-
| `id_field` | Name of the column holding the point IDs. Default: Random UUID | `StringType` or `IntegerType` ||
207-
| `batch_size` | Max size of the upload batch. Default: 64 | - ||
208-
| `retries` | Number of upload retries. Default: 3 | - ||
209-
| `api_key` | Qdrant API key for authentication | - ||
210-
| `vector_name` | Name of the vector in the collection. | - ||
211-
| `vector_fields` | Comma-separated names of columns holding the vectors. | `ArrayType(FloatType)` ||
212-
| `vector_names` | Comma-separated names of vectors in the collection. | - ||
213-
| `sparse_vector_index_fields` | Comma-separated names of columns holding the sparse vector indices. | `ArrayType(IntegerType)` ||
214-
| `sparse_vector_value_fields` | Comma-separated names of columns holding the sparse vector values. | `ArrayType(FloatType)` ||
215-
| `sparse_vector_names` | Comma-separated names of the sparse vectors in the collection. | - ||
216-
| `shard_key_selector` | Comma-separated names of custom shard keys to use during upsert. | - ||
203+
| Option | Description | Column DataType | Required |
204+
| :--------------------------- | :----------------------------------------------------------------------------------- | :---------------------------- | :------- |
205+
| `qdrant_url` | GRPC URL of the Qdrant instance. Eg: <http://localhost:6334> | - ||
206+
| `collection_name` | Name of the collection to write data into | - ||
207+
| `schema` | JSON string of the dataframe schema | - ||
208+
| `embedding_field` | Name of the column holding the embeddings (Deprecated - Use `vector_fields` instead) | `ArrayType(FloatType)` ||
209+
| `id_field` | Name of the column holding the point IDs. Default: Random UUID | `StringType` or `IntegerType` ||
210+
| `batch_size` | Max size of the upload batch. Default: 64 | - ||
211+
| `retries` | Number of upload retries. Default: 3 | - ||
212+
| `api_key` | Qdrant API key for authentication | - ||
213+
| `vector_name` | Name of the vector in the collection. | - ||
214+
| `vector_fields` | Comma-separated names of columns holding the vectors. | `ArrayType(FloatType)` ||
215+
| `vector_names` | Comma-separated names of vectors in the collection. | - ||
216+
| `sparse_vector_index_fields` | Comma-separated names of columns holding the sparse vector indices. | `ArrayType(IntegerType)` ||
217+
| `sparse_vector_value_fields` | Comma-separated names of columns holding the sparse vector values. | `ArrayType(FloatType)` ||
218+
| `sparse_vector_names` | Comma-separated names of the sparse vectors in the collection. | - ||
219+
| `shard_key_selector` | Comma-separated names of custom shard keys to use during upsert. | - ||
217220

218221
## LICENSE
219222

0 commit comments

Comments
 (0)