prePR

permutive-engineering · Jan 19, 2023 · c6ffc73 · c6ffc73
1 parent f13be7e
commit c6ffc73
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -86,11 +86,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: mkdir -p testkit-munit-bigtable/target target functional-google-cloud-bigtable/target functional-gax/target .js/target .jvm/target .native/target functional-google-cloud-bigtable-pureconfig/target project/target
+        run: mkdir -p testkit-munit-bigtable/target target functional-google-cloud-bigtable/target functional-gax/target functional-google-cloud-bigtable-trace4cats/target .js/target .jvm/target .native/target functional-google-cloud-bigtable-pureconfig/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: tar cf targets.tar testkit-munit-bigtable/target target functional-google-cloud-bigtable/target functional-gax/target .js/target .jvm/target .native/target functional-google-cloud-bigtable-pureconfig/target project/target
+        run: tar cf targets.tar testkit-munit-bigtable/target target functional-google-cloud-bigtable/target functional-gax/target functional-google-cloud-bigtable-trace4cats/target .js/target .jvm/target .native/target functional-google-cloud-bigtable-pureconfig/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')

diff --git a/...la/com/permutive/google/bigtable/data/trace4cats/TracedFunctionalBigtableDataClient.scala b/...la/com/permutive/google/bigtable/data/trace4cats/TracedFunctionalBigtableDataClient.scala
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 Permutive
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.permutive.google.bigtable.data.trace4cats
 
 import cats.FlatMap
@@ -70,9 +86,7 @@ class TracedFunctionalBigtableDataClient[F[_]: Trace: FlatMap] private (
       ) >> underlying.readRow(tableId, rowKey, filter)
     )
 
-  /** @inheritdoc
-    *
-    * Note that, because of the difficultly in tracing streams, a span is only open whilst the stream is being
+  /** Note that, because of the difficultly in tracing streams, a span is only open whilst the stream is being
     * _created_. This is likely to be instantaneous, and will not track the time spent consuming each item of the
     * stream.
     */

diff --git a/...able/src/main/scala/com/permutive/google/bigtable/data/FunctionalBigtableDataClient.scala b/...able/src/main/scala/com/permutive/google/bigtable/data/FunctionalBigtableDataClient.scala
@@ -117,6 +117,11 @@ trait FunctionalBigtableDataClient[F[_]] {
     */
   def mutateRow(rowMutation: RowMutation): F[Unit]
 
+  /** Mutate multiple rows in a batch. Each individual row is mutated atomically.
+    *
+    * @see
+    *   [[com.google.cloud.bigtable.data.v2.BigtableDataClient BigtableDataClient#bulkMutateRows]]
+    */
   def bulkMutateRows(bulkMutation: BulkMutation): F[Unit]
 
   /** Create a `FunctionalBatcher` which mutates multiple rows in a batch. Each individual row is mutated atomically.