Login

Clickhouse

Estimated reading: 2 minutes

The Clickhouse component reads and writes to a Clickhouse vector store using an instance of Clickhouse vector store.

For more information, see the following:

1. Hidden parameters
2. Search results output
3. Vector store instances
4. Clickhouse Documentation

Clickhouse parameters

Name	Display Name	Info
host	hostname	Input parameter. The Clickhouse server hostname. Required. Default: localhost.
port	port	Input parameter. The Clickhouse server port. Required. Default: 8123.
database	database	Input parameter. The Clickhouse database name. Required.
table	Table name	Input parameter. The Clickhouse table name. Required.
username	Username	Input parameter. Clickhouse username for authentication. Required.
password	Password	Input parameter. Clickhouse password for authentication. Required.
index_type	index_type	Input parameter. Type of the index, either annoy (default) or vector_similarity.
metric	metric	Input parameter. Metric to compute distance for similarity search. The options are angular (default), euclidean, manhattan, hamming, dot.
secure	Use HTTPS/TLS	Input parameter. If true, enables HTTPS/TLS for the Clickhouse server and overrides inferred values for interface or port arguments. Default: false.
index_param	Param of the index	Input parameter. Index parameters. Default: 100,'L2Distance'.
index_query_params	index query params	Input parameter. Additional index query parameters.
search_query	Search Query	Input parameter. The query string for similarity search. Only relevant for reads.
ingest_data	Ingest Data	Input parameter. The records to load into the vector store.
cache_vector_store	Cache Vector Store	Input parameter. If true, the component caches the vector store in memory for faster reads. Default: Enabled (true).
embedding	Embedding	Input parameter. The embedding model to use.
number_of_results	Number of Results	Input parameter. The number of search results to return. Default: 4. Only relevant for reads.
score_threshold	Score threshold	Input parameter. The threshold for similarity score comparison. Default: Unset (no threshold). Only relevant for reads.

CONTENTS