Interface Elasticsearch

pkg/gofr/container/datasources.go:752–782

Elasticsearch defines all the operations GoFr users need.

// Elasticsearch defines all the operations GoFr users need.
type Elasticsearch interface {
	// CreateIndex creates a new index with optional mapping/settings.
	CreateIndex(ctx context.Context, index string, settings map[string]any) error

	// DeleteIndex deletes an existing index.
	DeleteIndex(ctx context.Context, index string) error

	// IndexDocument indexes (creates or replaces) a single document.
	IndexDocument(ctx context.Context, index, id string, document any) error

	// GetDocument retrieves a single document by ID.
	// Returns the raw JSON as a map.
	GetDocument(ctx context.Context, index, id string) (map[string]any, error)

	// UpdateDocument applies a partial update to an existing document.
	UpdateDocument(ctx context.Context, index, id string, update map[string]any) error

	// DeleteDocument removes a document by ID.
	DeleteDocument(ctx context.Context, index, id string) error

	// Bulk executes multiple indexing/updating/deleting operations in one request.
	// Each entry in `operations` should be a JSON‑serializable object
	// following the Elasticsearch bulk API format.
	Bulk(ctx context.Context, operations []map[string]any) (map[string]any, error)

	// Search executes a query against one or more indices.
	// Returns the entire response JSON as a map.
	Search(ctx context.Context, indices []string, query map[string]any) (map[string]any, error)

	HealthChecker
}

// ElasticsearchProvider an interface that extends Elasticsearch with additional methods for logging, metrics, and connection management.
//