Added document lifecycle guide & sample code.

CHANGELOG.md

@@ -10,10 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added benchmarks ([#537](https://github.com/opensearch-project/opensearch-py/pull/537))
 - Added guide on making raw JSON REST requests ([#542](https://github.com/opensearch-project/opensearch-py/pull/542))
 - Added support for AWS SigV4 for urllib3 ([#547](https://github.com/opensearch-project/opensearch-py/pull/547))
-- Added `remote store` client APIs ([#552](https://github.com/opensearch-project/opensearch-py/pull/552))
-- Added `nox -rs generate` ([#554](https://github.com/opensearch-project/opensearch-py/pull/554))
-- Added a utf-8 header to all .py files ([#557](https://github.com/opensearch-project/opensearch-py/pull/557))
-- Added `samples`, `benchmarks` and `docs` to `nox -rs format` ([#556](https://github.com/opensearch-project/opensearch-py/pull/556))
+- Added guide on the document lifecycle API(s) ([#545](https://github.com/opensearch-project/opensearch-py/pull/545))
 ### Changed
 - Generate `tasks` client from API specs ([#508](https://github.com/opensearch-project/opensearch-py/pull/508))
 - Generate `ingest` client from API specs ([#513](https://github.com/opensearch-project/opensearch-py/pull/513))

USER_GUIDE.md

@@ -157,6 +157,7 @@ print(response)
 - [Advanced Index Actions](guides/advanced_index_actions.md)
 - [Making Raw JSON REST Requests](guides/json.md)
 - [Connection Classes](guides/connection_classes.md)
+- [Document Lifcycle](guides/document_lifecycle.md)
 
 ## Plugins
 

guides/document_lifecycle.md

@@ -0,0 +1,182 @@
+# Document Lifecycle Guide
+- [Document Lifecycle](#document-lifecycle)
+  - [Setup](#setup)
+  - [Document API Actions](#document-api-actions)
+    - [Create a new document with specified ID](#create-a-new-document-with-specified-id)
+    - [Create a new document with auto-generated ID](#create-a-new-document-with-auto-generated-id)
+    - [Get a document](#get-a-document)
+    - [Get multiple documents](#get-multiple-documents)
+    - [Check if a document exists](#check-if-a-document-exists)
+    - [Update a document](#update-a-document)
+    - [Update multiple documents by query](#update-multiple-documents-by-query)
+    - [Delete a document](#delete-a-document)
+    - [Delete multiple documents by query](#delete-multiple-documents-by-query)
+  - [Cleanup](#cleanup)
+
+
+# Document Lifecycle
+This guide covers OpenSearch Python Client API actions for Document Lifecycle. You'll learn how to create, read, update, and delete documents in your OpenSearch cluster. Whether you're new to OpenSearch or an experienced user, this guide provides the information you need to manage your document lifecycle effectively.
+
+## Setup
+Assuming you have OpenSearch running locally on port 9200, you can create a client instance
+with the following code:
+
+```python
+from opensearchpy import OpenSearch
+client = OpenSearch(
+    hosts=['https://localhost:9200'],
+    use_ssl=True,
+    verify_certs=False,
+    http_auth=('admin', 'admin')
+)
+```
+
+Next, create an index named `movies` with the default settings:
+
+```python
+index = 'movies'
+if not client.indices.exists(index=index):
+    client.indices.create(index=index)
+```
+
+## Document API Actions
+
+### Create a new document with specified ID
+To create a new document, use the `create` or `index` API action. The following code creates two new documents with IDs of `1` and `2`:
+
+```python
+client.create(index=index, id=1, body={'title': 'Beauty and the Beast', 'year': 1991})
+client.create(index=index, id=2, body={'title': 'Beauty and the Beast - Live Action', 'year': 2017})
+```
+
+Note that the `create` action is NOT idempotent. If you try to create a document with an ID that already exists, the request will fail:
+
+```python
+try:
+    client.create(index=index, id=1, body={'title': 'Just Another Movie'})
+except Exception as e:
+    print(e)
+```
+
+The `index` action, on the other hand, is idempotent. If you try to index a document with an existing ID, the request will succeed and overwrite the existing document. Note that no new document will be created in this case. You can think of the `index` action as an upsert:
+
+```python
+client.index(index=index, id=2, body={'title': 'Updated Title'})
+client.index(index=index, id=2, body={'title': 'The Lion King', 'year': 1994})
+```
+
+### Create a new document with auto-generated ID
+You can also create a new document with an auto-generated ID by omitting the `id` parameter. The following code creates documents with an auto-generated IDs in the `movies` index:
+
+```python
+client.index(index=index, body={"title": "The Lion King 2", "year": 1998})
+```
+
+In this case, the ID of the created document in the `result` field of the response body:
+
+```python
+{
+    "_index": "movies",
+    "_type": "_doc",
+    "_id": "1",
+    "_version": 1,
+    "result": "created",
+    "_shards": {
+    "total": 2,
+    "successful": 1,
+    "failed": 0
+    },
+    "_seq_no": 0,
+    "_primary_term": 1
+}
+```
+
+### Get a document
+To get a document, use the `get` API action. The following code gets the document with ID `1` from the `movies` index:
+
+```python
+client.get(index=index, id=1)['_source']
+# OUTPUT: {"title"=>"Beauty and the Beast","year"=>1991}
+```
+
+You can also use `_source_includes` and `_source_excludes` parameters to specify which fields to include or exclude in the response:
+
+```python
+client.get(index=index, id=1, _source_includes=['title'])['_source']
+# OUTPUT: {"title": "Beauty and the Beast"}
+
+client.get(index=index, id=1, _source_excludes=['title'])['_source']
+# OUTPUT: {"year": 1991}
+```
+
+### Get multiple documents
+To get multiple documents, use the `mget` API action:
+
+```python
+client.mget(index=index, body={ 'docs': [{ '_id': 1 }, { '_id': 2 }] })['docs']
+```
+
+### Check if a document exists
+To check if a document exists, use the `exists` API action. The following code checks if the document with ID `1` exists in the `movies` index:
+
+```python
+client.exists(index=index, id=1)
+```
+
+### Update a document
+To update a document, use the `update` API action. The following code updates the `year` field of the document with ID `1` in the `movies` index:
+
+```python
+client.update(index=index, id=1, body={'doc': {'year': 1995}})
+```
+
+Alternatively, you can use the `script` parameter to update a document using a script. The following code increments the `year` field of the of document with ID `1` by 5 using painless script, the default scripting language in OpenSearch:
+
+```python
+client.update(index=index, id=1, body={ 'script': { 'source': 'ctx._source.year += 5' } })
+```
+
+Note that while both `update` and `index` actions perform updates, they are not the same. The `update` action is a partial update, while the `index` action is a full update. The `update` action only updates the fields that are specified in the request body, while the `index` action overwrites the entire document with the new document.
+
+### Update multiple documents by query
+
+To update documents that match a query, use the `update_by_query` API action. The following code decreases the `year` field of all documents with `year` greater than 2023:
+
+```python
+client.update_by_query(index=index, body={
+  'script': { 'source': 'ctx._source.year -= 1' },
+  'query': { 'range': { 'year': { 'gt': 2023 } } }
+})
+```
+
+### Delete a document
+To delete a document, use the `delete` API action. The following code deletes the document with ID `1`:
+
+```python
+client.delete(index=index, id=1)
+```
+
+By default, the `delete` action is not idempotent. If you try to delete a document that does not exist, or delete the same document twice, you will run into Not Found (404) error. You can make the `delete` action idempotent by setting the `ignore` parameter to `404`:
+
+```python
+client.delete(index=index, id=1, ignore=404)
+```
+
+### Delete multiple documents by query
+To delete documents that match a query, use the `delete_by_query` API action. The following code deletes all documents with `year` greater than 2023:
+
+```python
+client.delete_by_query(index=index, body={
+  'query': { 'range': { 'year': { 'gt': 2023 } } }
+})
+```
+
+## Cleanup
+To clean up the resources created in this guide, delete the `movies` index:
+
+```python
+client.indices.delete(index=index)
+```
+
+# Sample Code
+See [document_lifecycle_sample.py](/samples/document_lifecycle/document_lifecycle_sample.py) for a working sample of the concepts in this guide.

samples/document_lifecycle/document_lifecycle_sample.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+
+# -*- coding: utf-8 -*-
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
+from opensearchpy import OpenSearch
+
+# For cleaner output, comment in the two lines below to disable warnings and informational messages
+# import urllib3
+# urllib3.disable_warnings()
+
+
+# Connect to OpenSearch
+client = OpenSearch(
+    hosts=["https://localhost:9200"],
+    use_ssl=True,
+    verify_certs=False,
+    http_auth=("admin", "admin"),
+)
+
+# Create an index
+index = "movies"
+if not client.indices.exists(index=index):
+    client.indices.create(index=index)
+
+# Create documents
+client.index(index=index, id=1, body={"title": "Beauty and the Beast", "year": 1991})
+client.index(
+    index=index,
+    id=2,
+    body={"title": "Beauty and the Beast - Live Action", "year": 2017},
+)
+
+# Index a document
+client.index(index=index, id=2, body={"title": "The Lion King", "year": 1994})
+
+# Create a document with auto-generated ID
+result = client.index(index=index, body={"title": "The Lion King 2", "year": 1998})
+print(result)
+
+# Get a document
+result = client.get(index=index, id=1)["_source"]
+print(result)
+
+# Get a document with _source includes
+result = client.get(index=index, id=1, _source_includes=["title"])["_source"]
+print(result)
+
+# Get a document with _source excludes
+result = client.get(index=index, id=1, _source_excludes=["title"])["_source"]
+print(result)
+
+# Get multiple documents
+result = client.mget(index=index, body={"docs": [{"_id": 1}, {"_id": 2}]})["docs"]
+print(result)
+
+# Check if a document exists
+result = client.exists(index=index, id=1)
+print(result)
+
+# Update a document
+client.update(index=index, id=1, body={"doc": {"year": 1995}})
+
+# Update a document using script
+client.update(index=index, id=1, body={"script": {"source": "ctx._source.year += 5"}})
+
+# Update multiple documents by query
+client.update_by_query(
+    index=index,
+    body={
+        "script": {"source": "ctx._source.year -= 1"},
+        "query": {"range": {"year": {"gt": 2023}}},
+    },
+)
+
+# Delete a document
+client.delete(index=index, id=1)
+
+# Delete a document with ignore 404
+client.delete(index=index, id=1, ignore=404)
+
+# Delete multiple documents by query
+client.delete_by_query(index=index, body={"query": {"range": {"year": {"gt": 2023}}}})
+
+# Delete the index
+client.indices.delete(index=index)
+print("Deleted index!")