Skip to main content
Version: 3.0.0-LTS

TypeSense

ToolJet can connect to your TypeSense deployment to read and write data.

Connection​

To establish a connection with the Typesense data source, you can either click on the + Add new Data source button located on the query panel or navigate to the Data Sources page from the ToolJet dashboard and choose Typesense as the data source.

info

Please make sure the Host/IP of the database is accessible from your VPC if you have self-hosted ToolJet. If you are using ToolJet cloud, please whitelist our IP.

ToolJet requires the following to connect to TypeSense deployment:

  • Host
  • Port
  • API Key
  • Protocol
typesense connect

Querying TypeSense​

  1. Click on + Add button of the query manager at the bottom panel of the editor.
  2. Select the Typesence datasource added in previous step.
  3. Select the desired operation from the dropdown and enter the required parameters.
  4. Click on the Preview button to preview the output or Click on the Run button to trigger the query.
tip

Query results can be transformed using transformations. Read our transformations documentation to see how: link

Supported Operations​

Create a Collection​

With this operation you can easily create Collections in your TypeSense cluster. In the schema field, you'll need to define the schema for creating a new collection. Check out TypeSense docs to know more about collections here

Required Parameter​

  • Schema
typesense collection

Example​

[
  { "name": "id", "type": "string" },
  { "name": "name", "type": "string" },
  { "name": "price", "type": "float" }
]

Index a Document​

Use this operation to index a document to your collection. You'll need to specify the Collection Name where you want your document to be indexed and also provide the document data according the schema defined in the collection. Read more about Indexing a document in TypeSense here.

Required Parameter​

  • Collection
  • Document
typesense index
{
  "id": "1",
  "name": "Laptop",
  "price": 999.99
}

Use this operation to perform a search within the specified collection. Know more about the search parameters in the TypeSense doc here.

Required Parameter​

  • Collection
typesense search
{
  "filter_by": "price:<1000",
  "sort_by": "price:desc",
  "per_page": 10
}

Get a Document​

Use this operation to fetch an individual document in a collection by providing the id of the document. Read more about it here.

Required Parameter​

  • Collection
  • Id
typesense get

Update a Document​

Use this operation to update an individual document by providing the Collection Name and Id of the document. You'll need to provide the updated document data in the form of specified schema. Check out the TypeSense's doc on updating a document here.

Required Parameter​

  • Collection
  • Id
  • Document
typesense update
{
  "name": "Gaming Laptop",
  "price": 1199.99
}

Delete a Document​

Delete a document from collection by providing the Id of the document. Check out the TypeSense's doc on deleting documents here.

Required Parameter​

  • Collection
  • Id
typesense delete

tip

Make sure that you supply JSON strings instead of JavaScript objects for any document or schema that is being passed to the server, in any of the above operations.