be

type Address struct {
	// Host IP address or host name
	Host string `json:"host:omitempty"`
	// Port
	Port uint32 `json:"port"`
}

type CollectionConfig struct {
	// Name of collection
	CollectionName string `json:"collection_name,omitempty"`
	// Max documents per segment, Optional field, default is max value of system(^uint64(0) = 18446744073709551615）
	MaxDocsPerSegment uint64 `json:"max_docs_per_segment"`
	// Entity of document, optional field, default is empty
	ForwardColumns []string `json:"forward_columns,omitempty"`
	// Columns of document, empty array is illegal argument
	Columns []ColumnIndex `json:"columns"`
	// Repository of collection, Optional field, nil for collection which import from client only
	Repository *DatabaseRepository `json:"repository,omitempty"`
}

type CollectionInfo struct {
	// Collection config
	CollectionConfig
	// Status of collection
	Status CollectionStatus `json:"status"`
	// Unique id of collection, allocated by ProximaSE
	UUID string `json:"uuid,omitempty"`
	// Latest LSN Context
	Context *LsnContext `json:"context"`
	// Magic number of collection
	MagicNumber uint64 `json:"magic_number"`
}

type CollectionStat struct {
	// Name of collection
	CollectionName string
	// Storage path of collection
	CollectionPath string
	// Total documents inside collection
	TotalDocCount uint64
	// The number of segments in collection
	TotalSegmentCount uint64
	// The number of files in collection
	TotalIndexFileCount uint64
	// The total size of storage, count by bytes
	TotalIndexFileSize uint64
	// Segment stats
	SegmentStats []SegmentStat
}

type CollectionStatus uint32

type ColumnIndex struct {
	// Name of column, empty Name is illegal argument
	Name string `json:"name,omitempty"`
	// Type of column, Default is IT_PROXIMA_HNSW_INDEX
	IndexType `json:"index_type"`
	// Datatype of column
	DataType `json:"data_type"`
	// Dimension of column, Default is 0
	Dimension uint32 `json:"dimension"`
	// Customized parameters for column, Optional
	ExtraParams map[string]string `json:"extra_params,omitempty"`
}

type ConnectionProtocol uint32

type DataType uint32

type DatabaseRepository struct {
	// Derived from Repository class
	Repository
	// URI of database, invalid uri will be deferred by Proxima BE,
	// example: mysql://localhost:3033/example_database
	// Details:
	//   Schema: indicate drivers, mysql is only supported
	//   Path: indicate databases
	//
	Connection string `json:"connection,omitempty"`
	// Table name
	TableName string `json:"table_name,omitempty"`
	// User name used to login database
	User string `json:"user,omitempty"`
	// User password
	Password string `json:"password,omitempty"`
}

type Document struct {
	// Primary key of document
	PrimaryKey uint64 `json:"primary_key,omitempty"`
	// Similarity of document to query vector, bigger is more similar
	Score float32 `json:"score"`
	// Properties of document
	ForwardColumns map[string]interface{} `json:"forwards,omitempty"`
}

type ErrorCode int32

type IndexType uint32

type ListCollectionFilter interface {
	// contains filtered or unexported methods
}

type LsnContext struct {
	// Sequence number of collection
	LSN uint64 `json:"lsn"`
	// Context of collection
	Context string `json:"context,omitempty"`
}

type MetricType uint32

type OperationType uint32

