Backport Flush API (#2434)

* Add flush API for deleting all vectors (#2273) * add flush api Signed-off-by: aknishid <koco155@gmail.com> * added flush api * fix typo * fix pb.go & fix conflict Signed-off-by: aknishid <koco155@gmail.com> * add flush api * add handler Flush Signed-off-by: aknishid <koco155@gmail.com> * add vald.Client flush * fix filter gateway Signed-off-by: aknishid <koco155@gmail.com> * fix handler cnts Signed-off-by: aknishid <koco155@gmail.com> * delete unused var Signed-off-by: aknishid <koco155@gmail.com> * add author Signed-off-by: Yamada Takuya <takuya.ymd@gmail.com> * fix error Signed-off-by: aknishid <koco155@gmail.com> * fix flush.go & ngt.go Signed-off-by: aknishid <koco155@gmail.com> * add flush to example Signed-off-by: aknishid <koco155@gmail.com> * fix gateway lb Signed-off-by: aknishid <koco155@gmail.com> * update flush proto Signed-off-by: aknishid <koco155@gmail.com> * fix docs api README.md Signed-off-by: aknishid <koco155@gmail.com> * Fix flush ctx Signed-off-by: aknishid <koco155@gmail.com> * update docs & comment Signed-off-by: aknishid <koco155@gmail.com> * after make format Signed-off-by: aknishid <koco155@gmail.com> * add e2e Signed-off-by: aknishid <koco155@gmail.com> * update example & tutorial Signed-off-by: aknishid <koco155@gmail.com> * Update internal/errors/ngt.go Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com> * fix review Signed-off-by: aknishid <koco155@gmail.com> * modify status.md Signed-off-by: aknishid <koco155@gmail.com> * add error handling Signed-off-by: aknishid <koco155@gmail.com> * update proto Signed-off-by: aknishid <koco155@gmail.com> * fix doc Signed-off-by: aknishid <koco155@gmail.com> * ♻️ Fix proto Signed-off-by: vankichi <kyukawa315@gmail.com> * use atomic bool Signed-off-by: aknishid <koco155@gmail.com> * fix proto Signed-off-by: aknishid <koco155@gmail.com> * update proto Signed-off-by: aknishid <koco155@gmail.com> * fix gateway error Signed-off-by: aknishid <koco155@gmail.com> * ✅ 🚧 Avoid e2e failing due to unimplemented handler and Add unimplmented handler method for the future Signed-off-by: vankichi <kyukawa315@gmail.com> * Update apis/proto/v1/payload/payload.proto Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com> Signed-off-by: aknishid <38955080+aknishid@users.noreply.github.com> --------- Signed-off-by: aknishid <koco155@gmail.com> Signed-off-by: Yamada Takuya <takuya.ymd@gmail.com> Signed-off-by: vankichi <kyukawa315@gmail.com> Signed-off-by: aknishid <38955080+aknishid@users.noreply.github.com> Co-authored-by: takuyaymd <takuya.ymd@gmail.com> Co-authored-by: takuyyam <takuyyam@yahoo-corp.jp> Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com> Co-authored-by: Yusuke Kato <kpango@vdaas.org> * docs: add aknishid as a contributor for code, and maintenance (#2431) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * style: format code with Gofumpt and Prettier This commit fixes the style issues introduced in abc4c52 according to the output from Gofumpt and Prettier. Details: #2431 --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Yusuke Kato <kpango@vdaas.org> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Signed-off-by: aknishid <koco155@gmail.com> Signed-off-by: Yamada Takuya <takuya.ymd@gmail.com> Signed-off-by: vankichi <kyukawa315@gmail.com> Signed-off-by: aknishid <38955080+aknishid@users.noreply.github.com> Co-authored-by: aknishid <38955080+aknishid@users.noreply.github.com> Co-authored-by: takuyaymd <takuya.ymd@gmail.com> Co-authored-by: takuyyam <takuyyam@yahoo-corp.jp> Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
vdaas · Mar 4, 2024 · 3f7d53c · 3f7d53c
1 parent 79317ce
commit 3f7d53c
Show file tree

Hide file tree

Showing 46 changed files with 2,543 additions and 683 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -174,6 +174,16 @@
         "code",
         "test"
       ]
+    },
+    {
+      "login": "aknishid",
+      "name": "aknishid",
+      "avatar_url": "https://avatars.githubusercontent.com/u/38955080?v=4",
+      "profile": "https://github.com/aknishid",
+      "contributions": [
+        "code",
+        "maintenance"
+      ]
     }
   ],
   "contributorsPerLine": 7,
