Merge pull request #6926 from influxdata/dom/doc-persist-endpoint

docs(proto): ingester persist API strangeness

generated_types/build.rs

@@ -59,6 +59,7 @@ fn generate_grpc_types(root: &Path) -> Result<()> {
         ingester_path.join("write_info.proto"),
         ingester_path.join("write.proto"),
         ingester_path.join("replication.proto"),
+        ingester_path.join("persist.proto"),
         namespace_path.join("service.proto"),
         object_store_path.join("service.proto"),
         predicate_path.join("predicate.proto"),

generated_types/protos/influxdata/iox/ingester/v1/persist.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+package influxdata.iox.ingester.v1;
+option go_package = "github.com/influxdata/iox/ingester/v1";
+
+service PersistService {
+  // The Persist RPC call requests an immediate persistence of all buffed data
+  // for a given namespace, blocking until the data is persisted.
+  //
+  // This endpoint persists the data not currently being persisted in the buffer
+  // for the namespace at the time of the call (if any) and then returns once
+  // the persist job is complete - it does not account for outstanding persist
+  // jobs for the same namespace (which may complete out of order).
+  //
+  // Currently this API endpoint is for internal / experimental use and is
+  // subject to change / removal. Multiple and/or concurrent calls to this
+  // method, invoking it whilst there are outstanding persist operations, or
+  // concurrently calling it with writes you expect to be persisted MAY result
+  // in strange (non-deterministic) behaviour.
+  rpc Persist(PersistRequest) returns (PersistResponse);
+}
+
+message PersistRequest {
+  // The namespace to persist
+  string namespace = 1;
+}
+
+message PersistResponse {}

generated_types/protos/influxdata/iox/ingester/v1/write.proto

@@ -14,13 +14,3 @@ message WriteRequest {
 
 message WriteResponse {}
 
-service PersistService {
-  rpc Persist(PersistRequest) returns (PersistResponse);
-}
-
-message PersistRequest {
-  // The namespace to persist
-  string namespace = 1;
-}
-
-message PersistResponse {}