MilvusPlus MilvusPlus
首页
  • 介绍
  • 配置文件
  • 应用场景
  • 注解详解
  • 索引与度量类型详解
  • MilvusMapper
  • MilvusService
  • 快速开始
  • 使用案例
快速开始
Source (opens new window)
首页
  • 介绍
  • 配置文件
  • 应用场景
  • 注解详解
  • 索引与度量类型详解
  • MilvusMapper
  • MilvusService
  • 快速开始
  • 使用案例
快速开始
Source (opens new window)
  • 指南

    • 项目简介
    • 配置文件
    • 应用场景
    • 注解详解
    • 索引与度量类型详解
    • 快速开始
    • 使用案例
  • 功能

    • MilvusMapper
      • MilvusMapper功能
        • MilvusMapper
        • 数据操作
        • 构建器方法
        • LambdaQueryWrapper 类功能文档
        • 构造函数
        • 分区设置
        • 搜索参数设置
        • 查询条件构建
        • JSON 和数组操作
        • 逻辑操作
        • 向量搜索设置
        • 执行查询
        • 辅助方法
        • LambdaDeleteWrapper
        • 执行删除
        • LambdaUpdateWrapper
        • 执行更新
        • LambdaInsertWrapper
    • MilvusService
  • 指南
  • 功能
xgc
2024-06-12
目录

MilvusMapper

# MilvusMapper功能

MilvusMapper 是一个用于操作 Milvus 数据库的通用接口,提供了一系列的数据操作方法,包括查询、删除、更新和插入。以下是对 MilvusMapper 及其相关类的功能描述

# MilvusMapper

MilvusMapper 是一个泛型抽象类,继承自 BaseMilvusMapper,提供了与 Milvus 客户端交互的基本方法。

  • 创建搜索构建器实例: queryWrapper() - 创建 LambdaQueryWrapper 实例。
  • 创建删除构建器实例: deleteWrapper() - 创建 LambdaDeleteWrapper 实例。
  • 创建更新构建器实例: updateWrapper() - 创建 LambdaUpdateWrapper 实例。
  • 创建新增构建器实例: insertWrapper() - 创建 LambdaInsertWrapper 实例。

# 数据操作

  • 通过 ID 获取数据getById(Serializable ... ids)

  • 删除数据removeById(Serializable ... ids)

  • 更新数据updateById(T ... entity)

  • 插入数据insert(T ... entity)

# 构建器方法

  • 创建通用构建器实例: lambda(Wrapper<W, T> wrapper) - 初始化并返回构建器实例。

# LambdaQueryWrapper 类功能文档

LambdaQueryWrapper 是一个用于构建和执行 Milvus 搜索查询的构建器类。它提供了一系列方法来设置查询参数,并最终执行查询。

# 构造函数

  • LambdaQueryWrapper(): 无参构造函数。
  • LambdaQueryWrapper(String collectionName, MilvusClientV2 client, ConversionCache conversionCache, Class entityType): 构造函数,初始化集合名称、Milvus 客户端、类型转换缓存和实体类型。

# 分区设置

  • partition(String ... partitionName): 添加一个或多个分区名称到查询中。
  • partition(FieldFunction<T,?>... partitionName): 根据提供的字段函数添加分区名称。

# 搜索参数设置

  • searchParams(Map<String, Object> searchParams): 设置搜索参数。
  • radius(Object radius): 设置搜索半径。
  • rangeFilter(Object rangeFilter): 设置范围过滤器。
  • metricType(Object metric_type): 设置度量类型。
  • roundDecimal(Integer roundDecimal): 设置返回的距离值的小数位数。

# 查询条件构建

  • eq(String fieldName, Object value): 添加等于条件。
  • ne(String fieldName, Object value): 添加不等于条件。
  • gt(String fieldName, Object value): 添加大于条件。
  • ge(String fieldName, Object value): 添加大于等于条件。
  • lt(String fieldName, Object value): 添加小于条件。
  • le(String fieldName, Object value): 添加小于等于条件。
  • between(String fieldName, Object start, Object end): 添加范围条件。
  • isNull(String fieldName): 添加空值检查条件。
  • isNotNull(String fieldName): 添加非空值检查条件。
  • in(String fieldName, List<?> values): 添加 IN 条件。
  • like(String fieldName, String value): 添加 LIKE 条件。

# JSON 和数组操作

  • jsonContains(String fieldName, Object value): 添加 JSON 包含条件。
  • jsonContainsAll(String fieldName, List<?> values): 添加 JSON 包含所有值的条件。
  • jsonContainsAny(String fieldName, List<?> values): 添加 JSON 包含任意值的条件。
  • arrayContains(String fieldName, Object value): 添加数组包含条件。
  • arrayContainsAll(String fieldName, List<?> values): 添加数组包含所有值的条件。
  • arrayContainsAny(String fieldName, List<?> values): 添加数组包含任意值的条件。
  • arrayLength(String fieldName, int length): 添加数组长度条件。

# 逻辑操作

  • and(ConditionBuilder other): 添加 AND 条件。
  • or(ConditionBuilder other): 添加 OR 条件。
  • not(): 添加 NOT 条件。

# 向量搜索设置

  • annsField(String annsField): 设置要搜索的向量字段。
  • vector(List<?> vector): 添加要搜索的向量。
  • vector(String annsField, List<?> vector): 设置向量字段并添加要搜索的向量。
  • topK(Integer topK): 设置返回的 top-k 结果。
  • limit(Long limit): 设置查询结果的数量限制。

# 执行查询

  • query(): 构建并执行搜索请求,返回封装的 MilvusResp 对象,其中包含查询结果。
  • query(FieldFunction<T,?> ... outputFields): 设置输出字段并执行查询。
  • query(String ... outputFields): 设置输出字段并执行查询。
  • getById(Serializable ... ids): 通过 ID 获取数据。

# 辅助方法

  • buildSearch(): 构建完整的搜索请求对象。
  • buildQuery(): 构建查询请求对象。

LambdaQueryWrapper 类提供了丰富的方法来构建复杂的搜索查询,支持各种条件、逻辑操作、JSON 和数组操作,以及向量搜索。通过链式调用这些方法,用户可以灵活地构造搜索请求并获取所需的查询结果。

# LambdaDeleteWrapper

LambdaDeleteWrapper 是一个构建器类,用于构建和执行删除操作。

  • 添加分区: partition(String partitionName)
  • 添加等于条件: eq(String fieldName, Object value)
  • 添加不等于条件: ne(String fieldName, Object value)
  • 添加 ID 到删除列表: id(Object id)

# 执行删除

  • 执行删除: remove() - 构建并执行删除请求。
  • 通过 ID 删除: removeById(Serializable ... ids)

# LambdaUpdateWrapper

LambdaUpdateWrapper 是一个构建器类,用于构建和执行更新操作。

  • 添加分区: partition(String partitionName)
  • 设置更新条件: 与 LambdaDeleteWrapper 相同

# 执行更新

  • 更新数据: update(T t) - 构建并执行更新请求。
  • 通过 ID 更新: updateById(T ... t)

# LambdaInsertWrapper

LambdaInsertWrapper 是一个构建器类,用于构建和执行插入操作。

  • 添加分区: partition(String partitionName)
  • 添加字段值: put(String fieldName, Object value)
上次更新: 2024/06/12, 19:12:46
使用案例
MilvusService

← 使用案例 MilvusService→

Theme by Vdoing | Copyright © 2024-2024 xgc | Apache License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式