states

type ApplicationState struct {
	// contains filtered or unexported fields
}

type AssembleIndexFilesParam struct {
	framework.ParamBase `use:"assemble-indexfiles [directory]" desc:""`
	// contains filtered or unexported fields
}

type BackupParam struct {
	framework.ParamBase `use:"backup" desc:"backup etcd key-values"`

	IgnoreRevision bool  `name:"ignoreRevision" default:"false" desc:"backup ignore revision change, ONLY shall works with no nodes online"`
	BatchSize      int64 `name:"batchSize" default:"100" desc:"batch fetch size for etcd backup operation"`
	// contains filtered or unexported fields
}

type BinlogIterator struct {
	// contains filtered or unexported fields
}

type CheckPartitionKeyParam struct {
	framework.ParamBase `use:"check-partiton-key" desc:"check partition key field file"`
	Storage             string `name:"storage" default:"auto" desc:"storage service configuration mode"`
	StopIfErr           bool   `name:"stopIfErr" default:"true"`
	OutputPrimaryKey    bool   `name:"outputPK" default:"true" desc:"print error record primary key info in stdout mode"`
	MinioAddress        string `name:"minioAddr" default:"" desc:"the minio address to override, leave empty to use milvus.yaml value"`
	OutputFormat        string `name:"outputFmt" default:"stdout"`

	CollectionID int64 `name:"collection" default:"0" desc:"target collection to scan, default scan all partition key collections"`
}

type ConnectParams struct {
	framework.ParamBase `use:"connect" desc:"Connect to metastore"`
	EtcdAddr            string `name:"etcd" default:"127.0.0.1:2379" desc:"the etcd endpoint to connect"`
	RootPath            string `name:"rootPath" default:"by-dev" desc:"meta root paht milvus is using"`
	MetaPath            string `name:"metaPath" default:"meta" desc:"meta path prefix"`
	Force               bool   `name:"force" default:"false" desc:"force connect ignoring ping Etcd & rootPath check"`
	Dry                 bool   `name:"dry" default:"false" desc:"dry connect without specifying milvus instance"`
	UseSSL              bool   `name:"use_ssl" default:"false" desc:"enable to use SSL"`
	EnableTLS           bool   `name:"enableTLS" default:"false" desc:"use TLS"`
	RootCA              string `name:"rootCAPem" default:"" desc:"root CA pem file path"`
	ETCDPem             string `name:"etcdCert" default:"" desc:"etcd tls cert file path"`
	ETCDKey             string `name:"etcdKey" default:"" desc:"etcd tls key file path"`
	ETCDUserName        string `name:"etcdUserName" default:"" desc:"etcd credential username"`
	ETCDPassword        string `name:"etcdPassword" default:"" desc:"etcd creidentail password"`
	TLSMinVersion       string `name:"min_version" default:"1.2" desc:"TLS min version"`
	// TiKV Params
	UseTiKV       bool   `name:"use_tikv" default:"false" desc:"enable to use tikv for metastore"`
	TiKVTLSCACert string `name:"tikvCACert" default:"" desc:"tikv root CA pem file path"`
	TiKVTLSCert   string `name:"tikvCert" default:"" desc:"tikv tls cert file path"`
	TiKVTLSKey    string `name:"tikvKey" default:"" desc:"tikv tls key file path"`
	TiKVUseSSL    bool   `name:"tikv_use_ssl" default:"false" desc:"enable to use SSL for tikv"`
	TiKVAddr      string `name:"tikv" default:"127.0.0.1:2389" desc:"the tikv endpoint to connect"`

	Auto bool `name:"auto" default:"false" desc:"auto detect rootPath if possible"`
}

type ConsumeParam struct {
	framework.ParamBase `use:"consume" desc:"consume msgs from provided topic"`
	StartPosition       string `name:"start_pos" default:"cp" desc:"position to start with"`
	MqType              string `name:"mq_type" default:"pulsar" desc:"message queue type to consume"`
	MqAddress           string `name:"mq_addr" default:"pulsar://127.0.0.1:6650" desc:"message queue service address"`
	Topic               string `name:"topic" default:"" desc:"topic to consume"`
	ShardName           string `name:"shard_name" default:"" desc:"shard name(vchannel name) to filter with"`
	Detail              bool   `name:"detail" default:"false" desc:"print msg detail"`
	ManualID            int64  `name:"manual_id" default:"0" desc:"manual id"`
}

type DisconnectParam struct {
	framework.ParamBase `use:"disconnect" desc:"disconnect online states"`
	// contains filtered or unexported fields
}

type DownloadPKParam struct {
	framework.ParamBase `use:"download-pk" desc:"download segment pk with provided collection/segment id"`
	MinioAddress        string `name:"minioAddr" default:"" desc:"the minio address to override, leave empty to use milvus.yaml value"`
	CollectionID        int64  `name:"collection" default:"0" desc:"collection id to download"`
	SegmentID           int64  `name:"segment" default:"0" desc:"segment id to download"`
}

