cbelasticsearch

Integrates Elasticsearch into ColdPress applications for scalable full-text indexing and search.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill cbelasticsearch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cbelasticsearch
Source: https://github.com/ColdBox/skills/tree/main/modules/cbelasticsearch
Command: npx skills add https://github.com/ColdBox/skills --skill cbelasticsearch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Integrating Elasticsearch into a ColdBox/BoxLang application requires correct client configuration, index mapping design, reliable bulk operations, and safe reindexing procedures; this Skill centralizes installation instructions, API usage patterns, and production best practices to reduce errors and downtime.

Core Features & Use Cases

  • Installation & Configuration: guidance for module installation, host and credential configuration, and environment-safe secrets handling.
  • Indexing: single-document saves, bulk indexing workflows, mementos for model serialization, and mapping recommendations.
  • Search and Analytics: building full-text queries with the Query DSL, filters, range queries, aggregations for faceted search, highlighting, and paginated or scroll-based retrieval.
  • Operational Patterns: index alias management for zero-downtime reindexing, health checks, and performance recommendations for production clusters.
  • Use Case Example: implement a product catalog search with keyword relevance, category facets, price range filters, and zero-downtime mapping changes.

Quick Start

Use the cbelasticsearch skill to index your product records into an Elasticsearch index and return paginated, filtered search results.

Frequently Asked Questions about cbelasticsearch

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate Elasticsearch into a ColdBox application for full-text search?

You integrate Elasticsearch into ColdBox by configuring a client with ES hosts and credentials, defining index mappings, and indexing documents for full-text search. This setup enables scalable search queries, filters, and aggregations within your application.

What is the best way to perform bulk indexing and reindexing in Elasticsearch without downtime?

The best way to perform zero-downtime bulk indexing and reindexing in Elasticsearch is using index alias management. You switch aliases to new indices during reindexing, ensuring continuous availability while updating mappings or processing bulk document operations.

How do I build faceted search and aggregations using the Elasticsearch Query DSL?

You build faceted search and aggregations using the Elasticsearch Query DSL by combining full-text queries with range filters and aggregation functions. This approach returns categorized facets and paginated results, enabling advanced search analytics and filtering.

Can I manage Elasticsearch index aliases and mappings in a ColdBox or BoxLang module?

Yes, you can manage Elasticsearch index aliases and mappings within a ColdBox or BoxLang module. The module supports alias management for zero-downtime reindexing, bulk APIs, and mapping updates for production clusters.

Does the ColdBox Elasticsearch module support scroll-based pagination and highlighting?

Yes, the ColdBox Elasticsearch module supports scroll-based pagination and highlighting. It handles scroll-based retrieval and text highlighting within full-text queries, allowing you to efficiently process large result sets and display relevant search terms.

How do I configure Elasticsearch credentials and host settings safely in ColdBox?

You configure Elasticsearch credentials and host settings safely in ColdBox using environment-safe secrets handling. The module provides guidance for host and credential configuration, ensuring secure client setup for production clusters.