HowTo

Here are some step-by-step guides for common tasks working with Aiven for OpenSearch®. If there’s an example you’d find useful that isn’t here, please open an issue and let us know?

• Use Aiven for OpenSearch® with cURL
  • Variables
  • Connect to OpenSearch
  • Manage indices
    • Create an index
    • List of indices
    • Add an item to the index
  • Search or retrieve data
    • Search all items
    • Simple search
    • Advanced search options
• Migrate Elasticsearch data to Aiven for OpenSearch®
• Manage OpenSearch® log integration
  • Enable log integration
  • Configure log integration
  • Disable logs integration
• Upgrade to OpenSearch®
  • Fork an existing Elasticsearch to OpenSearch
  • Fork an existing Elasticsearch to Elasticsearch
  • Upgrade from Elasticsearch to OpenSearch
  • More resources
• Upgrade to OpenSearch® with Terraform
• Upgrade Elasticsearch clients to OpenSearch®
  • Migration steps
  • What if you can’t upgrade immediately?
  • Client migration examples
    • Java and Spring Boot
    • NodeJS
    • Python
• Connect with NodeJS
• Connect with Python
• Search with Python
  • Pre-requisites
    • GitHub repository
    • Connect to the OpenSearch cluster with Python
    • Upload data to OpenSearch using Python
  • Query the data
    • Use the search() method
    • Lucene query and query DSL
  • Write common queries
    • Create match query
    • Use a multi_match query
    • Match with phrases
    • Match phrases and add some slop
    • Use a term query
    • Search with a range query
    • Write fuzzy queries
  • Read more
• Search with NodeJS
  • Prepare the playground
    • File structure and GitHub repository
    • Connect to the cluster and load data
    • Extra helpers
  • Query the data
    • Find matching field values
    • Find fields with a value within a range
    • Find fields with fuzzy text matching
    • Find best match with multiple search words
    • Find matching phrases
    • Search with query string syntax
    • Combine queries to improve results
  • What’s next?
  • Resources
• Aggregation with NodeJS
  • Prepare the playground
    • File structure and GitHub repository
    • Connect to the cluster and load data
  • Aggregations
    • Structure and syntax
  • Metrics aggregations
    • Average value
    • Other simple metrics
    • Cardinality
    • Field statistics
    • Percentiles
  • Bucket aggregations
    • Buckets based on ranges
    • Buckets for every unique value
    • Find least frequent items
    • Histograms
  • Pipeline aggregations
    • Calculate moving average
    • Other moving functions
  • What’s next
  • Resources
• Control access to content in your service
  • Switch on ACL support for your service
  • Define ACLs
• Restore an OpenSearch® backup
• Dump OpenSearch® index using elasticsearch-dump
  • Copying data from OpenSearch to Aiven for OpenSearch®
    • Prerequisites
    • Import mapping
    • Import data
  • Copying data from Aiven for OpenSearch to AWS S3
    • Prerequisites
    • Export OpenSearch index data to S3
  • Resources
• Set index retention patterns
• Create alerts with OpenSearch® API
• Handle low disk space
  • Follow-up actions after cleaning space