Overview

OpenSearch is a community-driven, open source search and analytics suite derived from Elasticsearch 7.10.2. Key characteristics include:

  • Full-text search: Powerful text analysis and search capabilities with relevance scoring
  • Real-time analytics: Analyze and visualize data as it arrives
  • Distributed architecture: Horizontally scalable with automatic sharding and replication
  • SQL support: Query data using familiar SQL syntax via the SQL plugin
  • Schema-free JSON documents: Store and index semi-structured data without predefined schemas
  • RESTful API: Simple HTTP-based interface for all operations
  • Open source: Apache 2.0 licensed with active community development

OpenSearch is ideal for log analytics, application search, security analytics, observability, and any use case requiring fast, scalable search and analytics.

Connecting

To connect to OpenSearch in DBCode, you’ll need:

  1. Open the DBCode Extension: Launch Visual Studio Code and open the DBCode extension.
  2. Add a New Connection: Click on the “Add Connection” icon.
  3. Complete connection form: Select OpenSearch as the database type and enter:
    • Host/Server address
    • Port (default: 9200)
    • Username and Password (if using basic authentication)
    • Or select an AWS IAM authentication profile for Amazon OpenSearch Service
    • Enable SSL/TLS if required
  4. Connect: Click save to connect to your OpenSearch cluster.
  5. Start Managing Your Data: Browse indices and run SQL queries.

For detailed instructions on connecting to databases, refer to the Connect article.

Amazon OpenSearch Service

DBCode supports connecting to Amazon OpenSearch Service using AWS IAM authentication:

  1. Create an AWS IAM authentication profile in DBCode
  2. Select “Auth Profile” as the authentication method
  3. Choose your AWS IAM profile
  4. Optionally specify the AWS region (defaults to profile region)
  5. Select the service type:
    • Amazon OpenSearch Service: For managed OpenSearch domains
    • Amazon OpenSearch Serverless: For serverless collections

OpenSearch Features in DBCode

DBCode enhances your OpenSearch development experience with:

  • SQL query editor: Write and execute OpenSearch SQL queries with syntax highlighting
  • Index browsing: Navigate through indices and their field mappings
  • Field type information: View field types and nested object structures
  • Query results visualization: View and export query results
  • Index mapping inspection: View the complete mapping (schema) of any index

By using OpenSearch with DBCode, you can efficiently explore your indices, develop SQL queries, and analyze data directly within Visual Studio Code.

For more information about OpenSearch, check out OpenSearch.