type DownloadSegmentParam struct {
	framework.ParamBase `use:"download-segment" desc:"download segment file with provided segment id"`
	MinioAddress        string `name:"minioAddr" default:"" desc:"the minio address to override, leave empty to use milvus.yaml value"`
	SegmentID           int64  `name:"segment" default:"0" desc:"segment id to download"`
}

type DryModeParam struct {
	framework.ParamBase `use:"dry-mode" desc:"enter dry mode to select instance"`
}

type FindMilvusParam struct {
	framework.ParamBase `use:"find-milvus" desc:"search kvs to find milvus instance"`
}

type FloatVector []float32

type ForceReleaseParam struct {
	framework.ParamBase `use:"force-release"`
	CollectionID        int64 `name:"collection" default:"0" desc:"collection id to force release"`
	All                 bool  `name:"all" default:"false" desc:"force release all collections loaded"`
}

type FrameScreen struct {
	// contains filtered or unexported fields
}

type GetConfigurationParam struct {
	framework.ParamBase `use:"show configurations" desc:"iterate all online components and inspect configuration"`
	Format              string `name:"format" default:"line" desc:"output format"`
	DialTimeout         int64  `name:"dialTimeout" default:"2" desc:"grpc dial timeout in seconds"`
	Filter              string `name:"filter" default:"" desc:"configuration key filter sub string"`
}

type GetDistributionParam struct {
	framework.ParamBase `use:"show segment-loaded-grpc" desc:"list segments loaded information"`
	CollectionID        int64 `name:"collection" default:"0" desc:"collection id to filter with"`
	NodeID              int64 `name:"node" default:"0" desc:"node id to check"`
}

type HealthzCheckParam struct {
	framework.ParamBase `use:"healthz-check" desc:"perform healthz check for connect instance"`
	Items               []string `name:"items" default:"" desc:"healthz check items"`
}

type InstanceState struct {
	*framework.CmdState
	*show.ComponentShow
	*remove.ComponentRemove
	*repair.ComponentRepair
	*set.ComponentSet
	// contains filtered or unexported fields
}

type ListHealthzCheckParam struct {
	framework.ParamBase `use:"show healthz-checks" desc:"list available healthz check items"`
}

type ListMetricsPortParam struct {
	framework.ParamBase `use:"list metrics-port" desc:"list metrics port for online components"`
	DialTimeout         int64 `name:"dialTimeout" default:"2" desc:"grpc dial timeout in seconds"`
}

type ListStatesParam struct {
	framework.ParamBase `use:"list states" desc:"list current connected states"`
}

type ListSubscriptionParam struct {
	framework.ParamBase `use:"list subscription" desc:"list subscriptions for provided topic"`
	Tenant              string `name:"tenant" default:"public" desc:"tenant name to list"`
	Namespace           string `name:"namespace" default:"default" desc:"namespace name to list"`
	Topic               string `name:"topic" default:"" desc:"topic to check subscription"`
}

type ListTopicParam struct {
	framework.ParamBase `use:"list topic" desc:"list topics in instance"`
	Tenant              string `name:"tenant" default:"public" desc:"tenant name to list"`
	Namespace           string `name:"namespace" default:"default" desc:"namespace name to list"`
}

type ListenEventParam struct {
	framework.ParamBase `use:"listen-events"`
	Localhost           bool `name:"localhost" default:"false" desc:"localhost components"`
}

type LoadBackupParam struct {
	framework.ParamBase `use:"load-backup [file]" desc:"load etcd backup file"`

	UseWorkspace  bool   `name:"use-workspace" default:"false"`
	WorkspaceName string `name:"workspace-name" default:""`
	// contains filtered or unexported fields
}

type MinioConnectParam struct {
	MinioAddress  string `name:"minioAddress"`
	MinioPasswd   string `name:"minioPassword"`
	MinioUserName string `name:"minioUsername"`
}

type NodeItem struct {
	// contains filtered or unexported fields
}

type OpenParam struct {
	framework.ParamBase `use:"open-workspace [workspace-name]" desc:"Open workspace"`
	// contains filtered or unexported fields
}

type ParseIndexParam struct {
	framework.ParamBase `use:"parse-indexparam [file]" desc:"parse index params"`
	// contains filtered or unexported fields
}

type ParseTSParam struct {
	framework.ParamBase `use:"parse-ts" desc:"parse hybrid timestamp"`
	// contains filtered or unexported fields
}

type PprofParam struct {
	framework.ParamBase `use:"pprof" desc:"get pprof from online components"`
	Type                string `name:"type" default:"goroutine" desc:"pprof metric type to fetch"`
	Port                int64  `name:"port" default:"9091" desc:"metrics port milvus component is using"`
}

type PrintVerParam struct {
	framework.ParamBase `use:"version" desc:"print version"`
}

type ProbePKParam struct {
	framework.ParamBase `use:"probe pk" desc:"probe pk in segment"`
	CollectionID        int64    `name:"collection" default:"0" desc:"collection id to probe"`
	PK                  string   `name:"pk" default:"" desc:"pk value to probe"`
	OutputFields        []string `name:"outputField" default:"" desc:"output fields list"`
	MvccTimestamp       int64    `name:"mvccTimestamp" default:"0" desc:"mvcc timestamp to probe"`
}

