diff --git a/.github/workflows/beam_StressTests_Java_BigTableIO.yml b/.github/workflows/beam_StressTests_Java_BigTableIO.yml index 1ddb10e84439..d10d547e20a9 100644 --- a/.github/workflows/beam_StressTests_Java_BigTableIO.yml +++ b/.github/workflows/beam_StressTests_Java_BigTableIO.yml @@ -73,7 +73,7 @@ jobs: github_job: ${{ matrix.job_name }} (${{ matrix.job_phrase }}) - name: Setup environment uses: ./.github/actions/setup-environment-action - - name: run BigTable StressTest Large + - name: run Bigtable StressTest Large uses: ./.github/actions/gradle-command-self-hosted-action with: gradle-command: :it:google-cloud-platform:BigTableStressTestLarge --info -DinfluxHost="http://10.128.0.96:8086" -DinfluxDatabase="beam_test_metrics" -DinfluxMeasurement="java_stress_test_bigtable" diff --git a/.test-infra/tools/refresh_looker_metrics.py b/.test-infra/tools/refresh_looker_metrics.py index b0800905e140..58b3f4458542 100644 --- a/.test-infra/tools/refresh_looker_metrics.py +++ b/.test-infra/tools/refresh_looker_metrics.py @@ -30,8 +30,8 @@ LOOKS_TO_DOWNLOAD = [ ("30", ["18", "50", "92", "49", "91"]), # BigQueryIO_Read ("31", ["19", "52", "88", "51", "87"]), # BigQueryIO_Write - ("32", ["20", "60", "104", "59", "103"]), # BigTableIO_Read - ("33", ["21", "70", "116", "69", "115"]), # BigTableIO_Write + ("32", ["20", "60", "104", "59", "103"]), # BigtableIO_Read + ("33", ["21", "70", "116", "69", "115"]), # BigtableIO_Write ("34", ["22", "56", "96", "55", "95"]), # TextIO_Read ("35", ["23", "64", "110", "63", "109"]), # TextIO_Write ("113", ["386", "388", "390", "392", "394"]), # IcebergIO_Read diff --git a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/DataTokenization.java b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/DataTokenization.java index b27479e7fc9b..9079a42410db 100644 --- a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/DataTokenization.java +++ b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/DataTokenization.java @@ -78,7 +78,7 @@ * *
  • A configured tokenization server * @@ -138,13 +138,13 @@ * - bigQueryTableName: Cloud BigQuery table name to write into * - tempLocation: Folder in a Google Cloud Storage bucket, which is needed for * BigQuery to handle data writing - * - Cloud BigTable - * - bigTableProjectId: Id of the project where the Cloud BigTable instance to write into + * - Cloud Bigtable + * - bigTableProjectId: Id of the project where the Cloud Bigtable instance to write into * is located - * - bigTableInstanceId: Id of the Cloud BigTable instance to write into - * - bigTableTableId: Id of the Cloud BigTable table to write into - * - bigTableKeyColumnName: Column name to use as a key in Cloud BigTable - * - bigTableColumnFamilyName: Column family name to use in Cloud BigTable + * - bigTableInstanceId: Id of the Cloud Bigtable instance to write into + * - bigTableTableId: Id of the Cloud Bigtable table to write into + * - bigTableKeyColumnName: Column name to use as a key in Cloud Bigtable + * - bigTableColumnFamilyName: Column family name to use in Cloud Bigtable * - RPC server parameters * - rpcUri: URI for the API calls to RPC server * - batchSize: Size of the batch to send to RPC server per request @@ -335,7 +335,7 @@ public static PipelineResult run(DataTokenizationOptions options) { .write(tokenizedRows.get(TOKENIZATION_OUT), schema.getBeamSchema()); } else { throw new IllegalStateException( - "No sink is provided, please configure BigQuery or BigTable."); + "No sink is provided, please configure BigQuery or Bigtable."); } return pipeline.run(); diff --git a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/README.md b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/README.md index 800838195b0c..741f5f601a60 100644 --- a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/README.md +++ b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/README.md @@ -36,7 +36,7 @@ Supported destination sinks: - File system - [Google Cloud BigQuery](https://cloud.google.com/bigquery) -- [Cloud BigTable](https://cloud.google.com/bigtable) +- [Cloud Bigtable](https://cloud.google.com/bigtable) Supported data schema format: @@ -122,13 +122,13 @@ To execute this pipeline, specify the parameters: - **bigQueryTableName**: Cloud BigQuery table name to write into - **tempLocation**: Folder in a Google Cloud Storage bucket, which is needed for BigQuery to handle data writing - - Cloud BigTable - - **bigTableProjectId**: Id of the project where the Cloud BigTable instance to write into + - Cloud Bigtable + - **bigTableProjectId**: Id of the project where the Cloud Bigtable instance to write into is located - - **bigTableInstanceId**: Id of the Cloud BigTable instance to write into - - **bigTableTableId**: Id of the Cloud BigTable table to write into - - **bigTableKeyColumnName**: Column name to use as a key in Cloud BigTable - - **bigTableColumnFamilyName**: Column family name to use in Cloud BigTable + - **bigTableInstanceId**: Id of the Cloud Bigtable instance to write into + - **bigTableTableId**: Id of the Cloud Bigtable table to write into + - **bigTableKeyColumnName**: Column name to use as a key in Cloud Bigtable + - **bigTableColumnFamilyName**: Column family name to use in Cloud Bigtable - RPC server parameters - **rpcUri**: URI for the API calls to RPC server - **batchSize**: Size of the batch to send to RPC server per request diff --git a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigQueryIO.java b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigQueryIO.java index 667e26fa9c2d..8ba4e4a9909c 100644 --- a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigQueryIO.java +++ b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigQueryIO.java @@ -34,7 +34,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** The {@link TokenizationBigQueryIO} class for writing data from template to BigTable. */ +/** The {@link TokenizationBigQueryIO} class for writing data from template to BigQuery. */ public class TokenizationBigQueryIO { /** Logger for class. */ diff --git a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigTableIO.java b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigTableIO.java index 435620a4b011..1db3506d188f 100644 --- a/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigTableIO.java +++ b/examples/java/src/main/java/org/apache/beam/examples/complete/datatokenization/transforms/io/TokenizationBigTableIO.java @@ -40,7 +40,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** The {@link TokenizationBigTableIO} class for writing data from template to BigTable. */ +/** The {@link TokenizationBigTableIO} class for writing data from template to Bigtable. */ public class TokenizationBigTableIO { /** Logger for class. */ @@ -101,7 +101,7 @@ public void processElement( .build()) .build()) .collect(Collectors.toSet()); - // Converting key value to BigTable format + // Converting key value to Bigtable format String columnName = in.getString(options.getBigTableKeyColumnName()); if (columnName != null) { ByteString key = ByteString.copyFrom(columnName, StandardCharsets.UTF_8); @@ -128,31 +128,31 @@ public void processElement(@Element BigtableWriteResult in) { /** * Necessary {@link PipelineOptions} options for Pipelines that perform write operations to - * BigTable. + * Bigtable. */ public interface BigTableOptions extends PipelineOptions { - @Description("Id of the project where the Cloud BigTable instance to write into is located.") + @Description("Id of the project where the Cloud Bigtable instance to write into is located.") String getBigTableProjectId(); void setBigTableProjectId(String bigTableProjectId); - @Description("Id of the Cloud BigTable instance to write into.") + @Description("Id of the Cloud Bigtable instance to write into.") String getBigTableInstanceId(); void setBigTableInstanceId(String bigTableInstanceId); - @Description("Id of the Cloud BigTable table to write into.") + @Description("Id of the Cloud Bigtable table to write into.") String getBigTableTableId(); void setBigTableTableId(String bigTableTableId); - @Description("Column name to use as a key in Cloud BigTable.") + @Description("Column name to use as a key in Cloud Bigtable.") String getBigTableKeyColumnName(); void setBigTableKeyColumnName(String bigTableKeyColumnName); - @Description("Column family name to use in Cloud BigTable.") + @Description("Column family name to use in Cloud Bigtable.") String getBigTableColumnFamilyName(); void setBigTableColumnFamilyName(String bigTableColumnFamilyName); diff --git a/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOLT.java b/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOLT.java index 27773121e79d..b56199db0bf7 100644 --- a/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOLT.java +++ b/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOLT.java @@ -53,7 +53,7 @@ import org.junit.Test; /** - * BigTableIO performance tests. + * BigtableIO performance tests. * *

    Example trigger command for all tests: "mvn test -pl it/google-cloud-platform -am * -Dtest=BigTableIOLT \ -Dproject=[gcpProject] -DartifactBucket=[temp bucket] @@ -248,7 +248,7 @@ abstract static class Builder { abstract Builder toBuilder(); } - /** Maps long number to the BigTable format record. */ + /** Maps long number to the Bigtable format record. */ private static class MapToBigTableFormat extends DoFn>> implements Serializable { diff --git a/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOST.java b/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOST.java index b86f13a0de10..b723e7aecbe6 100644 --- a/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOST.java +++ b/it/google-cloud-platform/src/test/java/org/apache/beam/it/gcp/bigtable/BigTableIOST.java @@ -62,7 +62,7 @@ import org.junit.Test; /** - * BigTableIO stress test. The test is designed to assess the performance of BigTableIO under + * BigtableIO stress test. The test is designed to assess the performance of BigtableIO under * various conditions. * *

    Usage:
    @@ -229,7 +229,7 @@ public void runTest() throws IOException, ParseException, InterruptedException { } /** - * The method creates a pipeline to simulate data generation and write operations to BigTable, + * The method creates a pipeline to simulate data generation and write operations to Bigtable, * based on the specified configuration parameters. The stress test involves varying the load * dynamically over time, with options to use configurable parameters. */ @@ -278,7 +278,7 @@ private PipelineLauncher.LaunchInfo generateDataAndWrite() throws IOException { return pipelineLauncher.launch(project, region, options); } - /** The method reads data from BigTable in batch mode. */ + /** The method reads data from Bigtable in batch mode. */ private PipelineLauncher.LaunchInfo readData() throws IOException { BigtableIO.Read readIO = BigtableIO.read() @@ -307,7 +307,7 @@ private PipelineLauncher.LaunchInfo readData() throws IOException { return pipelineLauncher.launch(project, region, options); } - /** Options for BigTableIO stress test. */ + /** Options for BigtableIO stress test. */ static class Configuration extends SyntheticSourceOptions { /** Pipeline timeout in minutes. Must be a positive value. */ @JsonProperty public int pipelineTimeout = 20; @@ -347,7 +347,7 @@ static class Configuration extends SyntheticSourceOptions { @JsonProperty public String influxDatabase; } - /** Maps Instant to the BigTable format record. */ + /** Maps Instant to the Bigtable format record. */ private static class MapToBigTableFormat extends DoFn, KV>> implements Serializable { diff --git a/learning/prompts/code-generation/04_io_bigtable.md b/learning/prompts/code-generation/04_io_bigtable.md index e4b09153a692..5f1e1ee01a6e 100644 --- a/learning/prompts/code-generation/04_io_bigtable.md +++ b/learning/prompts/code-generation/04_io_bigtable.md @@ -60,7 +60,7 @@ if __name__ == "__main__": ``` The `ReadFromBigtable` transform returns a `PCollection` of `PartialRowData` objects, each representing a Bigtable row. For more information about this row object, see [PartialRowData (row_key)](https://cloud.google.com/python/docs/reference/bigtable/latest/row#class-googlecloudbigtablerowpartialrowdatarowkey). -For more information, see the [BigTable I/O connector documentation](https://beam.apache.org/releases/pydoc/current/apache_beam.io.gcp.bigtableio.html). +For more information, see the [Bigtable I/O connector documentation](https://beam.apache.org/releases/pydoc/current/apache_beam.io.gcp.bigtableio.html). For samples that show common pipeline configurations, see [Pipeline option patterns](https://beam.apache.org/documentation/patterns/pipeline-options/). diff --git a/learning/prompts/code-generation/java/04_io_bigtable.md b/learning/prompts/code-generation/java/04_io_bigtable.md index 6b126947e042..164971d1b139 100644 --- a/learning/prompts/code-generation/java/04_io_bigtable.md +++ b/learning/prompts/code-generation/java/04_io_bigtable.md @@ -2,9 +2,9 @@ Prompt: Write a sample Java code snippet that writes data to a Google Bigtable table using Apache Beam. Response: -Your Apache Beam pipeline can write data to a Bigtable table using the Apache Beam BigTableIO connector. +Your Apache Beam pipeline can write data to a Bigtable table using the Apache Beam BigtableIO connector. -Here is an example of how to use the BigTableIO connector to accomplish this: +Here is an example of how to use the BigtableIO connector to accomplish this: ```java package bigtable; diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/RangeTracker.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/RangeTracker.java index 89185187a0f0..3832b83d316d 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/RangeTracker.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/RangeTracker.java @@ -76,7 +76,7 @@ * after A, up to but not including the first record starting at or after B". * *

    Some examples of such sources include reading lines or CSV from a text file, reading keys and - * values from a BigTable, etc. + * values from a Bigtable, etc. * *

    The concept of split points allows to extend the definitions for dealing with sources * where some records cannot be identified by a unique starting position. diff --git a/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/BigtableTableProvider.java b/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/BigtableTableProvider.java index 9e36cb1eb5e2..4f99cce339fe 100644 --- a/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/BigtableTableProvider.java +++ b/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/BigtableTableProvider.java @@ -27,7 +27,7 @@ /** * {@link TableProvider} for {@link BigtableTable}. * - *

    A sample of BigTable table is: + *

    A sample of Bigtable table is: * *

    {@code
      *   CREATE EXTERNAL TABLE beamTable(
    diff --git a/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/package-info.java b/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/package-info.java
    index 683d60ee90d2..e056524ac9a9 100644
    --- a/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/package-info.java
    +++ b/sdks/java/extensions/sql/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/bigtable/package-info.java
    @@ -16,5 +16,5 @@
      * limitations under the License.
      */
     
    -/** Table schema for BigTable. */
    +/** Table schema for Bigtable. */
     package org.apache.beam.sdk.extensions.sql.meta.provider.bigtable;
    diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/StorageApiWriteUnshardedRecords.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/StorageApiWriteUnshardedRecords.java
    index 0f52900e9e0b..170de2ed2c5d 100644
    --- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/StorageApiWriteUnshardedRecords.java
    +++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/StorageApiWriteUnshardedRecords.java
    @@ -839,7 +839,7 @@ long flush(
                   }
                   if (schemaMismatchError) {
                     LOG.info(
    -                    "Vortex failed stream open due to incompatible fields. This is likely because the BigTable "
    +                    "Vortex failed stream open due to incompatible fields. This is likely because the Bigtable "
                             + "schema was recently updated and Vortex hasn't noticed yet, so retrying. error {}",
                         Preconditions.checkStateNotNull(error).toString());
                   }
    diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableConfig.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableConfig.java
    index a69b4dbfc694..6a35ae1507c9 100644
    --- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableConfig.java
    +++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableConfig.java
    @@ -128,12 +128,12 @@ abstract Builder setBigtableOptionsConfigurator(
       }
     
       public BigtableConfig withProjectId(ValueProvider projectId) {
    -    checkArgument(projectId != null, "Project Id of BigTable can not be null");
    +    checkArgument(projectId != null, "Project Id of Bigtable can not be null");
         return toBuilder().setProjectId(projectId).build();
       }
     
       public BigtableConfig withInstanceId(ValueProvider instanceId) {
    -    checkArgument(instanceId != null, "Instance Id of BigTable can not be null");
    +    checkArgument(instanceId != null, "Instance Id of Bigtable can not be null");
         return toBuilder().setInstanceId(instanceId).build();
       }
     
    diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java
    index 02236469e325..6ca2e1ed33bb 100644
    --- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java
    +++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java
    @@ -112,7 +112,7 @@
     /**
      * {@link PTransform Transforms} for reading from and writing to Google Cloud Bigtable.
      *
    - * 

    Please note the Cloud BigTable HBase connector available Please note the Cloud Bigtable HBase connector available here. * We recommend using that connector over this one if HBase API works for your diff --git a/sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIOTest.java b/sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIOTest.java index 8d9a0f1bcfa5..076b717be63c 100644 --- a/sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIOTest.java +++ b/sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIOTest.java @@ -1641,7 +1641,7 @@ public void testGetSplitPointsConsumed() throws Exception { } @Test - public void testReadWithBigTableOptionsSetsRetryOptions() { + public void testReadWithBigtableOptionsSetsRetryOptions() { final int initialBackoffMillis = -1; BigtableOptions.Builder optionsBuilder = BIGTABLE_OPTIONS.toBuilder(); @@ -1660,7 +1660,7 @@ public void testReadWithBigTableOptionsSetsRetryOptions() { } @Test - public void testWriteWithBigTableOptionsSetsBulkOptionsAndRetryOptions() { + public void testWriteWithBigtableOptionsSetsBulkOptionsAndRetryOptions() { final int maxInflightRpcs = 1; final int initialBackoffMillis = -1; diff --git a/sdks/python/apache_beam/examples/snippets/transforms/elementwise/enrichment.py b/sdks/python/apache_beam/examples/snippets/transforms/elementwise/enrichment.py index 12ec205d2e62..d35258be3938 100644 --- a/sdks/python/apache_beam/examples/snippets/transforms/elementwise/enrichment.py +++ b/sdks/python/apache_beam/examples/snippets/transforms/elementwise/enrichment.py @@ -46,7 +46,7 @@ def enrichment_with_bigtable(): _ = ( p | "Create" >> beam.Create(data) - | "Enrich W/ BigTable" >> Enrichment(bigtable_handler) + | "Enrich W/ Bigtable" >> Enrichment(bigtable_handler) | "Print" >> beam.Map(print)) # [END enrichment_with_bigtable] diff --git a/sdks/python/apache_beam/io/gcp/bigtableio.py b/sdks/python/apache_beam/io/gcp/bigtableio.py index cd78deb7466c..b8d212428060 100644 --- a/sdks/python/apache_beam/io/gcp/bigtableio.py +++ b/sdks/python/apache_beam/io/gcp/bigtableio.py @@ -15,18 +15,18 @@ # limitations under the License. # -"""BigTable connector +"""Bigtable connector -This module implements writing to BigTable tables. -The default mode is to set row data to write to BigTable tables. +This module implements writing to Bigtable tables. +The default mode is to set row data to write to Bigtable tables. The syntax supported is described here: https://cloud.google.com/bigtable/docs/quickstart-cbt -BigTable connector can be used as main outputs. A main output +Bigtable connector can be used as main outputs. A main output (common case) is expected to be massive and will be split into manageable chunks and processed in parallel. In the example below we created a list of rows then passed to the GeneratedDirectRows -DoFn to set the Cells and then we call the BigTableWriteFn to insert +DoFn to set the Cells and then we call the _BigTableWriteFn to insert those generated rows in the table. main_table = (p diff --git a/sdks/python/apache_beam/io/gcp/bigtableio_it_test.py b/sdks/python/apache_beam/io/gcp/bigtableio_it_test.py index 488914c4b198..9f14e8408200 100644 --- a/sdks/python/apache_beam/io/gcp/bigtableio_it_test.py +++ b/sdks/python/apache_beam/io/gcp/bigtableio_it_test.py @@ -15,7 +15,7 @@ # limitations under the License. # -"""Integration tests for BigTable service.""" +"""Integration tests for Bigtable service.""" import logging import os @@ -66,7 +66,7 @@ def instance_prefix(instance): os.environ.get('TRANSFORM_SERVICE_PORT'), "A valid expansion service is not available for executing the " "cross-language test.") -class TestReadFromBigTableIT(unittest.TestCase): +class TestReadFromBigtableIT(unittest.TestCase): INSTANCE = "bt-read-tests" TABLE_ID = "test-table" diff --git a/sdks/python/apache_beam/io/gcp/bigtableio_test.py b/sdks/python/apache_beam/io/gcp/bigtableio_test.py index 08c33017f9c7..4aba9a4062fd 100644 --- a/sdks/python/apache_beam/io/gcp/bigtableio_test.py +++ b/sdks/python/apache_beam/io/gcp/bigtableio_test.py @@ -15,7 +15,7 @@ # limitations under the License. # -"""Unit tests for BigTable service.""" +"""Unit tests for Bigtable service.""" import logging import string diff --git a/sdks/python/apache_beam/io/iobase.py b/sdks/python/apache_beam/io/iobase.py index b7be85935997..34ee781d87a1 100644 --- a/sdks/python/apache_beam/io/iobase.py +++ b/sdks/python/apache_beam/io/iobase.py @@ -295,7 +295,7 @@ class RangeTracker(object): at or after 'B'". Some examples of such sources include reading lines or CSV from a text file, - reading keys and values from a BigTable, etc. + reading keys and values from a Bigtable, etc. The concept of *split points* allows to extend the definitions for dealing with sources where some records cannot be identified by a unique starting diff --git a/sdks/python/apache_beam/testing/analyzers/io_tests_config.yaml b/sdks/python/apache_beam/testing/analyzers/io_tests_config.yaml index 2a33ae31797d..633737811fc4 100644 --- a/sdks/python/apache_beam/testing/analyzers/io_tests_config.yaml +++ b/sdks/python/apache_beam/testing/analyzers/io_tests_config.yaml @@ -185,7 +185,7 @@ bigquery_io_json_file_loads_write: bigtable_io_read: test_description: | - BigTableIO read test 100 GB. + BigtableIO read test 100 GB. project: apache-beam-testing metrics_dataset: performance_tests metrics_table: io_performance_metrics @@ -197,7 +197,7 @@ bigtable_io_read: bigtable_io_write: test_description: | - BigTableIO write test 100 GB. + BigtableIO write test 100 GB. project: apache-beam-testing metrics_dataset: performance_tests metrics_table: io_performance_metrics diff --git a/sdks/python/apache_beam/transforms/enrichment_handlers/bigtable.py b/sdks/python/apache_beam/transforms/enrichment_handlers/bigtable.py index c251ab05ecab..b1a7bde212a0 100644 --- a/sdks/python/apache_beam/transforms/enrichment_handlers/bigtable.py +++ b/sdks/python/apache_beam/transforms/enrichment_handlers/bigtable.py @@ -40,26 +40,26 @@ class BigTableEnrichmentHandler(EnrichmentSourceHandler[beam.Row, beam.Row]): """A handler for :class:`apache_beam.transforms.enrichment.Enrichment` - transform to interact with GCP BigTable. + transform to interact with GCP Bigtable. Args: - project_id (str): GCP project-id of the BigTable cluster. - instance_id (str): GCP instance-id of the BigTable cluster. - table_id (str): GCP table-id of the BigTable. + project_id (str): GCP project-id of the Bigtable cluster. + instance_id (str): GCP instance-id of the Bigtable cluster. + table_id (str): GCP table-id of the Bigtable. row_key (str): unique row-key field name from the input `beam.Row` object - to use as `row_key` for BigTable querying. + to use as `row_key` for Bigtable querying. row_filter: a ``:class:`google.cloud.bigtable.row_filters.RowFilter``` to filter data read with ``read_row()``. Defaults to `CellsColumnLimitFilter(1)`. - app_profile_id (str): App profile ID to use for BigTable. + app_profile_id (str): App profile ID to use for Bigtable. See https://cloud.google.com/bigtable/docs/app-profiles for more details. encoding (str): encoding type to convert the string to bytes and vice-versa - from BigTable. Default is `utf-8`. + from Bigtable. Default is `utf-8`. row_key_fn: a lambda function that returns a string row key from the input row. It is used to build/extract the row key for Bigtable. exception_level: a `enum.Enum` value from ``apache_beam.transforms.enrichment_handlers.utils.ExceptionLevel`` - to set the level when an empty row is returned from the BigTable query. + to set the level when an empty row is returned from the Bigtable query. Defaults to ``ExceptionLevel.WARN``. include_timestamp (bool): If enabled, the timestamp associated with the value is returned as `(value, timestamp)` for each `row_key`. @@ -98,7 +98,7 @@ def __init__( "from the input row.") def __enter__(self): - """connect to the Google BigTable cluster.""" + """connect to the Google Bigtable cluster.""" self.client = Client(project=self._project_id) self.instance = self.client.instance(self._instance_id) self._table = bigtable.table.Table( @@ -108,7 +108,7 @@ def __enter__(self): def __call__(self, request: beam.Row, *args, **kwargs): """ - Reads a row from the GCP BigTable and returns + Reads a row from the GCP Bigtable and returns a `Tuple` of request and response. Args: @@ -147,7 +147,7 @@ def __call__(self, request: beam.Row, *args, **kwargs): raise KeyError('row_key %s not found in input PCollection.' % row_key_str) except NotFound: raise NotFound( - 'GCP BigTable cluster `%s:%s:%s` not found.' % + 'GCP Bigtable cluster `%s:%s:%s` not found.' % (self._project_id, self._instance_id, self._table_id)) except Exception as e: raise e @@ -155,7 +155,7 @@ def __call__(self, request: beam.Row, *args, **kwargs): return request, beam.Row(**response_dict) def __exit__(self, exc_type, exc_val, exc_tb): - """Clean the instantiated BigTable client.""" + """Clean the instantiated Bigtable client.""" self.client = None self.instance = None self._table = None diff --git a/sdks/python/apache_beam/transforms/enrichment_handlers/vertex_ai_feature_store.py b/sdks/python/apache_beam/transforms/enrichment_handlers/vertex_ai_feature_store.py index b6de3aa1c826..c364378ea8a5 100644 --- a/sdks/python/apache_beam/transforms/enrichment_handlers/vertex_ai_feature_store.py +++ b/sdks/python/apache_beam/transforms/enrichment_handlers/vertex_ai_feature_store.py @@ -86,7 +86,7 @@ def __init__( for the feature values. exception_level: a `enum.Enum` value from `apache_beam.transforms.enrichment_handlers.utils.ExceptionLevel` - to set the level when an empty row is returned from the BigTable query. + to set the level when an empty row is returned from the Bigtable query. Defaults to `ExceptionLevel.WARN`. kwargs: Optional keyword arguments to configure the `aiplatform.gapic.FeatureOnlineStoreServiceClient`. @@ -229,7 +229,7 @@ def __init__( for the feature values. exception_level: a `enum.Enum` value from `apache_beam.transforms.enrichment_handlers.utils.ExceptionLevel` - to set the level when an empty row is returned from the BigTable query. + to set the level when an empty row is returned from the Bigtable query. Defaults to `ExceptionLevel.WARN`. kwargs: Optional keyword arguments to configure the `aiplatform.gapic.FeaturestoreOnlineServingServiceClient`. diff --git a/website/www/site/content/en/documentation/io/connectors.md b/website/www/site/content/en/documentation/io/connectors.md index f3078c6b378a..235c72dda726 100644 --- a/website/www/site/content/en/documentation/io/connectors.md +++ b/website/www/site/content/en/documentation/io/connectors.md @@ -652,7 +652,7 @@ This table provides a consolidated, at-a-glance overview of the available built- ✔ - BigTableIO (metrics) + BigtableIO (metrics) ✔ ✔ diff --git a/website/www/site/content/en/documentation/io/developing-io-java.md b/website/www/site/content/en/documentation/io/developing-io-java.md index 0d792149bfff..d52968a350a4 100644 --- a/website/www/site/content/en/documentation/io/developing-io-java.md +++ b/website/www/site/content/en/documentation/io/developing-io-java.md @@ -147,7 +147,7 @@ abstract methods: `BoundedSource`. You can see a model of how to implement `BoundedSource` and the required -abstract methods in Beam’s implementations for Cloud BigTable +abstract methods in Beam’s implementations for Cloud Bigtable ([BigtableIO.java](https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java)) and BigQuery ([BigQuerySourceBase.java](https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQuerySourceBase.java)). diff --git a/website/www/site/content/en/documentation/io/io-standards.md b/website/www/site/content/en/documentation/io/io-standards.md index 94aa48323fd1..1f1ee505b0b4 100644 --- a/website/www/site/content/en/documentation/io/io-standards.md +++ b/website/www/site/content/en/documentation/io/io-standards.md @@ -1180,7 +1180,7 @@ When possible, unit tests are favored over integration tests due to faster execu

    For every option available to users. For example, writing to dynamic destinations. -

    BigTableIOTest.testReadWithBigTableOptionsSetsRetryOptions +

    BigtableIOTest.testReadWithBigtableOptionsSetsRetryOptions

    BigQueryIOWriteTest.testWriteDynamicDestinations @@ -1238,7 +1238,7 @@ When possible, unit tests are favored over integration tests due to faster execu

    There can be many variations of these tests. Please refer to examples for details. -

    BigTableIOTest.testReadingSplitAtFractionExhaustive +

    BigtableIOTest.testReadingSplitAtFractionExhaustive

    avroio_test.AvroBase.test_dynamic_work_rebalancing_exhaustive diff --git a/website/www/site/content/en/performance/_index.md b/website/www/site/content/en/performance/_index.md index 08fd368809c8..c19cf55dbfe4 100644 --- a/website/www/site/content/en/performance/_index.md +++ b/website/www/site/content/en/performance/_index.md @@ -36,7 +36,7 @@ See the following pages for performance measures recorded when reading from and writing to various Beam IOs. - [BigQuery](/performance/bigquery) -- [BigTable](/performance/bigtable) +- [Bigtable](/performance/bigtable) - [TextIO](/performance/textio) - [IcebergIO](/performance/icebergio) diff --git a/website/www/site/content/en/performance/bigtable/_index.md b/website/www/site/content/en/performance/bigtable/_index.md index 413cd5393eaa..567377d38c42 100644 --- a/website/www/site/content/en/performance/bigtable/_index.md +++ b/website/www/site/content/en/performance/bigtable/_index.md @@ -1,5 +1,5 @@ --- -title: "BigTable Performance" +title: "Bigtable Performance" --- -# BigTable Performance +# Bigtable Performance The following graphs show various metrics when reading from and writing to -BigTable. See the [glossary](/performance/glossary) for definitions. +Bigtable. See the [glossary](/performance/glossary) for definitions. ## Read -### What is the estimated cost to read from BigTable? +### What is the estimated cost to read from Bigtable? {{< performance_looks io="bigtable" read_or_write="read" section="test_name" >}} -### How has various metrics changed when reading from BigTable for different Beam SDK versions? +### How has various metrics changed when reading from Bigtable for different Beam SDK versions? {{< performance_looks io="bigtable" read_or_write="read" section="version" >}} -### How has various metrics changed over time when reading from BigTable? +### How has various metrics changed over time when reading from Bigtable? {{< performance_looks io="bigtable" read_or_write="read" section="date" >}} ## Write -### What is the estimated cost to write to BigTable? +### What is the estimated cost to write to Bigtable? {{< performance_looks io="bigtable" read_or_write="write" section="test_name" >}} -### How has various metrics changed when writing to BigTable for different Beam SDK versions? +### How has various metrics changed when writing to Bigtable for different Beam SDK versions? {{< performance_looks io="bigtable" read_or_write="write" section="version" >}} -### How has various metrics changed over time when writing to BigTable? +### How has various metrics changed over time when writing to Bigtable? {{< performance_looks io="bigtable" read_or_write="write" section="date" >}} diff --git a/website/www/site/data/performance.yaml b/website/www/site/data/performance.yaml index 03eaad774b0b..9a8e7c8bd8fd 100644 --- a/website/www/site/data/performance.yaml +++ b/website/www/site/data/performance.yaml @@ -50,7 +50,7 @@ looks: folder: 32 test_name: - id: YQ2W3wdNnBXMgDgpzCRbmQWMHjyPvZny - title: Read BigTable RunTime and EstimatedCost + title: Read Bigtable RunTime and EstimatedCost date: - id: szvwNfPrwTtmRmMHWv3QFh6wTKxm26TF title: AvgOutputThroughputBytesPerSec by Date @@ -65,7 +65,7 @@ looks: folder: 33 test_name: - id: 2sC27RQwWy2MP9DXVHjbvTYSNFYpFvxj - title: Write BigTable RunTime and EstimatedCost + title: Write Bigtable RunTime and EstimatedCost date: - id: X22sDqD8krBQQ4mRXTFMmpKFvgkZ529g title: AvgInputThroughputBytesPerSec by Date diff --git a/website/www/site/i18n/navbar/en.yaml b/website/www/site/i18n/navbar/en.yaml index aeb1988183b0..db658c710327 100644 --- a/website/www/site/i18n/navbar/en.yaml +++ b/website/www/site/i18n/navbar/en.yaml @@ -53,7 +53,7 @@ - id: nav-performance-bigquery translation: "BigQuery" - id: nav-performance-bigtable - translation: "BigTable" + translation: "Bigtable" - id: nav-performance-textio translation: "TextIO" - id: nav-performance-glossary