Skip to content

Commit b2c0780

Browse files
committed
Regenerated client
1 parent 0293168 commit b2c0780

File tree

113 files changed

+2053
-796
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+2053
-796
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ docs/_build/
6262
# PyBuilder
6363
target/
6464

65-
#Ipython Notebook
65+
# Ipython Notebook
6666
.ipynb_checkpoints
6767

68-
.project
68+
.project

.gitlab-ci.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ stages:
1414
- pip install -r test-requirements.txt
1515
- pytest --cov=manticoresearch
1616

17-
pytest-3.7:
18-
extends: .pytest
19-
image: python:3.7-alpine
20-
pytest-3.8:
21-
extends: .pytest
22-
image: python:3.8-alpine
2317
pytest-3.9:
2418
extends: .pytest
2519
image: python:3.9-alpine
@@ -29,3 +23,9 @@ pytest-3.10:
2923
pytest-3.11:
3024
extends: .pytest
3125
image: python:3.11-alpine
26+
pytest-3.12:
27+
extends: .pytest
28+
image: python:3.12-alpine
29+
pytest-3.13:
30+
extends: .pytest
31+
image: python:3.13-alpine

.openapi-generator/FILES

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ README.md
77
docs/AggComposite.md
88
docs/AggCompositeSource.md
99
docs/AggCompositeTerm.md
10+
docs/AggDateHistogram.md
11+
docs/AggHistogram.md
1012
docs/AggTerms.md
1113
docs/Aggregation.md
1214
docs/AutocompleteRequest.md
@@ -20,12 +22,14 @@ docs/GeoDistance.md
2022
docs/GeoDistanceLocationAnchor.md
2123
docs/Highlight.md
2224
docs/HighlightFieldOption.md
25+
docs/HighlightFields.md
2326
docs/HitsHits.md
2427
docs/IndexApi.md
2528
docs/InsertDocumentRequest.md
2629
docs/Join.md
2730
docs/JoinCond.md
2831
docs/JoinOn.md
32+
docs/Knn.md
2933
docs/KnnQuery.md
3034
docs/Match.md
3135
docs/MatchAll.md
@@ -62,6 +66,8 @@ manticoresearch/models/__init__.py
6266
manticoresearch/models/agg_composite.py
6367
manticoresearch/models/agg_composite_source.py
6468
manticoresearch/models/agg_composite_term.py
69+
manticoresearch/models/agg_date_histogram.py
70+
manticoresearch/models/agg_histogram.py
6571
manticoresearch/models/agg_terms.py
6672
manticoresearch/models/aggregation.py
6773
manticoresearch/models/autocomplete_request.py
@@ -75,11 +81,13 @@ manticoresearch/models/geo_distance.py
7581
manticoresearch/models/geo_distance_location_anchor.py
7682
manticoresearch/models/highlight.py
7783
manticoresearch/models/highlight_field_option.py
84+
manticoresearch/models/highlight_fields.py
7885
manticoresearch/models/hits_hits.py
7986
manticoresearch/models/insert_document_request.py
8087
manticoresearch/models/join.py
8188
manticoresearch/models/join_cond.py
8289
manticoresearch/models/join_on.py
90+
manticoresearch/models/knn.py
8391
manticoresearch/models/knn_query.py
8492
manticoresearch/models/match.py
8593
manticoresearch/models/match_all.py
@@ -111,6 +119,8 @@ test/__init__.py
111119
test/test_agg_composite.py
112120
test/test_agg_composite_source.py
113121
test/test_agg_composite_term.py
122+
test/test_agg_date_histogram.py
123+
test/test_agg_histogram.py
114124
test/test_agg_terms.py
115125
test/test_aggregation.py
116126
test/test_autocomplete_request.py
@@ -124,12 +134,14 @@ test/test_geo_distance.py
124134
test/test_geo_distance_location_anchor.py
125135
test/test_highlight.py
126136
test/test_highlight_field_option.py
137+
test/test_highlight_fields.py
127138
test/test_hits_hits.py
128139
test/test_index_api.py
129140
test/test_insert_document_request.py
130141
test/test_join.py
131142
test/test_join_cond.py
132143
test/test_join_on.py
144+
test/test_knn.py
133145
test/test_knn_query.py
134146
test/test_match.py
135147
test/test_match_all.py

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.3.0-SNAPSHOT
1+
7.17.0-SNAPSHOT

