Typesense 2026: 开源即时搜索 API 日处理 100 万次查询 — 自托管部署指南

mkdir -p /tmp/typesense-data

# 生成 API 密钥
export TYPESENSE_API_KEY=$(openssl rand -hex 24)
echo "Your API key: $TYPESENSE_API_KEY"

# 运行 Typesense 27.1
docker run -d \
  --name typesense \
  --restart unless-stopped \
  -p 8108:8108 \
  -v /tmp/typesense-data:/data \
  typesense/typesense:27.1 \
  --data-dir /data \
  --api-key=$TYPESENSE_API_KEY \
  --enable-cors

curl -s "http://localhost:8108/health" | jq .
# 预期输出: { "ok": true }

# 定义电商商品目录的 Schema
curl -s "http://localhost:8108/collections" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-TYPESENSE-API-KEY: $TYPESENSE_API_KEY" \
  -d '{
    "name": "products",
    "fields": [
      { "name": "name", "type": "string", "facet": false },
      { "name": "description", "type": "string", "facet": false },
      { "name": "price", "type": "float", "facet": true, "sort": true },
      { "name": "category", "type": "string", "facet": true },
      { "name": "rating", "type": "float", "facet": true, "sort": true },
      { "name": "in_stock", "type": "bool", "facet": true },
      { "name": "location", "type": "geopoint" }
    ],
    "default_sorting_field": "rating"
  }' | jq .

# 使用导入端点导入文档
curl -s "http://localhost:8108/collections/products/documents/import?action=create" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-TYPESENSE-API-KEY: $TYPESENSE_API_KEY" \
  -d '
  {"name": "Wireless Bluetooth Headphones", "description": "Noise cancelling over-ear headphones", "price": 79.99, "category": "Electronics", "rating": 4.5, "in_stock": true, "location": [40.7128, -74.0060]}
  {"name": "Mechanical Keyboard", "description": "RGB backlit mechanical keyboard with blue switches", "price": 129.99, "category": "Electronics", "rating": 4.7, "in_stock": true, "location": [37.7749, -122.4194]}
  {"name": "Running Shoes", "description": "Lightweight running shoes for marathon training", "price": 89.50, "category": "Sports", "rating": 4.2, "in_stock": false, "location": [51.5074, -0.1278]}
  {"name": "Yoga Mat", "description": "Non-slip eco-friendly yoga mat", "price": 29.99, "category": "Sports", "rating": 4.8, "in_stock": true, "location": [48.8566, 2.3522]}
  '

# 带容错功能的搜索
curl -s "http://localhost:8108/collections/products/documents/search?\
q=headphons&\
query_by=name,description&\
filter_by=price:>=50&&<=150&\
sort_by=rating:desc&\
facet_by=category&\
page=1&\
per_page=10" \
  -H "X-TYPESENSE-API-KEY: $TYPESENSE_API_KEY" | jq .

npm install typesense

const Typesense = require('typesense');

const client = new Typesense.Client({
  'nodes': [{ 'host': 'localhost', 'port': '8108', 'protocol': 'http' }],
  'apiKey': process.env.TYPESENSE_API_KEY,
  'connectionTimeoutSeconds': 2
});

// Search
async function searchProducts(query) {
  const results = await client.collections('products')
    .documents()
    .search({
      'q': query,
      'query_by': 'name,description',
      'filter_by': 'in_stock:true',
      'sort_by': 'rating:desc',
      'per_page': 10
    });
  
  console.log(`Found ${results.found} results`);
  results.hits.forEach(hit => {
    console.log(`- ${hit.document.name} ($${hit.document.price})`);
  });
}

searchProducts('headphons'); // typo still works

pip install typesense

import typesense
import os

client = typesense.Client({
    'nodes': [{'host': 'localhost', 'port': '8108', 'protocol': 'http'}],
    'api_key': os.environ['TYPESENSE_API_KEY'],
    'connection_timeout_seconds': 2
})

# 分面搜索
results = client.collections['products'].documents.search({
    'q': 'keyboard',
    'query_by': 'name,description',
    'facet_by': 'category,price',
    'sort_by': 'rating:desc',
    'per_page': 10
})

print(f"Total: {results['found']}")
for hit in results['hits']:
    print(f"  {hit['document']['name']} - ${hit['document']['price']}")

npm install typesense-instantsearch-adapter react-instantsearch-dom

import React from 'react';
import { InstantSearch, SearchBox, Hits, RefinementList } from 'react-instantsearch-dom';
import TypesenseInstantsearchAdapter from 'typesense-instantsearch-adapter';

