OpenSearch with DBine
How to connect DBine to OpenSearch and what you can do once it's connected. This page is written from what the OpenSearch driver says about itself, so it matches the version of DBine you download.
Connect
- In DBine, open New connection.
- Pick OpenSearch in the list of engines.
- Fill in the fields below, press Test connection and then Save.
Default port: 9200.
General
| Field | Description |
|---|---|
| Server required | Server name or full URL. If the URL has no port, the one in the Port field is used. Example: localhost or https://my-cluster:9200 |
| Port | On Elastic Cloud it's 443 (DBine uses it only if 9200 is left). Default: 9200 |
| User | |
| Password | Kept in the system keychain, never in DBine's files. |
| API key | Base64-encoded key (id:api_key). If filled in, it replaces the user and password. Kept in the system keychain, never in DBine's files. |
| Read-only | On or off. |
SSH tunnel. The connection can go through an SSH server, even through a chain of bastions, with a password, a private key or the SSH agent. The server's fingerprint is checked against known_hosts or confirmed the first time.
SSL/TLS
| Field | Description |
|---|---|
| Encrypt the connection (TLS) | On or off. |
| Trust the server certificate | On or off. |
Advanced
| Field | Description |
|---|---|
| Show system indexes | Includes indexes, aliases and data streams that start with a dot. On or off. |
What the explorer shows
The objects appear right under the connection:
- Indexes
- Alias
- Data streams
Query editor
The editor uses OpenSearch's own query syntax, in JSON, with completion for the connection's objects. Statements and commands run against the database selected in the tab.
Ready-made templates for new objects:
- New alias
- New index template
- New ingest pipeline
- New data stream
- New ISM policy
Tools for OpenSearch
Available
- Graphical execution plans
- Live query profiler
- Server monitor
- Sessions and running queries
- Cancel another session's query from the sessions list
- Visual designer for new objects
- Rename objects
- Compare and sync schemas
- Native bulk load when migrating data
- Users and permissions
- Backups
Not available for OpenSearch
- End a session
- Locks: who blocks whom
- Manual transactions (commit and rollback)
- Index usage
- Create databases
- Drop databases
- Database properties
- Relations in the ER diagram
- Clone tables
Why a tool doesn't apply to an engine, and the details of each one, are in the engine support reference.
Generated from the OpenSearch driver 0.1.10, which DBine downloads the first time you connect to OpenSearch.