type ProximaSearchClient interface {
	// CreateCollection method to create one collection
	//
	// Return error not nil means error, otherwise succeed
	// Example:
	//
	CreateCollection(config *CollectionConfig) error

	// DropCollection for delete collection
	//
	// return error is nil for success, otherwise failed
	DropCollection(name string) error

	// DescribeCollection method used to retrieve details of collection
	// Argument @name indicate interested collection
	// Return pointer of CollectionInfo, error not nil for failed
	DescribeCollection(name string) (*CollectionInfo, error)

	// ListCollections method, used to retrieve collections from ProximaSE
	// Available filters listed as following:
	//   ByRepo(repo string): only list collection which name of repository equals repo.
	//                        last one task effect, if multiple instance passed
	// Return pointer of CollectionInfo array, error not nil for failed
	ListCollections(filters ...ListCollectionFilter) ([]*CollectionInfo, error)

	// StatCollection used for retrieve stat of collection
	// Return pointer of CollectionStat, error not nil for failed
	StatCollection(name string) (*CollectionStat, error)

	// Write Collection
	// Return Status object, error not nil for failed
	Write(in *WriteRequest) error

	// Perform Query Request to Proxima BE
	// Return pointer of QueryResponse, error not nil for failed
	// Note: acceptable features listed below
	//     // slice/array/matrix of [int8, uint32, uint64, float32]
	//     features := []int8{1,2,3,4}
	//     features := [5]int8{1,2,3,4}
	//     features := [][]int8{{1,2,3,4},{1,2,3,4}}
	//     features := [5][5]int8{{1,2,3,4},{1,2,3,4}}
	//     features := []uint32{1,2,3,4}
	//     features := [5]uint32{1,2,3,4}
	//     features := [][]uint32{{1,2,3,4},{1,2,3,4}}
	//     features := [5][5]uint32{{1,2,3,4},{1,2,3,4}}
	//     features := []float32{1,2,3,4}
	//     features := [5]float32{1,2,3,4}
	//     features := [][]float32{{1,2,3,4},{1,2,3,4}}
	//     features := [5][5]float32{{1,2,3,4},{1,2,3,4}}
	// opts parameter is interface of QueryOptions, possible value listed below:
	//   WithTopK(int): customize topk
	//   WithRadius(float32): customize search radius
	//   WithLinearSearch(): enable linear search
	//   WithDebugMode(): enable debug mode
	//   WithParam(string, interface{}): for advance configuration
	// example:
	//     client.Query("collection", "column", []int{1,2}, WithTopK(10), WithRadius(0.6), WithLinearSearch(), WithDebugMode(), WithParam("key", 1))
	Query(collection string, column string, features interface{}, opts ...QueryOption) (*QueryResponse, error)

	// GetDocumentByKey retrieve document which primary key was indicated by param req
	// Return pointer of Document, error not nil for failed
	GetDocumentByKey(collection string, primaryKey uint64) (*Document, error)
}

type QueryOption interface {
	// contains filtered or unexported methods
}

type QueryResponse struct {
	// Debug Information, json format string
	DebugInfo string
	// Latency of request, count by ms
	Latency uint64
	// Documents of query
	Documents [][]*Document
}

type Range struct {
	// Beginning of range
	Min uint64
	// Ending of range
	Max uint64
}

type Repository struct {
	// Name of repository, empty is illegal argument
	Name string `json:"name,omitempty"`
	// Type of repository, Optional field, Default is RT_DATABASE
	Type RepositoryType `json:"type"`
}

type RepositoryType uint32

type Row struct {
	// Primary key of row record
	PrimaryKey uint64
	// Operation type
	OperationType
	// Index column value list
	IndexColumnValues []interface{}
	// Forward column value list
	ForwardColumnValues []interface{}
	// Log Sequence Number context
	*LsnContext
}

type RowMeta struct {
	// Index column name list
	IndexColumnNames []string
	// Index column name list
	ForwardColumnNames []string
}

type SegmentStat struct {
	// ID of segment
	SegmentID uint32
	// State of segment
	State SegmentState
	// Count of documents in segment
	DocCount uint64
	// Index files inside segment
	IndexFileCount uint64
	// Size of segment
	IndexFileSize uint64
	// Range of documents inside segment
	DocsRange Range
	// Primary key range of segment
	PrimaryKeyRange Range
	// Range of document timestamp inside segment
	TimestampRange Range
	// Range of LSN
	LSNRange Range
	// Storage path of segment
	SegmentPath string
}

type SegmentState uint32

type Status struct {
	// Response code from ProximaSE, 0 for success, otherwise for failed
	Code int32 `json:"code"`
	// Detail message explain failed reason, Optional field
	Reason string `json:"reason,omitempty"`
}

type Version struct {
	// Version of client
	Client string `json:"client:omitempty"`
	// Version of ProximaSE
	Server string `json:"server:omitempty"`
}

type WriteRequest struct {
	// Name of collection
	CollectionName string
	// Meta header
	Meta RowMeta
	// Row record list
	Rows []Row
	// Request ID, Optional
	RequestID string
	// Magic number, Optional
	MagicNumber uint64
}