-
Notifications
You must be signed in to change notification settings - Fork 184
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a guide on making raw JSON REST requests. (#542)
Signed-off-by: dblock <[email protected]>
- Loading branch information
Showing
5 changed files
with
235 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
- [Making Raw JSON REST Requests](#making-raw-json-rest-requests) | ||
- [GET](#get) | ||
- [PUT](#put) | ||
- [POST](#post) | ||
- [DELETE](#delete) | ||
|
||
# Making Raw JSON REST Requests | ||
|
||
The OpenSearch client implements many high-level REST DSLs that invoke OpenSearch APIs. However you may find yourself in a situation that requires you to invoke an API that is not supported by the client. Use `client.transport.perform_request` to do so. See [samples/json](../samples/json) for a complete working sample. | ||
|
||
## GET | ||
|
||
The following example returns the server version information via `GET /`. | ||
|
||
```python | ||
info = client.transport.perform_request('GET', '/') | ||
print(f"Welcome to {info['version']['distribution']} {info['version']['number']}!") | ||
``` | ||
|
||
Note that the client will parse the response as JSON when appropriate. | ||
|
||
## PUT | ||
|
||
The following example creates an index. | ||
|
||
```python | ||
index_body = { | ||
'settings': { | ||
'index': { | ||
'number_of_shards': 4 | ||
} | ||
} | ||
} | ||
|
||
client.transport.perform_request("PUT", "/movies", body=index_body) | ||
``` | ||
|
||
Note that the client will raise errors automatically. For example, if the index already exists, an `opensearchpy.exceptions.RequestError: RequestError(400, 'resource_already_exists_exception',` will be thrown. | ||
|
||
## POST | ||
|
||
The following example searches for a document. | ||
|
||
```python | ||
q = 'miller' | ||
|
||
query = { | ||
'size': 5, | ||
'query': { | ||
'multi_match': { | ||
'query': q, | ||
'fields': ['title^2', 'director'] | ||
} | ||
} | ||
} | ||
|
||
client.transport.perform_request("POST", "/movies/_search", body = query) | ||
``` | ||
|
||
## DELETE | ||
|
||
The following example deletes an index. | ||
|
||
```python | ||
client.transport.perform_request("DELETE", "/movies") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
#!/usr/bin/env python | ||
|
||
# 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. | ||
|
||
import asyncio | ||
|
||
from opensearchpy import AsyncOpenSearch | ||
|
||
async def main(): | ||
# connect to OpenSearch | ||
host = 'localhost' | ||
port = 9200 | ||
auth = ('admin', 'admin') # For testing only. Don't store credentials in code. | ||
|
||
client = AsyncOpenSearch( | ||
hosts = [{'host': host, 'port': port}], | ||
http_auth = auth, | ||
use_ssl = True, | ||
verify_certs = False, | ||
ssl_show_warn = False | ||
) | ||
|
||
try: | ||
info = await client.transport.perform_request('GET', '/') | ||
print(f"Welcome to {info['version']['distribution']} {info['version']['number']}!") | ||
|
||
# create an index | ||
|
||
index_name = 'movies' | ||
|
||
index_body = { | ||
'settings': { | ||
'index': { | ||
'number_of_shards': 4 | ||
} | ||
} | ||
} | ||
|
||
print(await client.transport.perform_request("PUT", f"/{index_name}", body=index_body)) | ||
|
||
# add a document to the index | ||
|
||
document = { | ||
'title': 'Moneyball', | ||
'director': 'Bennett Miller', | ||
'year': '2011' | ||
} | ||
|
||
id = '1' | ||
|
||
print(await client.transport.perform_request("PUT", f"/{index_name}/_doc/{id}?refresh=true", body = document)) | ||
|
||
# search for a document | ||
|
||
q = 'miller' | ||
|
||
query = { | ||
'size': 5, | ||
'query': { | ||
'multi_match': { | ||
'query': q, | ||
'fields': ['title^2', 'director'] | ||
} | ||
} | ||
} | ||
|
||
print(await client.transport.perform_request("POST", f"/{index_name}/_search", body = query)) | ||
|
||
# delete the document | ||
|
||
print(await client.transport.perform_request("DELETE", f"/{index_name}/_doc/{id}")) | ||
|
||
# delete the index | ||
|
||
print(await client.transport.perform_request("DELETE", f"/{index_name}")) | ||
|
||
|
||
finally: | ||
await client.close() | ||
|
||
if __name__ == "__main__": | ||
loop = asyncio.new_event_loop() | ||
asyncio.set_event_loop(loop) | ||
loop.run_until_complete(main()) | ||
loop.close() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
#!/usr/bin/env python | ||
|
||
# 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. | ||
|
||
from opensearchpy import OpenSearch | ||
|
||
# connect to OpenSearch | ||
|
||
host = 'localhost' | ||
port = 9200 | ||
auth = ('admin', 'admin') # For testing only. Don't store credentials in code. | ||
|
||
client = OpenSearch( | ||
hosts = [{'host': host, 'port': port}], | ||
http_auth = auth, | ||
use_ssl = True, | ||
verify_certs = False, | ||
ssl_show_warn = False | ||
) | ||
|
||
info = client.transport.perform_request('GET', '/') | ||
print(f"Welcome to {info['version']['distribution']} {info['version']['number']}!") | ||
|
||
# create an index | ||
|
||
index_name = 'movies' | ||
|
||
index_body = { | ||
'settings': { | ||
'index': { | ||
'number_of_shards': 4 | ||
} | ||
} | ||
} | ||
|
||
print(client.transport.perform_request("PUT", f"/{index_name}", body=index_body)) | ||
|
||
# add a document to the index | ||
|
||
document = { | ||
'title': 'Moneyball', | ||
'director': 'Bennett Miller', | ||
'year': '2011' | ||
} | ||
|
||
id = '1' | ||
|
||
print(client.transport.perform_request("PUT", f"/{index_name}/_doc/{id}?refresh=true", body = document)) | ||
|
||
# search for a document | ||
|
||
q = 'miller' | ||
|
||
query = { | ||
'size': 5, | ||
'query': { | ||
'multi_match': { | ||
'query': q, | ||
'fields': ['title^2', 'director'] | ||
} | ||
} | ||
} | ||
|
||
print(client.transport.perform_request("POST", f"/{index_name}/_search", body = query)) | ||
|
||
# delete the document | ||
|
||
print(client.transport.perform_request("DELETE", f"/{index_name}/_doc/{id}")) | ||
|
||
# delete the index | ||
|
||
print(client.transport.perform_request("DELETE", f"/{index_name}")) |