# opensearch-sql

Part of **OPENSEARCH**

# OpenSearch SQL Development Console Guide

## Operations Overview

| Operation | Console Navigation | Prerequisites | Description |
|----------|-------------------|---------------|-------------|
| Create SQL Instance and Run Query | Console > OpenSearch Retrieval Engine Edition > Instance Management > Manage > Extended Features > SQL Development | An OpenSearch Retrieval Engine Edition instance, Access to the OpenSearch console | Set up a SQL development environment and execute SQL queries via the integrated IDE |

## Step-by-Step Instructions

### Create SQL Instance and Run Query

**Navigation**: Console > OpenSearch Retrieval Engine Edition > Instance Management > Manage > Extended Features > SQL Development

**Prerequisites**:
- An OpenSearch Retrieval Engine Edition instance
- Access to the OpenSearch console

1. Log on to the OpenSearch console and select **OpenSearch Retrieval Engine Edition** from the upper-left corner  
   - Element: **OpenSearch Retrieval Engine Edition** (menu) — located in the upper-left corner  
   - Notes: Ensure you are in the correct product workspace

2. Find the target instance in the list and click **Manage** in the Actions column  
   - Element: **Manage** (button) — located in the Actions column of the instance row  

3. In the left-side navigation or main content area, choose **Extended Features > SQL Development**  
   - Element: **Extended Features > SQL Development** (link) — located in the main content area  
   - Notes: A new panel or page for SQL Development will load

4. In the **SQL Instances** group, click the icon next to "SQL Instances" and then click **Create SQL Instance**  
   - Element: **Create SQL Instance** (button) — located within the SQL Instances group  
   - Notes: This action opens a dialog box for naming the instance

5. Enter a name for the SQL instance in the dialog box and click **OK**  
   - Element: **OK** (button) — located in the dialog box  
   - Notes: The SQL instance is created immediately upon confirmation

6. Write your SQL query in the script editor and click **Run** to execute it  
   - Element: **Run** (button) — located in the toolbar above the editor  
   - Notes: Results appear in the output pane below the editor; the IDE supports syntax highlighting and autocomplete

## FAQ

Q: Where can I access the SQL Development feature in the OpenSearch console?  
A: Navigate to Console > OpenSearch Retrieval Engine Edition > Instance Management, click **Manage** for your instance, then go to **Extended Features > SQL Development**.

Q: Do I need to create a SQL instance before running queries?  
A: Yes. You must first click **Create SQL Instance**, provide a name, and confirm before you can use the script editor and **Run** button.

Q: Can I modify the SQL instance name after creation?  
A: The documentation does not indicate that renaming is supported. It is recommended to choose a suitable name during initial creation.

Q: What features does the SQL editor support?  
A: The integrated IDE includes syntax highlighting, autocomplete, parameter configuration, and result viewing capabilities.

Q: What permissions are required to use SQL Development?  
A: You need console access to the OpenSearch Retrieval Engine Edition and sufficient permissions to manage the target instance (typically granted via RAM roles or account ownership).

## Pricing & Billing

### Billing Model  
Billing is based on a per-request model.

### Billing Notes  
No specific pricing details, free tier, or quota limits are provided in the source documentation.