Skip to content

Commit

Permalink
[CCI] Create index lifecycle guide (#362)
Browse files Browse the repository at this point in the history
* Create index lifecycle guide

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

* Add changelog entry

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

* Replace ignore param and add short corrections

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

* reset spaces

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

* Correct indents

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>

---------

Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
  • Loading branch information
Nicksqain authored Apr 24, 2023
1 parent 5fa4e8c commit 12b2748
Show file tree
Hide file tree
Showing 2 changed files with 158 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Added
- Added async support for helpers that are merged from opensearch-dsl-py ([#329](https://github.com/opensearch-project/opensearch-py/pull/329))
- Added search.md to guides ([#356](https://github.com/opensearch-project/opensearch-py/pull/356))
- Added index lifecycle guide ([#362](https://github.com/opensearch-project/opensearch-py/pull/362))
### Changed
- Upgrading pytest-asyncio to latest version - 0.21.0 ([#339](https://github.com/opensearch-project/opensearch-py/pull/339))
### Deprecated
Expand Down
157 changes: 157 additions & 0 deletions guides/index_lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# Index Lifecycle

This guide covers OpenSearch Python Client API actions for Index Lifecycle. You'll learn how to create, read, update, and delete indices in your OpenSearch cluster. We will also leverage index templates to create default settings and mappings for indices of certain patterns.

## Setup

In this guide, we will need an OpenSearch cluster with more than one node. Let's use the sample [docker-compose.yml](https://opensearch.org/samples/docker-compose.yml) to start a cluster with two nodes. The cluster's API will be available at `localhost:9200` with basic authentication enabled with default username and password of `admin:admin`.

To start the cluster, run the following command:

```bash
cd /path/to/docker-compose.yml
docker-compose up -d
```

Let's create a client instance to access this cluster:

```python
from opensearchpy import OpenSearch

client = OpenSearch(
hosts=['https://admin:admin@localhost:9200'],
use_ssl=True,
verify_certs=False
)

print(client.info()) # Check server info and make sure the client is connected
```

## Index API Actions

### Create a new index

You can quickly create an index with default settings and mappings by using the `indices.create` API action. The following example creates an index named `paintings` with default settings and mappings:

```python
client.indices.create(index='paintings')
```

To specify settings and mappings, you can pass them as the `body` of the request. The following example creates an index named `movies` with custom settings and mappings:

```python
client.indices.create(
index='movies',
body={
'settings': {
'index': {
'number_of_shards': 2,
'number_of_replicas': 1
}
},
'mappings': {
'properties': {
'title': {'type': 'text'},
'year': {'type': 'integer'}
}
}
}
)
```

When you create a new document for an index, OpenSearch will automatically create the index if it doesn't exist:

```python
print(client.indices.exists(index='burner')) # => False
client.index(id='1', index='burner', body={'lorem': 'ipsum'})
print(client.indices.exists(index='burner')) # => True
```

### Update an Index

You can update an index's settings and mappings by using the `indices.put_settings` and `indices.put_mapping` API actions.

The following example updates the `movies` index's number of replicas to `0`:

```python
client.indices.put_settings(
index='movies',
body={
'index': {
'number_of_replicas': 0
}
}
)
```

The following example updates the `movies` index's mappings to add a new field named `director`:

```python
client.indices.put_mapping(
index='movies',
body={
'properties': {
'director': {'type': 'text'}
}
}
)
```

### Get Metadata for an Index

Let's check if the index's settings and mappings have been updated by using the `indices.get` API action:

```python
print(client.indices.get(index='movies'))
```

The response body contains the index's settings and mappings:

```python
{
"movies": {
"aliases": {},
"mappings": {
"properties": {
"title": {"type": "text"},
"year": {"type": "integer"},
"director": {"type": "text"}
}
},
"settings": {
"index": {
"creation_date": "1680297372024",
"number_of_shards": "2",
"number_of_replicas": "0",
"uuid": "FEDWXgmhSLyrCqWa8F_aiA",
"version": {"created": "136277827"},
"provided_name": "movies"
}
}
}
}
```

### Delete an Index

Let's delete the `movies` index by using the `indices.delete` API action:

```python
client.indices.delete(index='movies')
```

We can also delete multiple indices at once:

```python
client.indices.delete(index=['movies', 'paintings', 'burner'], ignore_unavailable=True)
```

Notice that we are passing `ignore_unavailable=True` to the request. This tells the client to ignore the `404` error if the index doesn't exist for deletion. Without it, the above `delete` request will throw an error because the `movies` index has already been deleted in the previous example.

## Cleanup

All resources created in this guide are automatically deleted when the cluster is stopped. You can stop the cluster by running the following command:

```bash
docker-compose down
```

0 comments on commit 12b2748

Please sign in to comment.