.travis.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# ref: https://docs.travis-ci.com/user/languages/python
22
language: python
33
python:
4-
- "3.7"
5-
- "3.8"
64
- "3.9"
75
- "3.10"
86
- "3.11"
7+
- "3.12"
8+
- "3.13"
99
# uncomment the following if needed
10-
#- "3.11-dev" # 3.11 development branch
10+
#- "3.13-dev" # 3.13 development branch
1111
#- "nightly" # nightly build
1212
# command to install dependencies
1313
install:

README.md

Lines changed: 127 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,61 @@
11
# Manticore Python client
22

3-
WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python-asyncio/tree/1.0.0
3+
Сlient for Manticore Search.
44

5-
## Requirements.
6-
7-
Minimum Manticore Search version is >= 6.2.0 with HTTP protocol enabled.
85

9-
| **manticoresearch-python-asyncio* | **Manticore Search** | **Python** | **Compatibility** |
10-
| -----------------------------------| ----------------------------------- | -------------- | ------------------------|
11-
| `manticoresearch-devel` | `dev` (latest development version) | 3.4 or newer | ✅ Fully Compatible |
12-
| 1.0.0 or newer | 9.2.14 or newer | 3.4 or newer | ✅ Fully Compatible |
13-
| 1.0.0 or newer | 6.2.0 to 9.2.14 | 3.4 or newer | ⚠️ Partially Compatible |
14-
| 1.0.0 or newer | 2.5.1 to 6.2.0 | 3.4 or newer | ❗ Incompatible |
6+
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python-asyncio/tree/1.0.0
157

16-
## Usage
17-
To run the server, please execute the following from the root directory:
8+
## Requirements.
189

10+
Minimum Manticore Search version is >= 2.5.1 with HTTP protocol enabled.
11+
12+
| **manticoresearch-python* | **Manticore Search** | **Python** | **Compatibility** |
13+
| --------------------------- | ----------------------------------- | -------------- | ------------------------|
14+
| `manticoresearch-devel` | `dev` (latest development version) | 3.4 or newer | ✅ Fully Compatible |
15+
| 8.0.0 or newer | 9.2.14 or newer | 3.4 or newer | ✅ Fully Compatible |
16+
| 6.0.0 to 8.0.0 | 9.2.14 or newer | 3.4 or newer | ⚠️ Partially Compatible |
17+
| 6.0.0 to 8.0.0 | 7.0.0 to 9.2.14 | 3.4 or newer | ✅ Fully Compatible |
18+
| 6.0.0 or newer | 6.2.1 to 7.0.0 | 3.4 or newer | ⚠️ Partially Compatible |
19+
| 3.3.1 to 6.0.0 | 7.0.0 or newer | 3.4 or newer | ⚠️ Partially Compatible |
20+
| 3.3.1 to 6.0.0 | 6.2.1 to 7.0.0 | 3.4 or newer | ✅ Fully Compatible |
21+
| 2.0.0 to 3.3.1 | 6.2.0 or newer | 3.4 or newer | ⚠️ Partially Compatible |
22+
| 2.0.0 to 3.3.1 | 4.2.1 to 6.2.0 | 3.4 or newer | ✅ Fully Compatible |
23+
| 1.0.6 to 2.0.0 | 4.0.2 to 4.2.1 | 3.4 or newer | ✅ Fully Compatible |
24+
| 1.0.5 to 1.0.6 | 4.0.2 to 4.2.1 | 2.7 or newer | ⚠️ Partially Compatible |
25+
| 1.0.5 to 1.0.6 | 2.5.1 to 4.0.2 | 2.7 or newer | ✅ Fully Compatible |
26+
27+
## Installation & Usage
28+
### pip install
29+
30+
If the python package is hosted on a repository, you can install directly using:
31+
32+
```sh
33+
pip install git+https://github.com/manticoresoftware/manticoresearch-python-asyncio.git
1934
```
20-
pip3 install -r requirements.txt
21-
python3 -m manticoresearch
22-
```
23-
24-
and open your browser to here:
35+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/manticoresoftware/manticoresearch-python-asyncio.git`)
2536

26-
```
27-
http://localhost:/ui/
37+
Then import the package:
38+
```python
39+
import manticoresearch
2840
```
2941

30-
Your OpenAPI definition lives here:
42+
### Setuptools
3143

32-
```
33-
http://localhost:/openapi.json
34-
```
44+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
3545

36-
To launch the integration tests, use pytest:
37-
```
38-
sudo pip install -r test-requirements.txt
39-
pytest
46+
```sh
47+
python setup.py install --user
4048
```
49+
(or `sudo python setup.py install` to install the package for all users)
4150

