{"id":13393830,"url":"https://github.com/go-ego/riot","last_synced_at":"2026-01-14T22:54:18.740Z","repository":{"id":38325991,"uuid":"95011980","full_name":"go-ego/riot","owner":"go-ego","description":"Go Open Source, Distributed, Simple and efficient Search Engine; Warning: This is V1 and beta version, because of big memory consume, and the V2 will be rewrite all code.","archived":true,"fork":false,"pushed_at":"2020-10-13T13:31:05.000Z","size":12969,"stargazers_count":6091,"open_issues_count":50,"forks_count":476,"subscribers_count":193,"default_branch":"master","last_synced_at":"2025-09-29T00:32:06.531Z","etag":null,"topics":["go","golang","gwk","index","riot","search","search-engine"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/go-ego.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-21T14:17:59.000Z","updated_at":"2025-09-24T18:00:48.000Z","dependencies_parsed_at":"2022-07-11T02:00:38.310Z","dependency_job_id":null,"html_url":"https://github.com/go-ego/riot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/go-ego/riot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-ego%2Friot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-ego%2Friot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-ego%2Friot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-ego%2Friot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/go-ego","download_url":"https://codeload.github.com/go-ego/riot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-ego%2Friot/sbom","scorecard":{"id":431707,"data":{"date":"2025-08-11","repo":{"name":"github.com/go-ego/riot","commit":"f4c30acb3704545c3c28f957fc03cf7bf35598a7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 1/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/go.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/go-ego/riot/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/go-ego/riot/go.yml/master?enable=pin","Warn: containerImage not pinned by hash: examples/codelab/docker/Dockerfile:1: pin your Docker image by updating busybox to busybox@sha256:de02f124ed06177f8dfc9389aae2d7eaa69c687a68ea5d5398430c7583865691","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   1 out of   1 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"21 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2020-0017 / GHSA-w73w-5m7g-f7qc","Warn: Project is vulnerable to: GO-2021-0053 / GHSA-c3h9-896r-86jm","Warn: Project is vulnerable to: GO-2022-0322 / GHSA-cg3q-j54f-5p7p","Warn: Project is vulnerable to: GO-2022-0236 / GHSA-h86h-8ppg-mxmh","Warn: Project is vulnerable to: GO-2021-0238 / GHSA-83g2-8m93-v3w7","Warn: Project is vulnerable to: GO-2022-0288","Warn: Project is vulnerable to: GO-2022-0969 / GHSA-69cg-p879-7622","Warn: Project is vulnerable to: GO-2022-1144 / GHSA-xrjj-mj9h-534m","Warn: Project is vulnerable to: GO-2023-1571 / GHSA-vvpx-j8f3-3w6h","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GO-2023-2153 / GHSA-m425-mq94-257g / GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2022-0493 / GHSA-p782-xgp4-8hr8","Warn: Project is vulnerable to: GO-2020-0015 / GHSA-5rcv-m4m3-hfh7","Warn: Project is vulnerable to: GO-2021-0113 / GHSA-ppp9-7jff-5vj2","Warn: Project is vulnerable to: GO-2022-1059 / GHSA-69ch-w2m2-3vjp","Warn: Project is vulnerable to: GO-2024-2611 / GHSA-8r3f-844c-mc37"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T03:30:31.296Z","repository_id":38325991,"created_at":"2025-08-19T03:30:31.297Z","updated_at":"2025-08-19T03:30:31.297Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28437159,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T22:37:52.437Z","status":"ssl_error","status_checked_at":"2026-01-14T22:37:31.496Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["go","golang","gwk","index","riot","search","search-engine"],"created_at":"2024-07-30T17:01:01.001Z","updated_at":"2026-01-14T22:54:18.711Z","avatar_url":"https://github.com/go-ego.png","language":"Go","funding_links":[],"categories":["Popular","Go","开源类库","Misc","Database Drivers","Search Engines","Open source library","Programming Languages","\u003cspan id=\"数据库驱动-database-drivers\"\u003e数据库驱动 Database Drivers\u003c/span\u003e","search-engine","数据库驱动`连接和操作数据库工具`","数据库驱动","NoSQL Databases"],"sub_categories":["搜索推荐","Advanced Console UIs","Vectors","Search Recommendations","Go","\u003cspan id=\"高级控制台用户界面-advanced-console-uis\"\u003e高级控制台用户界面 Advanced Console UIs\u003c/span\u003e","SQL 查询语句构建库"],"readme":"# Riot search\n\n\u003cimg align=\"right\" src=\"logo/512px.svg\" width=\"15%\"/\u003e\n\n\u003c!--\u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/go-ego/ego/master/logo.jpg\"\u003e--\u003e\n\u003c!--\u003ca href=\"https://circleci.com/gh/go-ego/ego/tree/dev\"\u003e\u003cimg src=\"https://img.shields.io/circleci/project/go-ego/ego/dev.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e--\u003e\n[![CircleCI Status](https://circleci.com/gh/go-ego/riot.svg?style=shield)](https://circleci.com/gh/go-ego/riot)\n![Appveyor](https://ci.appveyor.com/api/projects/status/github/go-ego/riot?branch=master\u0026svg=true)\n[![codecov](https://codecov.io/gh/go-ego/riot/branch/master/graph/badge.svg)](https://codecov.io/gh/go-ego/riot)\n[![Build Status](https://travis-ci.org/go-ego/riot.svg)](https://travis-ci.org/go-ego/riot)\n[![Go Report Card](https://goreportcard.com/badge/github.com/go-ego/riot)](https://goreportcard.com/report/github.com/go-ego/riot)\n[![GoDoc](https://godoc.org/github.com/go-ego/riot?status.svg)](https://godoc.org/github.com/go-ego/riot)\n[![GitHub release](https://img.shields.io/github/release/go-ego/riot.svg)](https://github.com/go-ego/riot/releases/latest)\n[![Join the chat at https://gitter.im/go-ego/ego](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-ego/ego?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\u003c!-- [![Release](https://github-release-version.herokuapp.com/github/go-ego/riot/release.svg?style=flat)](https://github.com/go-ego/riot/releases/latest) --\u003e\n\u003c!--\u003ca href=\"https://github.com/go-ego/ego/releases\"\u003e\u003cimg src=\"https://img.shields.io/badge/%20version%20-%206.0.0%20-blue.svg?style=flat-square\" alt=\"Releases\"\u003e\u003c/a\u003e--\u003e\n\n\u003c!-- ![ego Logo](logo/512px.svg) --\u003e\nGo Open Source, Distributed, Simple and efficient full text search engine.\n\n[简体中文](https://github.com/go-ego/riot/blob/master/README_zh.md)\n\n# Features\n\n* [Efficient indexing and search](/docs/en/benchmarking.md) (1M blog 500M data 28 seconds index finished, 1.65 ms search response time, 19K search QPS）\n* Support for [logical search](https://github.com/go-ego/riot/blob/master/docs/en/logic.md)\n* Support Chinese word segmentation (use [gse word segmentation package](https://github.com/go-ego/gse) concurrent word, speed 27MB / s）\n* Support the calculation of the keyword in the text [close to the distance](/docs/en/token_proximity.md)（token proximity）\n* Support calculation [BM25 correlation](/docs/en/bm25.md)\n* Support [custom scoring field and scoring rules](/docs/en/custom_scoring_criteria.md)\n* Support [add online, delete index](/docs/en/realtime_indexing.md)\n* Support heartbeat\n* Support multiple [persistent storage](/docs/en/persistent_storage.md)\n* Support [distributed index and search](https://github.com/go-ego/riot/tree/master/data)\n* Can be achieved [distributed index and search](/docs/en/distributed_indexing_and_search.md)\n\n* [Look at Word segmentation rules](https://github.com/go-ego/riot/blob/master/docs/en/segmenter.md)\n\n\u003c!-- \nRiot v0.20.0 was released in Nov 2017, check the [Changelog](https://github.com/go-ego/riot/blob/master/docs/CHANGELOG.md) for the full details. --\u003e\n\n## Requirements\nGo version \u003e= 1.8\n\n### Dependencies\n\nRiot uses go module or dep to manage dependencies. \n\n## Installation/Update\n\n```\ngo get -u github.com/go-ego/riot\n```\n\n## [Build-tools](https://github.com/go-ego/re)\n```\ngo get -u github.com/go-ego/re \n```\n### re riot\nTo create a new riot application\n\n```\n$ re riot my-riotapp\n```\n\n### re run\n\nTo run the application we just created, you can navigate to the application folder and execute:\n```\n$ cd my-riotapp \u0026\u0026 re run\n```\n\n## Usage:\n\n#### [Look at an example](/examples/simple/main.go)\n\n```go\npackage main\n\nimport (\n\t\"log\"\n\n\t\"github.com/go-ego/riot\"\n\t\"github.com/go-ego/riot/types\"\n)\n\nvar (\n\t// searcher is coroutine safe\n\tsearcher = riot.Engine{}\n)\n\nfunc main() {\n\t// Init\n\tsearcher.Init(types.EngineOpts{\n\t\t// Using:             4,\n\t\tNotUseGse: true,\n\t\t})\n\tdefer searcher.Close()\n\n\ttext := \"Google Is Experimenting With Virtual Reality Advertising\"\n\ttext1 := `Google accidentally pushed Bluetooth update for Home\n\tspeaker early`\n\ttext2 := `Google is testing another Search results layout with \n\trounded cards, new colors, and the 4 mysterious colored dots again`\n\t\n\t// Add the document to the index, docId starts at 1\n\tsearcher.Index(\"1\", types.DocData{Content: text})\n\tsearcher.Index(\"2\", types.DocData{Content: text1}, false)\n\tsearcher.IndexDoc(\"3\", types.DocData{Content: text2}, true)\n\n\t// Wait for the index to refresh\n\tsearcher.Flush()\n\t// engine.FlushIndex()\n\n\t// The search output format is found in the types.SearchResp structure\n\tlog.Print(searcher.Search(types.SearchReq{Text:\"google testing\"}))\n}\n```\n\nIt is very simple!\n\n### Use default engine:\n\n```Go\npackage main\n\nimport (\n\t\"log\"\n\n\t\"github.com/go-ego/riot\"\n\t\"github.com/go-ego/riot/types\"\n)\n\nvar (\n\tsearcher = riot.New(\"zh\")\n)\n\nfunc main() {\n\tdata := types.DocData{Content: `I wonder how, I wonder why\n\t\t, I wonder where they are`}\n\tdata1 := types.DocData{Content: \"所以, 你好, 再见\"}\n\tdata2 := types.DocData{Content: \"没有理由\"}\n\n\tsearcher.Index(\"1\", data)\n\tsearcher.Index(\"2\", data1)\n\tsearcher.Index(\"3\", data2)\n\tsearcher.Flush()\n\n\treq := types.SearchReq{Text: \"你好\"}\n\tsearch := searcher.Search(req)\n\tlog.Println(\"search...\", search)\n}\n```\n\n#### [Look at more Examples](https://github.com/go-ego/riot/tree/master/examples)\n\n#### [Look at Store example](https://github.com/go-ego/riot/blob/master/examples/store/main.go)\n#### [Look at Logic search example](https://github.com/go-ego/riot/blob/master/examples/logic/main.go)\n\n#### [Look at Pinyin search example](https://github.com/go-ego/riot/blob/master/examples/pinyin/main.go)\n\n#### [Look at different dict and language search example](https://github.com/go-ego/riot/blob/master/examples/dict/main.go)\n\n#### [Look at benchmark example](https://github.com/go-ego/riot/blob/master/examples/benchmark/benchmark.go)\n\n#### [Riot search engine templates, client and dictionaries](https://github.com/go-ego/riot/tree/master/data)\n\n## Authors\n\n* [Maintainers](https://github.com/orgs/go-ego/people)\n* [Contributors](https://github.com/go-ego/riot/graphs/contributors)\n\n## License\n\nRiot is primarily distributed under the terms of the Apache License (Version 2.0), base on [wukong](https://github.com/huichen/wukong).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgo-ego%2Friot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgo-ego%2Friot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgo-ego%2Friot/lists"}