索引概念 #

┌─────────────────────────────────────────────────┐
│                  Application                     │
├─────────────────────────────────────────────────┤
│                                                  │
│  ┌─────────────┐  ┌─────────────┐               │
│  │   Index     │  │   Index     │               │
│  │  products   │  │   users     │               │
│  │             │  │             │               │
│  │  Record 1   │  │  Record 1   │               │
│  │  Record 2   │  │  Record 2   │               │
│  │  Record 3   │  │  Record 3   │               │
│  │    ...      │  │    ...      │               │
│  └─────────────┘  └─────────────┘               │
│                                                  │
└─────────────────────────────────────────────────┘

{
  "objectID": "unique-id-123",
  "name": "iPhone 15 Pro",
  "brand": "Apple",
  "price": 999,
  "category": "Smartphones",
  "description": "Latest iPhone with A17 Pro chip",
  "image": "https://example.com/iphone.jpg",
  "stock": 50,
  "rating": 4.8,
  "tags": ["phone", "apple", "5g"]
}

// 自动生成objectID
const { objectIDs } = await index.saveObjects([
  { name: "Product 1" }  // Algolia会自动生成objectID
]);

// 手动指定objectID
await index.saveObjects([
  { objectID: "prod-001", name: "Product 1" }
]);

const algoliasearch = require('algoliasearch');
const client = algoliasearch('APP_ID', 'ADMIN_KEY');

// 创建索引（添加第一条数据时自动创建）
const index = client.initIndex('products');

await index.saveObjects([
  { objectID: '1', name: 'First Product' }
]);

推荐命名格式：
├── products           # 生产环境
├── products_dev       # 开发环境
├── products_staging   # 预发布环境
├── products_backup    # 备份索引
└── products_v2        # 版本化索引

命名规则：
- 只能包含字母、数字、下划线
- 不能以数字开头
- 长度限制：1-100字符
- 区分大小写

await index.setSettings({
  // 可搜索属性
  searchableAttributes: ['name', 'description', 'brand'],
  
  // 分面属性
  attributesForFaceting: ['brand', 'category', 'price'],
  
  // 自定义排名
  customRanking: ['desc(rating)', 'desc(popularity)'],
  
  // 每页结果数
  hitsPerPage: 20,
  
  // 高亮属性
  attributesToHighlight: ['name', 'description'],
  
  // 代码片段属性
  attributesToSnippet: ['description:50'],
  
  // 不返回的属性
  unretrievableAttributes: ['internal_id']
});

// 优先级从高到低
searchableAttributes: [
  'name',           // 最高优先级
  'description',    // 中等优先级
  'brand',          // 较低优先级
  'category'
]

// 使用 unordered 前缀取消优先级
searchableAttributes: [
  'name',
  'unordered(description)',  // 不考虑词的位置
  'unordered(brand)'
]

attributesForFaceting: [
  'brand',                    // 可筛选可分面
  'category',                 // 可筛选可分面
  'filterOnly(price)',        // 仅可筛选
  'searchable(tags)'          // 可搜索的标签
]

// 默认排名公式
ranking: [
  'typo',       // 拼写错误数量
  'geo',        // 地理距离
  'words',      // 匹配词数量
  'filters',    // 过滤器匹配
  'proximity',  // 词的接近度
  'attribute',  // 属性优先级
  'exact',      // 精确匹配度
  'custom'      // 自定义排名
]

// 自定义排名规则
customRanking: [
  'desc(rating)',        // 评分降序
  'desc(popularity)',    // 人气降序
  'asc(price)'           // 价格升序
]

// 单条添加
await index.saveObject({
  objectID: '1',
  name: 'Product 1'
});

// 批量添加
await index.saveObjects([
  { objectID: '1', name: 'Product 1' },
  { objectID: '2', name: 'Product 2' },
  { objectID: '3', name: 'Product 3' }
]);

// 部分更新
await index.partialUpdateObject({
  objectID: '1',
  price: 899  // 只更新price字段
});

// 删除单条
await index.deleteObject('1');

// 批量删除
await index.deleteObjects(['1', '2', '3']);

// 按条件删除
await index.deleteBy({
  filters: 'stock:0'  // 删除库存为0的记录
});

// 清空索引
await index.clearObjects();

// replaceAllObjects 会先创建临时索引，然后替换
await index.replaceAllObjects([
  { objectID: '1', name: 'New Product 1' },
  { objectID: '2', name: 'New Product 2' }
], {
  safe: true  // 确保操作安全
});

const { algoliasearch } = require('algoliasearch');

const client = algoliasearch('APP_ID', 'ADMIN_KEY');
const index = client.initIndex('products');

// 批量操作
await index.batch({
  requests: [
    { action: 'addObject', body: { name: 'Product 1' } },
    { action: 'updateObject', body: { objectID: '2', name: 'Updated' } },
    { action: 'deleteObject', objectID: '3' },
    { action: 'partialUpdateObject', body: { objectID: '4', price: 100 } }
  ]
});

// 复制索引（包括设置和数据）
await client.copyIndex('source_index', 'target_index');

// 只复制设置
await client.copySettings('source_index', 'target_index');

// 只复制规则
await client.copyRules('source_index', 'target_index');

// 只复制同义词
await client.copySynonyms('source_index', 'target_index');

生产环境索引管理：
├── products_prod (主索引)
├── products_staging (预发布)
│   └── 复制自 products_prod
└── products_backup (备份)
    └── 复制自 products_prod

// 获取索引统计信息
const stats = await index.getStats();

console.log(stats);
// {
//   numberOfRecords: 10000,
//   dataSize: 5242880,
//   lastBuildTimeS: 2.5,
//   isPending: false
// }

// 操作返回taskID
const { taskID } = await index.saveObject({ ... });

// 等待任务完成
await index.waitTask(taskID);

// 获取任务状态
const status = await index.getTask(taskID);
console.log(status.status); // 'published' 或 'notPublished'

创建 → 配置 → 导入数据 → 搜索 → 更新 → 删除
  │       │        │        │       │       │
  └───────┴────────┴────────┴───────┴───────┘
                    可循环

// 1. 先配置索引设置
await index.setSettings({
  searchableAttributes: ['name', 'description'],
  customRanking: ['desc(rating)']
});

// 2. 再导入数据
await index.saveObjects(products);

// 3. 等待索引构建完成
await index.waitTask(taskID);

// 4. 开始搜索
const results = await index.search('query');