42-
## Prevent file overriding
43-
44-
After first generation, add edited files to _.openapi-generator-ignore_ to prevent generator from overwriting them. Typically:
45-
```
46-
server/controllers/*
47-
test/*
48-
*.txt
51+
Then import the package:
52+
```python
53+
import manticoresearch
4954
```
5055

5156
## Getting Started
5257

53-
Please follow the installation procedure and then run the following example:
58+
Please follow the [installation procedure](#installation--usage) and then run the following:
5459

5560
```python
5661
import manticoresearch
@@ -64,8 +69,9 @@ configuration = manticoresearch.Configuration(
6469
)
6570

6671

72+
6773
# Enter a context with an instance of the API client
68-
async with manticoresearch.ApiClient(configuration) as api_client:
74+
with manticoresearch.ApiClient(configuration) as api_client:
6975
# Create instances of API classes
7076
indexApi = manticoresearch.IndexApi(api_client)
7177
searchApi = manticoresearch.SearchApi(api_client)
@@ -75,31 +81,109 @@ async with manticoresearch.ApiClient(configuration) as api_client:
7581
# Perform insert and search operations
7682
newDoc = {"title" : "Crossbody Bag with Tassel", "price": 19.85}
7783
insert_request = InsertDocumentRequest(index="products", doc=newDoc)
78-
await indexApi.insert(insert_request)
84+
indexApi.insert(insert_request)
7985

8086
# Check out the structure of the autocreated 'products' table
81-
sql_response = await utilsApi.sql('DESC products');
87+
sql_response = utilsApi.sql('DESC products');
8288
print("The response of UtilsApi->sql:\n")
8389
pprint(sql_response)
8490

8591
newDoc = {"title" : "Pet Hair Remover Glove", "price": 7.99}
8692
insert_request = InsertDocumentRequest(index="products", doc=newDoc)
87-
await indexApi.insert(insert_request)
93+
indexApi.insert(insert_request)
8894

8995
query_highlight = Highlight()
9096
query_highlight.fields = {"title":{}}
9197
search_query = SearchQuery(query_string="@title bag")
9298
search_request = SearchRequest(index="products", query=search_query, highlight=query_highlight)
93-
search_response = await searchApi.search(search_request)
99+
search_response = searchApi.search(search_request)
94100
print("The response of SearchApi->search:\n")
95101
pprint(search_response)
96102

