Skip to main content
Version: 2.3.10

Typesense

Typesense Source Connector

Description

Reads data from Typesense.

Key Features

Options

NameTypeRequiredDefault
hostsarrayyes-
collectionstringyes-
schemaconfigyes-
api_keystringno-
querystringno-
batch_sizeintno100

hosts [array]

The access address of Typesense, for example: ["typesense-01:8108"].

collection [string]

The name of the collection to write to, for example: "seatunnel".

schema [config]

The columns to be read from Typesense. For more information, please refer to the guide.

api_key [config]

The api_key for Typesense security authentication.

batch_size

The number of records to query per batch when reading data.

Common Options

For common parameters of Source plugins, please refer to Source Common Options.

Example

source {
Typesense {
hosts = ["localhost:8108"]
collection = "companies"
api_key = "xyz"
query = "q=*&filter_by=num_employees:>9000"
schema = {
fields {
company_name_list = array<string>
company_name = string
num_employees = long
country = string
id = string
c_row = {
c_int = int
c_string = string
c_array_int = array<int>
}
}
}
}
}

Changelog

Change Log
ChangeCommitVersion
[Fix] Fix error log name for SourceSplitEnumerator implements class (#8817)https://github.com/apache/seatunnel/commit/55ed90eca2.3.10
[Improve] restruct connector common options (#8634)https://github.com/apache/seatunnel/commit/f3499a6ee2.3.10
[Feature]Check Chinese comments in the code (#8319)https://github.com/apache/seatunnel/commit/d58fce1ca2.3.9
[Improve][dist]add shade check rule (#8136)https://github.com/apache/seatunnel/commit/51ef800012.3.9
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)https://github.com/apache/seatunnel/commit/6b7c53d032.3.9
[Fix][Connector-V2] Fix known directory create and delete ignore issues (#7700)https://github.com/apache/seatunnel/commit/e2fb679572.3.8
[Feature][Connector-V2] Support typesense connector (#7450)https://github.com/apache/seatunnel/commit/138d2a4eb2.3.8