Versions in this module Expand all Collapse all v2 v2.6.6 Dec 3, 2025 Changes in this version + const AddAction + const AddFunctionAction + const AddPrivilegesToGroupAction + const AdvancedSearchAction + const AliasCategory + const AlterAction + const AlterFunctionAction + const AlterPropertiesAction + const BoundedTimestamp + const CollectionCategory + const CollectionFieldCategory + const CommonCategory + const CompactAction + const CompactionStateAction + const ContextRequest + const ContextToken + const ContextUsername + const CreateAction + const DataBaseCategory + const DefaultAliasName + const DefaultDbName + const DefaultIndexName + const DefaultMetricType + const DefaultOutputFields + const DefaultPrimaryFieldName + const DefaultVectorFieldName + const DeleteAction + const DescribeAction + const Dim + const DisableAutoID + const DropAction + const DropFunctionAction + const DropPropertiesAction + const EnableAutoID + const EnableDynamic + const EntityCategory + const FlushAction + const GetAction + const GetProgressAction + const GrantPrivilegeAction + const GrantPrivilegeActionV2 + const GrantRoleAction + const HTTPAliasName + const HTTPCollectionID + const HTTPCollectionName + const HTTPDbID + const HTTPDbName + const HTTPHeaderAllowInt64 + const HTTPHeaderDBName + const HTTPHeaderRequestTimeout + const HTTPIndexField + const HTTPIndexName + const HTTPIndexOffsetCacheEnabledKey + const HTTPMmapEnabledKey + const HTTPPartitionName + const HTTPPartitionNames + const HTTPProperties + const HTTPRequestData + const HTTPRequestDefaultValue + const HTTPReturnCacheHitRatio + const HTTPReturnCode + const HTTPReturnCost + const HTTPReturnData + const HTTPReturnDbName + const HTTPReturnDescription + const HTTPReturnDistance + const HTTPReturnFieldAutoID + const HTTPReturnFieldClusteringKey + const HTTPReturnFieldDefaultValue + const HTTPReturnFieldElementType + const HTTPReturnFieldID + const HTTPReturnFieldIsFunctionOutput + const HTTPReturnFieldName + const HTTPReturnFieldNullable + const HTTPReturnFieldPartitionKey + const HTTPReturnFieldPrimaryKey + const HTTPReturnFieldType + const HTTPReturnFunctionID + const HTTPReturnFunctionInputFieldNames + const HTTPReturnFunctionName + const HTTPReturnFunctionOutputFieldNames + const HTTPReturnFunctionParams + const HTTPReturnFunctionType + const HTTPReturnGrantor + const HTTPReturnHas + const HTTPReturnIndexFailReason + const HTTPReturnIndexIndexedRows + const HTTPReturnIndexMetricType + const HTTPReturnIndexParams + const HTTPReturnIndexPendingRows + const HTTPReturnIndexState + const HTTPReturnIndexTotalRows + const HTTPReturnIndexType + const HTTPReturnLoadProgress + const HTTPReturnLoadState + const HTTPReturnMaxIndexVersion + const HTTPReturnMessage + const HTTPReturnMinIndexVersion + const HTTPReturnObjectName + const HTTPReturnObjectType + const HTTPReturnPrivilege + const HTTPReturnPrivilegeGroupName + const HTTPReturnPrivilegeGroups + const HTTPReturnPrivileges + const HTTPReturnRecalls + const HTTPReturnRowCount + const HTTPReturnScannedRemoteBytes + const HTTPReturnScannedTotalBytes + const HTTPReturnTopks + const HTTPRoleName + const HTTPUserName + const HasAction + const HybridSearchAction + const ImportJobCategory + const IndexCategory + const InsertAction + const ListAction + const LoadAction + const LoadStateAction + const ParamGroupByField + const ParamGroupSize + const ParamRadius + const ParamRangeFilter + const ParamRoundDecimal + const ParamStrictGroupSize + const Params + const PartitionCategory + const PrivilegeGroupCategory + const QueryAction + const QuotaCenterCategory + const RefreshLoadAction + const ReleaseAction + const RemovePrivilegesFromGroupAction + const RenameAction + const ResourceGroupCategory + const RevokePrivilegeAction + const RevokePrivilegeActionV2 + const RevokeRoleAction + const RoleCategory + const RunAnalyzerAction + const SearchAction + const SegmentCategory + const ShardNumDefault + const StatsAction + const TransferReplicaAction + const UpdatePasswordAction + const UpsertAction + const UserCategory + const VectorCollectionsCreatePath + const VectorCollectionsDescribePath + const VectorCollectionsDropPath + const VectorCollectionsPath + const VectorDeletePath + const VectorGetPath + const VectorInsertPath + const VectorQueryPath + const VectorSearchPath + const VectorUpsertPath + var RestRequestInterceptorErr = errors.New("interceptor error placeholder") + func CheckLimiter(ctx context.Context, req interface{}, pxy types.ProxyComponent) (any, error) + func GetAuthorization(c *gin.Context) string + func HTTPAbortReturn(c *gin.Context, code int, result gin.H) + func HTTPReturn(c *gin.Context, code int, result gin.H) + func HTTPReturnStream(c *gin.Context, code int, result gin.H) + func LoggerHandlerFunc() gin.HandlerFunc + func MetricsHandlerFunc(c *gin.Context) + func ParseUsernamePassword(c *gin.Context) (string, string, bool) + func RequestHandlerFunc(c *gin.Context) + func WrapErrorToResponse(err error) *milvuspb.BoolResponse + type AliasCollectionReq struct + AliasName string + CollectionName string + DbName string + func (req *AliasCollectionReq) GetAliasName() string + func (req *AliasCollectionReq) GetCollectionName() string + func (req *AliasCollectionReq) GetDbName() string + type AliasNameGetter interface + GetAliasName func() string + type AliasReq struct + AliasName string + DbName string + func (req *AliasReq) GetAliasName() string + func (req *AliasReq) GetDbName() string + type BaseGetter interface + GetBase func() *commonpb.MsgBase + type BufferPool struct + func (p *BufferPool) Get() *bytes.Buffer + func (p *BufferPool) Put(buf *bytes.Buffer) + type CollectionAddFunction struct + CollectionName string + DbName string + Function FunctionSchema + func (req *CollectionAddFunction) GetCollectionName() string + func (req *CollectionAddFunction) GetDbName() string + func (req *CollectionAddFunction) GetFunction() *FunctionSchema + type CollectionAlterFunction struct + CollectionName string + DbName string + Function FunctionSchema + FunctionName string + func (req *CollectionAlterFunction) GetCollectionName() string + func (req *CollectionAlterFunction) GetDbName() string + func (req *CollectionAlterFunction) GetFunction() *FunctionSchema + func (req *CollectionAlterFunction) GetFunctionName() string + type CollectionDataReq struct + CollectionName string + Data []map[string]interface{} + DbName string + PartialUpdate bool + PartitionName string + func (req *CollectionDataReq) GetDbName() string + type CollectionDropFunction struct + CollectionName string + DbName string + FunctionName string + func (req *CollectionDropFunction) GetCollectionName() string + func (req *CollectionDropFunction) GetDbName() string + func (req *CollectionDropFunction) GetFunctionName() string + type CollectionFieldReqWithParams struct + CollectionName string + DbName string + FieldName string + FieldParams map[string]interface{} + func (req *CollectionFieldReqWithParams) GetCollectionName() string + func (req *CollectionFieldReqWithParams) GetDbName() string + func (req *CollectionFieldReqWithParams) GetFieldName() string + type CollectionFieldReqWithSchema struct + CollectionName string + DbName string + Schema *FieldSchema + func (req *CollectionFieldReqWithSchema) GetCollectionName() string + func (req *CollectionFieldReqWithSchema) GetDbName() string + func (req *CollectionFieldReqWithSchema) GetFieldName() string + type CollectionFilterReq struct + CollectionName string + DbName string + ExprParams map[string]interface{} + Filter string + PartitionName string + func (req *CollectionFilterReq) GetDbName() string + type CollectionIDReq struct + CollectionName string + ConsistencyLevel string + DbName string + ID interface{} + OutputFields []string + PartitionName string + PartitionNames []string + func (req *CollectionIDReq) GetDbName() string + type CollectionNameReq struct + CollectionName string + DbName string + PartitionNames []string + func (req *CollectionNameReq) GetCollectionName() string + func (req *CollectionNameReq) GetDbName() string + func (req *CollectionNameReq) GetPartitionNames() []string + type CollectionReq struct + AutoID bool + CollectionName string + DbName string + Description string + Dimension int32 + IDType string + IndexParams []IndexParam + MetricType string + Params map[string]interface{} + PrimaryFieldName string + Schema CollectionSchema + VectorFieldName string + func (req *CollectionReq) GetDbName() string + type CollectionReqWithProperties struct + CollectionName string + DbName string + Properties map[string]interface{} + func (req *CollectionReqWithProperties) GetCollectionName() string + func (req *CollectionReqWithProperties) GetDbName() string + type CollectionSchema struct + AutoId bool + EnableDynamicField bool + Fields []FieldSchema + Functions []FunctionSchema + type CompactReq struct + CollectionName string + DbName string + IsClustering bool + func (req *CompactReq) GetCollectionName() string + func (req *CompactReq) GetDbName() string + type CreateCollectionReq struct + CollectionName string + DbName string + Description string + Dimension int32 + EnableDynamicField bool + MetricType string + PrimaryField string + VectorField string + type DatabaseReq struct + DbName string + func (req *DatabaseReq) GetDbName() string + type DatabaseReqRequiredName struct + DbName string + func (req *DatabaseReqRequiredName) GetDbName() string + type DatabaseReqWithProperties struct + DbName string + Properties map[string]interface{} + func (req *DatabaseReqWithProperties) GetDbName() string + type DeleteReq struct + CollectionName string + DbName string + Filter string + ID interface{} + type DropCollectionPropertiesReq struct + CollectionName string + DbName string + PropertyKeys []string + func (req *DropCollectionPropertiesReq) GetCollectionName() string + func (req *DropCollectionPropertiesReq) GetDbName() string + type DropCollectionReq struct + CollectionName string + DbName string + type DropDatabasePropertiesReq struct + DbName string + PropertyKeys []string + func (req *DropDatabasePropertiesReq) GetDbName() string + type DropIndexPropertiesReq struct + CollectionName string + DbName string + IndexName string + PropertyKeys []string + func (req *DropIndexPropertiesReq) GetCollectionName() string + func (req *DropIndexPropertiesReq) GetDbName() string + func (req *DropIndexPropertiesReq) GetIndexName() string + type EmptyReq struct + func (req *EmptyReq) GetDbName() string + type ErrResponse = commonpb.Status + type FieldData struct + Field json.RawMessage + FieldID int64 + FieldName string + Type schemapb.DataType + func (f *FieldData) AsSchemapb() (*schemapb.FieldData, error) + type FieldSchema struct + DataType string + DefaultValue interface{} + ElementDataType string + ElementTypeParams map[string]interface{} + FieldName string + IsClusteringKey bool + IsPartitionKey bool + IsPrimary bool + Nullable bool + func (field *FieldSchema) GetProto(ctx context.Context) (*schemapb.FieldSchema, error) + type FilesGetter interface + GetFiles func() [][]string + type FlushReq struct + CollectionName string + DbName string + func (req *FlushReq) GetCollectionName() string + func (req *FlushReq) GetDbName() string + type FunctionSchema struct + Description string + FunctionName string + FunctionType string + InputFieldNames []string + OutputFieldNames []string + Params map[string]interface{} + type FunctionScore struct + Functions []FunctionSchema + Params map[string]interface{} + type GetCompactionStateReq struct + JobID int64 + type GetQuotaMetricsReq struct + type GetReq struct + CollectionName string + DbName string + ID interface{} + OutputFields []string + type GetSegmentsInfoReq struct + CollectionID int64 + DbName string + SegmentIDs []int64 + func (req *GetSegmentsInfoReq) GetCollectionID() int64 + func (req *GetSegmentsInfoReq) GetDbName() string + func (req *GetSegmentsInfoReq) GetSegmentIDs() []int64 + type GrantReq struct + DbName string + ObjectName string + ObjectType string + Privilege string + RoleName string + func (req *GrantReq) GetDbName() string + type GrantV2Req struct + CollectionName string + DbName string + Privilege string + RoleName string + type Handlers struct + func NewHandlers(proxy types.ProxyComponent) *Handlers + func (h *Handlers) RegisterRoutesTo(router gin.IRouter) + type HandlersV1 struct + func NewHandlersV1(proxyComponent types.ProxyComponent) *HandlersV1 + func (h *HandlersV1) RegisterRoutesToV1(router gin.IRouter) + type HandlersV2 struct + func NewHandlersV2(proxyClient types.ProxyComponent) *HandlersV2 + func (h *HandlersV2) GetCollectionSchema(ctx context.Context, c *gin.Context, dbName, collectionName string) (*schemapb.CollectionSchema, error) + func (h *HandlersV2) RegisterRoutesToV2(router gin.IRouter) + type HybridSearchReq struct + CollectionName string + ConsistencyLevel string + DbName string + FunctionScore FunctionScore + GroupByField string + GroupSize int32 + Limit int32 + Offset int32 + OutputFields []string + PartitionNames []string + Rerank Rand + Search []SubSearchReq + StrictGroupSize bool + func (req *HybridSearchReq) GetDbName() string + type ImportReq struct + CollectionName string + DbName string + Files [][]string + Options map[string]string + PartitionName string + func (req *ImportReq) GetCollectionName() string + func (req *ImportReq) GetDbName() string + func (req *ImportReq) GetFiles() [][]string + func (req *ImportReq) GetOptions() map[string]string + func (req *ImportReq) GetPartitionName() string + type IndexNameGetter interface + GetIndexName func() string + type IndexParam struct + FieldName string + IndexName string + IndexType string + MetricType string + Params map[string]interface{} + type IndexParamReq struct + CollectionName string + DbName string + IndexParams []IndexParam + func (req *IndexParamReq) GetDbName() string + type IndexReq struct + CollectionName string + DbName string + IndexName string + Timestamp uint64 + func (req *IndexReq) GetCollectionName() string + func (req *IndexReq) GetDbName() string + func (req *IndexReq) GetIndexName() string + func (req *IndexReq) GetTimestamp() uint64 + type IndexReqWithProperties struct + CollectionName string + DbName string + IndexName string + Properties map[string]interface{} + func (req *IndexReqWithProperties) GetCollectionName() string + func (req *IndexReqWithProperties) GetDbName() string + func (req *IndexReqWithProperties) GetIndexName() string + type InsertReq struct + CollectionName string + Data []map[string]interface{} + DbName string + type JobIDGetter interface + GetJobID func() string + type JobIDReq struct + JobID string + func (req *JobIDReq) GetJobID() string + type NewPasswordReq struct + NewPassword string + Password string + UserName string + type OptionalCollectionNameReq struct + CollectionName string + DbName string + func (req *OptionalCollectionNameReq) GetCollectionName() string + func (req *OptionalCollectionNameReq) GetDbName() string + type OptionsGetter interface + GetOptions func() map[string]string + type PartitionReq struct + CollectionName string + DbName string + PartitionName string + func (req *PartitionReq) GetCollectionName() string + func (req *PartitionReq) GetDbName() string + func (req *PartitionReq) GetPartitionName() string + type PartitionsReq struct + CollectionName string + DbName string + PartitionNames []string + func (req *PartitionsReq) GetDbName() string + type PasswordReq struct + Password string + UserName string + type PrivilegeGroupReq struct + PrivilegeGroupName string + Privileges []string + type QueryReq struct + CollectionName string + DbName string + Filter string + Limit int32 + Offset int32 + OutputFields []string + type QueryReqV2 struct + CollectionName string + ConsistencyLevel string + DbName string + ExprParams map[string]interface{} + Filter string + Limit int32 + Offset int32 + OutputFields []string + PartitionNames []string + func (req *QueryReqV2) GetDbName() string + type Rand struct + Params map[string]interface{} + Strategy string + type RenameCollectionReq struct + CollectionName string + DbName string + NewCollectionName string + NewDbName string + func (req *RenameCollectionReq) GetDbName() string + type ResourceGroupConfig struct + Limits *ResourceGroupLimit + NodeFilter *ResourceGroupNodeFilter + Requests *ResourceGroupLimit + TransferFrom []*ResourceGroupTransfer + TransferTo []*ResourceGroupTransfer + func (req *ResourceGroupConfig) GetLimits() *ResourceGroupLimit + func (req *ResourceGroupConfig) GetNodeFilter() *ResourceGroupNodeFilter + func (req *ResourceGroupConfig) GetRequests() *ResourceGroupLimit + func (req *ResourceGroupConfig) GetTransferFrom() []*ResourceGroupTransfer + func (req *ResourceGroupConfig) GetTransferTo() []*ResourceGroupTransfer + type ResourceGroupLimit struct + NodeNum int32 + func (req *ResourceGroupLimit) GetNodeNum() int32 + type ResourceGroupNodeFilter struct + NodeLabels map[string]string + func (req *ResourceGroupNodeFilter) GetNodeLabels() map[string]string + type ResourceGroupReq struct + Config *ResourceGroupConfig + Name string + func (req *ResourceGroupReq) GetConfig() *ResourceGroupConfig + func (req *ResourceGroupReq) GetName() string + type ResourceGroupTransfer struct + ResourceGroup string + func (req *ResourceGroupTransfer) GetResourceGroup() string + type RestRequestInterceptor func(ctx context.Context, ginCtx *gin.Context, req any, ...) (any, error) + type ReturnErrMsg struct + Code int32 + Message string + type RoleNameGetter interface + GetRoleName func() string + type RoleReq struct + DbName string + RoleName string + func (req *RoleReq) GetDbName() string + func (req *RoleReq) GetRoleName() string + type RunAnalyzerReq struct + AnalyzerNames []string + AnalyzerParams string + CollectionName string + DbName string + FieldName string + Text []string + WithDetail bool + WithHash bool + func (req *RunAnalyzerReq) GetDbName() string + type SearchReq struct + CollectionName string + DbName string + Filter string + Limit int32 + Offset int32 + OutputFields []string + Params map[string]float64 + Vector []float32 + type SearchReqV2 struct + AnnsField string + CollectionName string + ConsistencyLevel string + Data []interface{} + DbName string + ExprParams map[string]interface{} + Filter string + FunctionScore FunctionScore + GroupByField string + GroupSize int32 + Limit int32 + Offset int32 + OutputFields []string + Params map[string]float64 + PartitionNames []string + SearchParams map[string]interface{} + StrictGroupSize bool + func (req *SearchReqV2) GetDbName() string + type SearchRequest struct + Base *commonpb.MsgBase + BinaryVectors [][]byte + CollectionName string + DbName string + Dsl string + DslType commonpb.DslType + GuaranteeTimestamp uint64 + Nq int64 + OutputFields []string + PartitionNames []string + SearchParams []*commonpb.KeyValuePair + TravelTimestamp uint64 + Vectors [][]float32 + type SingleInsertReq struct + CollectionName string + Data map[string]interface{} + DbName string + type SingleUpsertReq struct + CollectionName string + Data map[string]interface{} + DbName string + PartialUpdate bool + type SubSearchReq struct + AnnsField string + Data []interface{} + ExprParams map[string]interface{} + Filter string + GroupByField string + Limit int32 + MetricType string + Offset int32 + SearchParams map[string]interface{} + type Timeout struct + type TimestampGetter interface + GetTimestamp func() uint64 + type TransferReplicaReq struct + CollectionName string + ReplicaNum int64 + SourceRgName string + TargetRgName string + func (req *TransferReplicaReq) GetCollectionName() string + func (req *TransferReplicaReq) GetReplicaNum() int64 + func (req *TransferReplicaReq) GetSourceRgName() string + func (req *TransferReplicaReq) GetTargetRgName() string + type UpdateResourceGroupReq struct + ResourceGroups map[string]*ResourceGroupConfig + func (req *UpdateResourceGroupReq) GetResourceGroups() map[string]*ResourceGroupConfig + type UpsertReq struct + CollectionName string + Data []map[string]interface{} + DbName string + PartialUpdate bool + type UserNameGetter interface + GetUserName func() string + type UserReq struct + UserName string + func (req *UserReq) GetUserName() string + type UserRoleReq struct + RoleName string + UserName string + type VectorIDs struct + CollectionName string + FieldName string + IDArray []int64 + PartitionNames []string + type VectorsArray struct + BinaryVectors []byte + Dim int64 + IDs *VectorIDs + Vectors []float32 + func (v *VectorsArray) AsPbVectorArray() *milvuspb.VectorsArray + type WrappedCalcDistanceRequest struct + Base *commonpb.MsgBase + OpLeft VectorsArray + OpRight VectorsArray + Params []*commonpb.KeyValuePair + type WrappedCreateCollectionRequest struct + Base *commonpb.MsgBase + CollectionName string + ConsistencyLevel commonpb.ConsistencyLevel + DbName string + Properties []*commonpb.KeyValuePair + Schema schemapb.CollectionSchema + ShardsNum int32 + type WrappedInsertRequest struct + Base *commonpb.MsgBase + CollectionName string + DbName string + FieldsData []*FieldData + HashKeys []uint32 + NumRows uint32 + PartitionName string + func (w *WrappedInsertRequest) AsInsertRequest() (*milvuspb.InsertRequest, error) + type Writer struct + func NewWriter(w gin.ResponseWriter, buf *bytes.Buffer) *Writer + func (w *Writer) FreeBuffer() + func (w *Writer) Header() http.Header + func (w *Writer) Status() int + func (w *Writer) Write(data []byte) (int, error) + func (w *Writer) WriteHeader(code int) + func (w *Writer) WriteString(s string) (int, error)