API Reference

Comprehensive reference documentation for the Elastro Python Client v1.0.0.

ElasticsearchClient

class

from elastro import ElasticsearchClient

Main client class for establishing connections to Elasticsearch clusters. Supports Basic Auth, API Keys, and Elastic Cloud.

init

def __init__(hosts=None, cloud_id=None, api_key=None, username=None, password=None, verify_certs=True, ca_certs=None, client_cert=None, client_key=None, ssl_show_warn=True)

Initialize the Elasticsearch client.

Parameters

Name	Type	Required	Description
hosts	List[str]	Optional	List of node URLs (e.g. ['http://localhost:9200']) Default: None
cloud_id	str	Optional	Elastic Cloud ID Default: None
api_key	str \| Tuple	Optional	API Key for authentication Default: None
username	str	Optional	Basic Auth username Default: None
password	str	Optional	Basic Auth password Default: None
verify_certs	bool	Optional	Verify SSL certificates Default: True

Returns

ElasticsearchClient instance

Example

client = ElasticsearchClient(
    hosts=["http://localhost:9200"],
    username="elastic",
    password="changeme"
)

connect

def connect() -> bool

Establishes connection to the cluster and verifies connectivity (pings).

Returns

True if connection successful, raises ConnectionError otherwise.

info

def info() -> dict

Returns cluster information.

Returns

Dictionary containing cluster info (version, name, etc).

IndexManager

class

from elastro import IndexManager

Manage Elasticsearch indices: create, update, delete, and check existence.

create

def create(name: str, settings: Dict = None, mappings: Dict = None) -> Dict

Create a new index with optional settings and mappings.

Parameters

Name	Type	Required	Description
name	str	Required	Name of the index
settings	dict	Optional	Index settings (shards, replicas, etc) Default: None
mappings	dict	Optional	Index mappings (properties) Default: None

Returns

API response dictionary

Example

im.create(
    "logs-2024",
    settings={"number_of_shards": 1},
    mappings={"properties": {"timestamp": {"type": "date"}}}
)

delete

def delete(name: str) -> Dict

Delete an index.

Parameters

Name	Type	Required	Description
name	str	Required	Name of the index

Returns

API response dictionary

exists

def exists(name: str) -> bool

Check if an index exists.

Parameters

Name	Type	Required	Description
name	str	Required	Name of the index

Returns

True if exists, False otherwise

update

def update(name: str, settings: Dict) -> Dict

Update index settings (e.g. number of replicas). Index must often be closed for static setting changes.

Parameters

Name	Type	Required	Description
name	str	Required	Name of the index
settings	dict	Required	Settings to update

Returns

API response dictionary

DocumentManager

class

from elastro import DocumentManager

Perform CRUD and Search operations on documents.

index

def index(index: str, document: Dict, id: str = None, refresh: bool = False) -> Dict

Index a document. Creates or replaces.

Parameters

Name	Type	Required	Description
index	str	Required	Target index
document	dict	Required	Document body
id	str	Optional	Document ID. If None, auto-generated. Default: None
refresh	bool	Optional	Refresh index immediately Default: False

Returns

API response with result status

get

def get(index: str, id: str) -> Dict

Retrieve a document by ID.

Parameters

Name	Type	Required	Description
index	str	Required	Target index
id	str	Required	Document ID

Returns

The document source dictionary

search

def search(index: str, query: Dict = None, size: int = 10, from_: int = 0, sort: List = None) -> Dict

Execute a search query.

Parameters

Name	Type	Required	Description
index	str	Required	Target index or pattern
query	dict	Optional	Query DSL body (match_all if None) Default: None
size	int	Optional	Number of hits to return Default: 10
sort	list	Optional	Sort criteria Default: None

Returns

Full search response (hits, total, aggregations)

bulk

def bulk(operations: List[Dict], refresh: bool = False) -> Dict

Execute bulk operations (index, create, delete, update).

Parameters

Name	Type	Required	Description
operations	List[dict]	Required	List of bulk actions/documents

Returns

Bulk API response

Example

docs = [
    {"index": {"_index": "test", "_id": "1"}},
    {"field": "value1"},
    {"delete": {"_index": "test", "_id": "2"}}
]
dm.bulk(docs)

IlmManager

class

from elastro.core.ilm import IlmManager

Manage Index Lifecycle Management (ILM) policies.

create_policy

def create_policy(name: str, policy: Dict) -> bool

Create or update an ILM policy.

Parameters

Name	Type	Required	Description
name	str	Required	Policy name
policy	dict	Required	Policy definition (phases, actions)

Returns

True if acknowledged

explain_lifecycle

def explain_lifecycle(index: str) -> Dict

Get the current ILM status for an index.

Parameters

Name	Type	Required	Description
index	str	Required	Index name

Returns

Detailed lifecycle explanation

SnapshotManager

class

from elastro.core.snapshot import SnapshotManager

Manage snapshot repositories and backup/restore operations.

create_repository

def create_repository(name: str, repo_type: str, settings: Dict) -> bool

Parameters

Name	Type	Required	Description
name	str	Required	Repository name
repo_type	str	Required	Type (fs, s3, gcs, azure)
settings	dict	Required	Repository specific settings

Returns

True if acknowledged

create_snapshot

def create_snapshot(repository: str, snapshot: str, indices='_all', wait_for_completion=False) -> Dict

Create a snapshot of indices.

Parameters

Name	Type	Required	Description
repository	str	Required	Repository name
snapshot	str	Required	Snapshot name
indices	str \| list	Optional	Indices to backup Default: '_all'
wait_for_completion	bool	Optional	Block until finished Default: False

Returns

Snapshot response

restore_snapshot

def restore_snapshot(repository: str, snapshot: str, indices='_all', rename_pattern=None, rename_replacement=None) -> Dict

Restore indices from a snapshot.

Parameters

Name	Type	Required	Description
repository	str	Required	Repository name
snapshot	str	Required	Snapshot name
indices	str	Optional	Indices to restore Default: '_all'

Returns

Restore response