type PulsarctlParam struct {
	framework.ParamBase `use:"pulsarctl" desc:"connect to pulsar admin with pulsarctl"`
	Address             string `name:"addr" default:"http://localhost:18080" desc:"pulsar admin address"`
	AuthPlugin          string `name:"authPlugin" default:"" desc:"pulsar admin auth plugin"`
	AuthParam           string `name:"authParam" default:"" desc:"pulsar admin auth parameters"`
}

type ScanBinlogParams struct {
	framework.ParamBase `use:"scan-binlog" desc:"scan binlog to check data"`
	CollectionID        int64    `name:"collection" default:"0"`
	PartitionID         int64    `name:"partition" default:"0"`
	SegmentID           int64    `name:"segment" default:"0"`
	Fields              []string `name:"fields"`
	Expr                string   `name:"expr"`
	MinioAddress        string   `name:"minioAddr"`
	SkipBucketCheck     bool     `name:"skipBucketCheck" default:"false" desc:"skip bucket exist check due to permission issue"`
	Action              string   `name:"action" default:"count"`
	IgnoreDelete        bool     `name:"ignoreDelete" default:"false" desc:"ignore delete logic"`
	IncludeUnhealthy    bool     `name:"includeUnhealthy" default:"false" desc:"also check dropped segments"`
	WorkerNum           int64    `name:"workerNum" default:"4" desc:"worker num"`
	OutputLimit         int64    `name:"outputLimit" default:"10" desc:"output limit"`
}

type ScanDeltalogParams struct {
	framework.ParamBase `use:"scan-deltalog" desc:"scan deltalog to check delta data"`
	CollectionID        int64    `name:"collection" default:"0"`
	SegmentID           int64    `name:"segment" default:"0"`
	Fields              []string `name:"fields"`
	Expr                string   `name:"expr"`
	MinioAddress        string   `name:"minioAddr"`
	SkipBucketCheck     bool     `name:"skipBucketCheck" default:"false" desc:"skip bucket exist check due to permission issue"`
	Action              string   `name:"action" default:"count"`
	Limit               int64    `name:"limit" default:"0" desc:"limit the scan line number if action is locate"`
	IncludeUnhealthy    bool     `name:"includeUnhealthy" default:"false" desc:"also check dropped segments"`
}

type ScoreBalanceParam struct {
	UnbalanceTolerationFactor        float64
	ReverseUnbalanceTolerationFactor float64
	// contains filtered or unexported fields
}

type SegmentItem struct {
	// contains filtered or unexported fields
}

type SetConfigParam struct {
	framework.ParamBase `use:"set bw-config" desc:"set birdwatcher config"`
	Key                 string `name:"key" default:""`
	Value               string `name:"value" default:""`
	Source              string `name:"source" default:"env" desc:"config source, default is env"`
}

type SetCurrentVersionParam struct {
	framework.ParamBase `use:"set current-version" desc:"set current version for etcd meta parsing"`
	// contains filtered or unexported fields
}

type ShowCurrentVersionParam struct {
	framework.ParamBase `use:"show current-version" desc:"display current Milvus Meta data version"`
}

type SliceMeta struct {
	Meta []struct {
		Name        string `json:"name"`
		SliceNum    int    `json:"slice_num"`
		TotalLength int64  `json:"total_len"`
	} `json:"meta"`
}

type StorageAnalysisParam struct {
	framework.ParamBase `use:"storage-analysis" desc:"segment storage analysis" require:"etcd,minio"`
	CollectionID        int64 `name:"collection" default:"0" desc:"collection id to analysis"`
	Detail              bool  `name:"detail" default:"false" desc:"print detailed binlog size info"`
}

type TestMinioCfgParam struct {
	framework.ParamBase `use:"test-minio-cfg"`
	// *MinioConnectParam
	MinioAddress  string `name:"minioAddress"`
	MinioPasswd   string `name:"minioPassword"`
	MinioUserName string `name:"minioUsername"`
}

type UseParam struct {
	framework.ParamBase `use:"use [instance-name]" desc:"use specified milvus instance"`

	Force    bool   `name:"force" default:"false" desc:"force connect ignoring ping result"`
	MetaPath string `name:"metaPath" default:"meta" desc:"meta path prefix"`
	// contains filtered or unexported fields
}

type ValidateIndexParam struct {
	framework.ParamBase `use:"validate-indexfiles [directory]" desc:"validate index file size"`
	// contains filtered or unexported fields
}

type WALMessageIDParam struct {
	framework.ParamBase `use:"parse-wal-message-id" desc:"parse wal message id from binary"`
	IDBinary            string `name:"id-binary" default:"" desc:"string of binary message id"`
	WALName             string `name:"wal-name" default:"" desc:"a hint of wal name, auto guess if not provided"`
}