97103
# Alternatively, you can pass all request arguments as a complex JSON object
98-
await indexApi.insert({"index": "products", "doc" : {"title" : "Crossbody Bag with Tassel", "price" : 19.85}})
99-
await indexApi.insert({"index": "products", "doc" : {"title" : "Pet Hair Remover Glove", "price" : 7.99}})
100-
search_response = await searchApi.search({"index": "products", "query": {"query_string": "@title bag"}, "highlight":{"fields":{"title":{}}}})
104+
indexApi.insert({"index": "products", "doc" : {"title" : "Crossbody Bag with Tassel", "price" : 19.85}})
105+
indexApi.insert({"index": "products", "doc" : {"title" : "Pet Hair Remover Glove", "price" : 7.99}})
106+
search_response = searchApi.search({"index": "products", "query": {"query_string": "@title bag"}, "highlight":{"fields":{"title":{}}}})
101107
print("The response of SearchApi->search:\n")
102108
pprint(search_response)
103109
except ApiException as e:
104110
print("Exception when calling Api method: %s\n" % e)
105111
```
112+
113+
## Documentation for API Endpoints
114+
115+
All URIs are relative to *http://127.0.0.1:9308*
116+
117+
Class | Method | HTTP request | Description
118+
------------ | ------------- | ------------- | -------------
119+
*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk table operations
120+
*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /delete | Delete a document in a table
121+
*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in a table
122+
*IndexApi* | [**partial_replace**](docs/IndexApi.md#partial_replace) | **POST** /{table}/_update/{id} | Partially replaces a document in a table
123+
*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in a table
124+
*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in a table
125+
*SearchApi* | [**autocomplete**](docs/SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table
126+
*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table
127+
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on a table
128+
*UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests
129+
130+
131+
## Documentation For Models
132+
133+
- [AggComposite](docs/AggComposite.md)
134+
- [AggCompositeSource](docs/AggCompositeSource.md)
135+
- [AggCompositeTerm](docs/AggCompositeTerm.md)
136+
- [AggDateHistogram](docs/AggDateHistogram.md)
137+
- [AggHistogram](docs/AggHistogram.md)
138+
- [AggTerms](docs/AggTerms.md)
139+
- [Aggregation](docs/Aggregation.md)
140+
- [AutocompleteRequest](docs/AutocompleteRequest.md)
141+
- [BoolFilter](docs/BoolFilter.md)
142+
- [BulkResponse](docs/BulkResponse.md)
143+
- [DeleteDocumentRequest](docs/DeleteDocumentRequest.md)
144+
- [DeleteResponse](docs/DeleteResponse.md)
145+
- [ErrorResponse](docs/ErrorResponse.md)
146+
- [FulltextFilter](docs/FulltextFilter.md)
147+
- [GeoDistance](docs/GeoDistance.md)
148+
- [GeoDistanceLocationAnchor](docs/GeoDistanceLocationAnchor.md)
149+
- [Highlight](docs/Highlight.md)
150+
- [HighlightFieldOption](docs/HighlightFieldOption.md)
151+
- [HighlightFields](docs/HighlightFields.md)
152+
- [HitsHits](docs/HitsHits.md)
153+
- [InsertDocumentRequest](docs/InsertDocumentRequest.md)
154+
- [Join](docs/Join.md)
155+
- [JoinCond](docs/JoinCond.md)
156+
- [JoinOn](docs/JoinOn.md)
157+
- [Knn](docs/Knn.md)
158+
- [KnnQuery](docs/KnnQuery.md)
159+
- [Match](docs/Match.md)
160+
- [MatchAll](docs/MatchAll.md)
161+
- [PercolateRequest](docs/PercolateRequest.md)
162+
- [PercolateRequestQuery](docs/PercolateRequestQuery.md)
163+
- [QueryFilter](docs/QueryFilter.md)
164+
- [Range](docs/Range.md)
165+
- [ReplaceDocumentRequest](docs/ReplaceDocumentRequest.md)
166+
- [ResponseError](docs/ResponseError.md)
167+
- [ResponseErrorDetails](docs/ResponseErrorDetails.md)
168+
- [SearchQuery](docs/SearchQuery.md)
169+
- [SearchRequest](docs/SearchRequest.md)
170+
- [SearchResponse](docs/SearchResponse.md)
171+
- [SearchResponseHits](docs/SearchResponseHits.md)
172+
- [SourceRules](docs/SourceRules.md)
173+
- [SqlObjResponse](docs/SqlObjResponse.md)
174+
- [SqlResponse](docs/SqlResponse.md)
175+
- [SuccessResponse](docs/SuccessResponse.md)
176+
- [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)
177+
- [UpdateResponse](docs/UpdateResponse.md)
178+
179+
180+
<a id="documentation-for-authorization"></a>
181+
## Documentation For Authorization
182+
183+
Endpoints do not require authorization.
184+
185+
186+
## Author
187+
188+
info@manticoresearch.com
189+

docs/AggComposite.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
1414
```python
1515
from manticoresearch.models.agg_composite import AggComposite
1616

17+
# TODO update the JSON string below
18+
json = "{}"
1719
# create an instance of AggComposite from a JSON string
1820
agg_composite_instance = AggComposite.from_json(json)
1921
# print the JSON string representation of the object

docs/AggCompositeSource.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
1313
```python
1414
from manticoresearch.models.agg_composite_source import AggCompositeSource
1515

16+
# TODO update the JSON string below
17+
json = "{}"
1618
# create an instance of AggCompositeSource from a JSON string
1719
agg_composite_source_instance = AggCompositeSource.from_json(json)
1820
# print the JSON string representation of the object

docs/AggCompositeTerm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ Object representing a term to be used in composite aggregation.
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**field** | **str** | Name of field to operate with |
9+
**var_field** | **str** | Name of field to operate with |
1010

1111
## Example
1212

1313
```python
1414
from manticoresearch.models.agg_composite_term import AggCompositeTerm
1515

16+
# TODO update the JSON string below
17+
json = "{}"
1618
# create an instance of AggCompositeTerm from a JSON string
1719
agg_composite_term_instance = AggCompositeTerm.from_json(json)
1820
# print the JSON string representation of the object

0 commit comments

Comments
 (0)