{"id":20528218,"url":"https://github.com/manticoresoftware/manticoresearch-java","last_synced_at":"2025-04-14T04:51:08.947Z","repository":{"id":46681034,"uuid":"288459912","full_name":"manticoresoftware/manticoresearch-java","owner":"manticoresoftware","description":"Official Java client for Manticore Search","archived":false,"fork":false,"pushed_at":"2024-10-28T14:44:26.000Z","size":1233,"stargazers_count":40,"open_issues_count":4,"forks_count":5,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-28T16:58:52.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manticoresoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-18T13:12:36.000Z","updated_at":"2024-10-28T14:44:30.000Z","dependencies_parsed_at":"2023-12-26T16:30:54.151Z","dependency_job_id":"0e0edb50-ada1-4a86-afac-df3180b8eb5c","html_url":"https://github.com/manticoresoftware/manticoresearch-java","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manticoresoftware%2Fmanticoresearch-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manticoresoftware","download_url":"https://codeload.github.com/manticoresoftware/manticoresearch-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224857460,"owners_count":17381353,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T23:23:59.687Z","updated_at":"2025-04-14T04:51:08.940Z","avatar_url":"https://github.com/manticoresoftware.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Manticore Java client\n\n❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-java/tree/8.0.0\n\nManticore Search Client\n\n- API version: 8.0.0\n\n- Build date: 2025-04-01T10:06:34.794647478Z[Etc/UTC]\n\n## Requirements\n\nBuilding the API client library requires:\n\n1. Java 1.8+\n2. Maven/Gradle\n\n\n## Compatibility Table\n\n| **manticoresearch-java**       | **Manticore Search**                |  **Compatibility**       |\n| ------------------------------ | ----------------------------------- |  ------------------------|\n| `dev`                          | `dev` (latest development version)  |  ✅ Fully Compatible     |\n| 8.0.0 or newer                 | 9.2.14 or newer                     |  ✅ Fully Compatible     |\n| 6.0.0 to 8.0.0                 | 9.2.14 or newer                     |  ⚠️ Partially Compatible |\n| 6.0.0 or newer                 | 7.0.0 to 9.2.14                     |  ✅ Fully Compatible     |\n| 6.0.0 or newer                 | 2.5.1 to 7.0.0                      |  ⚠️ Partially Compatible |\n| 5.0.0 to 6.0.0                 | 6.3.6 to 7.0.0                      |  ✅ Fully Compatible     |\n| 5.0.0 to 6.0.0                 | 2.5.1 to 6.3.6                      |  ⚠️ Partially Compatible |\n| 3.3.1 to 5.0.0                 | 6.2.0 to 6.3.6                      |  ✅ Fully Compatible     |\n| 3.3.1 to 5.0.0                 | 2.5.1 to 6.2.0                      |  ⚠️ Partially Compatible |\n| 2.0.2 to 3.3.1                 | 2.5.1 to 6.2.0                      |  ✅ Fully Compatible     |\n\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn clean install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn clean deploy\n```\n\nRefer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.manticoresearch\u003c/groupId\u003e\n  \u003cartifactId\u003emanticoresearch\u003c/artifactId\u003e\n  \u003cversion\u003e8.0.0\u003c/version\u003e\n  \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\n  repositories {\n    mavenCentral()     // Needed if the 'manticoresearch' jar has been published to maven central.\n    mavenLocal()       // Needed if the 'manticoresearch' jar has been published to the local maven repo.\n  }\n\n  dependencies {\n     implementation \"com.manticoresearch:manticoresearch:8.0.0\"\n  }\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n```shell\nmvn clean package\n```\n\nThen manually install the following JARs:\n\n- `target/manticoresearch-8.0.0.jar`\n- `target/lib/*.jar`\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\nimport com.manticoresearch.client.*;\nimport com.manticoresearch.client.auth.*;\nimport com.manticoresearch.client.model.*;\nimport com.manticoresearch.client.api.*;\n\npublic class ApiExample {\n\n    public static void main(String[] args) {\n        ApiClient defaultClient = Configuration.getDefaultApiClient();\n        defaultClient.setBasePath(\"http://127.0.0.1:9308\");\n        \n        IndexApi apiInstance = new IndexApi(defaultClient);\n        String body = \"body_example\"; // String | \n\n\t\t# Perform insert and search operations        \n        SearchApi searchApi = new SearchApi(client);\n        IndexApi indexApi = new IndexApi(client);\n        try {\n        \tString tableName = \"products\";\n\n\t\t\tInsertDocumentRequest indexRequest = new InsertDocumentRequest();\n        \tHashMap\u003cString,Object\u003e doc = new HashMap\u003cString,Object\u003e();\n        \tindexRequest.index(tableName).id(1L).setDoc(doc); \n        \tindexApi.insert(indexRequest);\n        \n            Highlight highlight = new Highlight();\n\t\t\tList\u003cString\u003e highlightFields = new ArrayList\u003cString\u003e();\n\t    \thighlightFields.add(\"title\");\n\t\t\thighlight.setFields(highlightFields);\n\n\t\t\tSearchQuery query = new SearchQuery();\n\t\t\tquery.setQueryString(\"@title Bag\");\n\n\t\t\tSearchRequest searchRequest = new SearchRequest();\n\t\t\tsearchRequest.index(tableName).query(query).setHighlight(highlight);\n\t\t\t\t\t\n\t\t\tSearchResponse searchResponse = searchApi.search(searchRequest);\n\t\t\tSystem.out.println(searchResponse);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling Api function\");\n            System.err.println(\"Status code: \" + e.getCode());\n            System.err.println(\"Reason: \" + e.getResponseBody());\n            System.err.println(\"Response headers: \" + e.getResponseHeaders());\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://127.0.0.1:9308*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk table operations\n*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /delete | Delete a document in a table\n*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in a table\n*IndexApi* | [**partialReplace**](docs/IndexApi.md#partialReplace) | **POST** /{table}/_update/{id} | Partially replaces a document in a table\n*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in a table\n*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in a table\n*SearchApi* | [**autocomplete**](docs/SearchApi.md#autocomplete) | **POST** /autocomplete | Performs an autocomplete search on a table\n*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{table}/search | Perform reverse search on a percolate table\n*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on a table\n*UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests\n\n\n## Documentation for Models\n\n - [AggComposite](docs/AggComposite.md)\n - [AggCompositeSource](docs/AggCompositeSource.md)\n - [AggCompositeTerm](docs/AggCompositeTerm.md)\n - [AggTerms](docs/AggTerms.md)\n - [Aggregation](docs/Aggregation.md)\n - [AutocompleteRequest](docs/AutocompleteRequest.md)\n - [BoolFilter](docs/BoolFilter.md)\n - [BulkResponse](docs/BulkResponse.md)\n - [DeleteDocumentRequest](docs/DeleteDocumentRequest.md)\n - [DeleteResponse](docs/DeleteResponse.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [FulltextFilter](docs/FulltextFilter.md)\n - [GeoDistance](docs/GeoDistance.md)\n - [GeoDistanceLocationAnchor](docs/GeoDistanceLocationAnchor.md)\n - [Highlight](docs/Highlight.md)\n - [HighlightFieldOption](docs/HighlightFieldOption.md)\n - [HitsHits](docs/HitsHits.md)\n - [InsertDocumentRequest](docs/InsertDocumentRequest.md)\n - [Join](docs/Join.md)\n - [JoinCond](docs/JoinCond.md)\n - [JoinOn](docs/JoinOn.md)\n - [KnnQuery](docs/KnnQuery.md)\n - [Match](docs/Match.md)\n - [MatchAll](docs/MatchAll.md)\n - [PercolateRequest](docs/PercolateRequest.md)\n - [PercolateRequestQuery](docs/PercolateRequestQuery.md)\n - [QueryFilter](docs/QueryFilter.md)\n - [Range](docs/Range.md)\n - [ReplaceDocumentRequest](docs/ReplaceDocumentRequest.md)\n - [ResponseError](docs/ResponseError.md)\n - [ResponseErrorDetails](docs/ResponseErrorDetails.md)\n - [SearchQuery](docs/SearchQuery.md)\n - [SearchRequest](docs/SearchRequest.md)\n - [SearchResponse](docs/SearchResponse.md)\n - [SearchResponseHits](docs/SearchResponseHits.md)\n - [SourceRules](docs/SourceRules.md)\n - [SqlObjResponse](docs/SqlObjResponse.md)\n - [SqlResponse](docs/SqlResponse.md)\n - [SuccessResponse](docs/SuccessResponse.md)\n - [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)\n - [UpdateResponse](docs/UpdateResponse.md)\n\n\n## Documentation for Authorization\n\nAll endpoints do not require authorization.\nAuthentication schemes defined for the API:\n\n## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanticoresoftware%2Fmanticoresearch-java/lists"}