const typesenseAdapter = new TypesenseInstantsearchAdapter({
  server: {
    apiKey: process.env.REACT_APP_TYPESENSE_API_KEY,
    nodes: [{ host: 'localhost', port: '8108', protocol: 'http' }]
  },
  additionalSearchParameters: {
    query_by: 'name,description',
    facet_by: 'category,in_stock',
    sort_by: 'rating:desc'
  }
});

const searchClient = typesenseAdapter.searchClient;

function App() {
  return (
    <InstantSearch searchClient={searchClient} indexName="products">
      <SearchBox />
      <RefinementList attribute="category" />
      <Hits hitComponent={ProductHit} />
    </InstantSearch>
  );
}

function ProductHit({ hit }) {
  return (
    <div>
      <h3>{hit.name}</h3>
      <p>${hit.price} — Rating: {hit.rating}</p>
    </div>
  );
}

export default App;

require 'typesense'

client = Typesense::Client.new(
  nodes: [{ host: 'localhost', port: 8108, protocol: 'http' }],
  api_key: ENV['TYPESENSE_API_KEY'],
  connection_timeout_seconds: 2
)

results = client.collections['products'].documents.search(
  q: 'running shoes',
  query_by: 'name,description',
  filter_by: 'in_stock:true',
  sort_by: 'price:asc'
)

puts "Found #{results['found']} results"
results['hits'].each { |hit| puts "- #{hit['document']['name']}" }

package main

import (
    "fmt"
    "os"
    "github.com/typesense/typesense-go/v2/typesense"
    "github.com/typesense/typesense-go/v2/typesense/api"
)

func main() {
    client := typesense.NewClient(
        typesense.WithServer("http://localhost:8108"),
        typesense.WithAPIKey(os.Getenv("TYPESENSE_API_KEY")),
    )

    searchParams := &api.SearchCollectionParams{
        Q:        "keyboard",
        QueryBy:  "name,description",
        FilterBy: "in_stock:true",
        SortBy:   "rating:desc",
    }

    results, err := client.Collection("products").Documents().Search(searchParams)
    if err != nil {
        panic(err)
    }

    fmt.Printf("Found: %d\n", *results.Found)
    for _, hit := range *results.Hits {
        doc := *hit.Document
        fmt.Printf("- %s ($%.2f)\n", doc["name"], doc["price"])
    }
}

# /etc/nginx/sites-available/typesense
server {
    listen 443 ssl http2;
    server_name search.yourdomain.com;

    ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;

    location / {
        proxy_pass http://localhost:8108;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_read_timeout 30s;
    }
}

# docker-compose.yml
version: '3.8'

services:
  typesense:
    image: typesense/typesense:27.1
    restart: unless-stopped
    ports:
      - "127.0.0.1:8108:8108"
    volumes:
      - typesense-data:/data
    environment:
      TYPESENSE_API_KEY: ${TYPESENSE_API_KEY}
    command: >
      --data-dir /data
      --api-key ${TYPESENSE_API_KEY}
      --enable-cors
      --ssl-refresh-interval-seconds 86400
    deploy:
      resources:
        limits:
          memory: 4G
        reservations:
          memory: 1G

  # 可选: Caddy 自动 HTTPS
  caddy:
    image: caddy:2-alpine
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile
      - caddy-data:/data

volumes:
  typesense-data:
  caddy-data:

// 生成仅能看到 'Electronics' 类别的作用域 API 密钥
const typesense = require('typesense');

const client = new Typesense.Client({
  nodes: [{ host: 'localhost', port: '8108', protocol: 'http' }],
  apiKey: 'master-api-key',
  connectionTimeoutSeconds: 2
});

// 创建带内嵌过滤器的密钥
const scopedKey = client.keys().generateScopedSearchKey(
  'master-api-key',
  { filter_by: 'category:=Electronics' }
);

console.log('Electronics 的作用域密钥:', scopedKey);
// 此密钥只能搜索 Electronics 产品

# 节点 1
docker run -d -p 8108:8108 \
  -v typesense-data:/data \
  typesense/typesense:27.1 \
  --data-dir /data \
  --api-key=$API_KEY \
  --nodes=/data/nodes \
  --peering-subnet=10.0.0.0/16 \
  --peering-port=8107

# 节点 2 和 3: 相同命令，使用 --nodes 更新所有 IP

# 创建同义词: "laptop" = "notebook"
curl -s "http://localhost:8108/collections/products/synonyms" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-TYPESENSE-API-KEY: $TYPESENSE_API_KEY" \
  -d '{"synonyms": ["laptop", "notebook"]}'

# 策展: "deals" 查询始终将产品 ID 123 排在第 1 位
curl -s "http://localhost:8108/collections/products/overrides" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-TYPESENSE-API-KEY: $TYPESENSE_API_KEY" \
  -d '{
    "rule": {"query": "deals", "match": "contains"},
    "includes": [{"id": "123", "position": 1}]
  }'