solr_api

Documentation

Index

• Constants
• func CallCollectionsApi(ctx context.Context, cloud *solr.SolrCloud, urlParams url.Values, ...) (err error)
• func CheckAsyncRequest(ctx context.Context, cloud *solr.SolrCloud, asyncId string) (asyncState string, message string, err error)
• func CheckForCollectionsApiError(action string, header SolrResponseHeader) (hasError bool, err error)
• func CollectionsAPIError(action string, responseStatus int) error
• func DeleteAsyncRequest(ctx context.Context, cloud *solr.SolrCloud, asyncId string) (message string, err error)
• func SetMTLSHttpClient(client *http.Client)
• func SetNoVerifyTLSHttpClient(client *http.Client)
• type APIError
  • func (e APIError) Error() string
• type CollectionRouterName
• type SolrAsyncResponse
• type SolrAsyncStatus
• type SolrAsyncStatusResponse
• type SolrClusterStatus
• type SolrClusterStatusResponse
• type SolrCollectionRouter
• type SolrCollectionStatus
• type SolrDeleteRequestStatus
• type SolrOverseerStatusResponse
• type SolrReplaceNodeResponse
• type SolrReplicaState
• type SolrReplicaStatus
• type SolrReplicaType
• type SolrResponseHeader
• type SolrShardState
• type SolrShardStatus

Constants

const (
	HTTP_HEADERS_CONTEXT_KEY = "HTTP_HEADERS"
)

Functions

func CallCollectionsApi

func CallCollectionsApi(ctx context.Context, cloud *solr.SolrCloud, urlParams url.Values, response interface{}) (err error)

func CheckAsyncRequest

func CheckAsyncRequest(ctx context.Context, cloud *solr.SolrCloud, asyncId string) (asyncState string, message string, err error)

func CheckForCollectionsApiError

func CheckForCollectionsApiError(action string, header SolrResponseHeader) (hasError bool, err error)

func CollectionsAPIError

func CollectionsAPIError(action string, responseStatus int) error

func DeleteAsyncRequest

func DeleteAsyncRequest(ctx context.Context, cloud *solr.SolrCloud, asyncId string) (message string, err error)

func SetMTLSHttpClient

func SetMTLSHttpClient(client *http.Client)

func SetNoVerifyTLSHttpClient

func SetNoVerifyTLSHttpClient(client *http.Client)

Types

type APIError

type APIError struct {
	Detail string
	Status int // API-specific error code
}

func (APIError) Error

func (e APIError) Error() string

type CollectionRouterName

type CollectionRouterName string

CollectionRouterName is a string enumeration type that enumerates the ways that documents can be routed for a collection.

const (
	ImplicitRouter    CollectionRouterName = "implicit"
	CompositeIdRouter CollectionRouterName = "compositeId"
)

type SolrAsyncResponse

type SolrAsyncResponse struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// +optional
	RequestId string `json:"requestId,omitempty"`

	// +optional
	Status SolrAsyncStatus `json:"status,omitempty"`
}

type SolrAsyncStatus

type SolrAsyncStatus struct {
	// Possible states can be found here: https://github.com/apache/solr/blob/releases/lucene-solr%2F8.8.1/solr/solrj/src/java/org/apache/solr/client/solrj/response/RequestStatusState.java
	// +optional
	AsyncState string `json:"state,omitempty"`

	// +optional
	Message string `json:"msg,omitempty"`
}

type SolrAsyncStatusResponse

type SolrAsyncStatusResponse struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// +optional
	Status SolrAsyncStatus `json:"status,omitempty"`
}

type SolrClusterStatus

type SolrClusterStatus struct {
	// +optional
	Collections map[string]SolrCollectionStatus `json:"collections,omitempty"`

	// +optional
	Aliases map[string]string `json:"aliases,omitempty"`

	// +optional
	Roles map[string][]string `json:"roles,omitempty"`

	// +optional
	LiveNodes []string `json:"live_nodes,omitempty"`
}

type SolrClusterStatusResponse

type SolrClusterStatusResponse struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// +optional
	ClusterStatus SolrClusterStatus `json:"cluster,omitempty"`
}

type SolrCollectionRouter

type SolrCollectionRouter struct {
	Name CollectionRouterName `json:"name"`
}

type SolrCollectionStatus

type SolrCollectionStatus struct {
	// +optional
	Shards map[string]SolrShardStatus `json:"shards,omitempty"`

	// +optional
	ConfigName string `json:"configName,omitempty"`

	// +optional
	ZnodeVersion intstr.IntOrString `json:"znodeVersion,omitempty"`

	// +optional
	AutoAddReplicas string `json:"autoAddReplicas,omitempty"`

	// +optional
	NrtReplicas intstr.IntOrString `json:"nrtReplicas,omitempty"`

	// +optional
	TLogReplicas intstr.IntOrString `json:"tlogReplicas,omitempty"`

	// +optional
	PullReplicas intstr.IntOrString `json:"pullReplicas,omitempty"`

	// +optional
	MaxShardsPerNode intstr.IntOrString `json:"maxShardsPerNode,omitempty"`

	// +optional
	ReplicationFactor intstr.IntOrString `json:"replicationFactor,omitempty"`

	// +optional
	Router SolrCollectionRouter `json:"router,omitempty"`
}

type SolrDeleteRequestStatus

type SolrDeleteRequestStatus struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// Status of the delete request
	// +optional
	Status string `json:"status,omitempty"`
}

type SolrOverseerStatusResponse

type SolrOverseerStatusResponse struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// +optional
	Leader string `json:"leader,omitempty"`

	// +optional
	QueueSize int `json:"overseer_queue_size,omitempty"`

	// +optional
	WorkQueueSize int `json:"overseer_work_queue_size,omitempty"`

	// +optional
	CollectionQueueSize int `json:"overseer_collection_queue_size,omitempty"`
}

type SolrReplaceNodeResponse

type SolrReplaceNodeResponse struct {
	ResponseHeader SolrResponseHeader `json:"responseHeader"`

	// +optional
	Success string `json:"success,omitempty"`

	// +optional
	Failure string `json:"failure,omitempty"`
}

type SolrReplicaState

type SolrReplicaState string

const (
	ReplicaActive         SolrReplicaState = "active"
	ReplicaDown           SolrReplicaState = "down"
	ReplicaRecovering     SolrReplicaState = "recovering"
	ReplicaRecoveryFailed SolrReplicaState = "recovery_failed"
)

type SolrReplicaStatus

type SolrReplicaStatus struct {
	State SolrReplicaState `json:"state"`

	Core string `json:"core"`

	NodeName string `json:"node_name"`

	BaseUrl string `json:"base_url"`

	Leader bool `json:"leader,string"`

	// +optional
	Type SolrReplicaType `json:"type,omitempty"`
}

type SolrReplicaType

type SolrReplicaType string

const (
	NRT  SolrReplicaType = "NRT"
	TLOG SolrReplicaType = "TLOG"
	PULL SolrReplicaType = "PULL"
)

type SolrResponseHeader

type SolrResponseHeader struct {
	Status int `json:"status"`

	QTime int `json:"QTime"`
}

type SolrShardState

type SolrShardState string

const (
	ShardActive SolrShardState = "active"
	ShardDown   SolrShardState = "down"
)

type SolrShardStatus

type SolrShardStatus struct {
	// +optional
	Replicas map[string]SolrReplicaStatus `json:"replicas,omitempty"`

	// +optional
	Range string `json:"range,omitempty"`

	// +optional
	State SolrShardState `json:"state,omitempty"`
}