@@ -184,5 +194,6 @@
   "repoType": "github",
   "repoHost": "https://github.com",
   "skipCi": true,
-  "commitConvention": "angular"
+  "commitConvention": "angular",
+  "commitType": "docs"
 }
diff --git a/README.md b/README.md
@@ -264,7 +264,7 @@ make init
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
@@ -296,6 +296,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/junsei-ando"><img src="https://avatars.githubusercontent.com/u/1892077?v=4?s=100" width="100px;" alt="junsei-ando"/><br /><sub><b>junsei-ando</b></sub></a><br /><a href="https://github.com/vdaas/vald/commits?author=junsei-ando" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ykadowak"><img src="https://avatars.githubusercontent.com/u/60080334?v=4?s=100" width="100px;" alt="Yusuke Kadowaki"/><br /><sub><b>Yusuke Kadowaki</b></sub></a><br /><a href="https://github.com/vdaas/vald/commits?author=ykadowak" title="Code">💻</a> <a href="https://github.com/vdaas/vald/commits?author=ykadowak" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/aknishid"><img src="https://avatars.githubusercontent.com/u/38955080?v=4?s=100" width="100px;" alt="aknishid"/><br /><sub><b>aknishid</b></sub></a><br /><a href="https://github.com/vdaas/vald/commits?author=aknishid" title="Code">💻</a> <a href="#maintenance-aknishid" title="Maintenance">🚧</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/apis/docs/v1/docs.md b/apis/docs/v1/docs.md
@@ -14,6 +14,8 @@
   - [Filter](#payload-v1-Filter)
   - [Filter.Config](#payload-v1-Filter-Config)
   - [Filter.Target](#payload-v1-Filter-Target)
+  - [Flush](#payload-v1-Flush)
+  - [Flush.Request](#payload-v1-Flush-Request)
   - [Info](#payload-v1-Info)
   - [Info.Annotations](#payload-v1-Info-Annotations)
   - [Info.Annotations.AnnotationsEntry](#payload-v1-Info-Annotations-AnnotationsEntry)
@@ -127,6 +129,8 @@
   - [RetryInfo](#rpc-v1-RetryInfo)
 - [v1/vald/filter.proto](#v1_vald_filter-proto)
   - [Filter](#vald-v1-Filter)
+- [v1/vald/flush.proto](#v1_vald_flush-proto)
+  - [Flush](#vald-v1-Flush)
 - [v1/vald/insert.proto](#v1_vald_insert-proto)
   - [Insert](#vald-v1-Insert)
 - [v1/vald/object.proto](#v1_vald_object-proto)
@@ -214,6 +218,14 @@ Represent the target filter server.
 | host  | [string](#string) |       | The target hostname. |
 | port  | [uint32](#uint32) |       | The target port.     |
 
+<a name="payload-v1-Flush"></a>
+
+### Flush
+
+<a name="payload-v1-Flush-Request"></a>
+
+### Flush.Request
+
 <a name="payload-v1-Info"></a>
 
 ### Info
@@ -1449,6 +1461,22 @@ Filter service provides ways to connect to Vald through filter.
 | StreamUpsertObject | [.payload.v1.Upsert.ObjectRequest](#payload-v1-Upsert-ObjectRequest) stream    | [.payload.v1.Object.StreamLocation](#payload-v1-Object-StreamLocation) stream | A method to upsert object by bidirectional streaming.                    |
 | MultiUpsertObject  | [.payload.v1.Upsert.MultiObjectRequest](#payload-v1-Upsert-MultiObjectRequest) | [.payload.v1.Object.Locations](#payload-v1-Object-Locations)                  | A method to upsert multiple objects.                                     |
 
+<a name="v1_vald_flush-proto"></a>
+
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/vald/flush.proto
+
+<a name="vald-v1-Flush"></a>
+
+### Flush
+
+Flush service provides ways to flush all indexed vectors.
+
+| Method Name | Request Type                                           | Response Type                                                | Description                           |
+| ----------- | ------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------- |
+| Flush       | [.payload.v1.Flush.Request](#payload-v1-Flush-Request) | [.payload.v1.Info.Index.Count](#payload-v1-Info-Index-Count) | A method to flush all indexed vector. |
+
 <a name="v1_vald_insert-proto"></a>
 
 <p align="right"><a href="#top">Top</a></p>