Improve documentation: It's unclear how to conenct to a local emulator

[etrandafir93]

We are testing the interaction with BigQuery using Testcontainers and their glcoud module.
Internally, this will use the BigQuery emulator from goccy.

Although everything is ok for the REST Api and we can test everything related to it using this setup, setting up a JsonStreamWriter that connects to the emulator via grpc it's pretty hard to achieve. (Same question was asked in this StackOverflow post)

I couldn't find anything related to this in the official documentation or in the Javadocs. What we need is to understand how to configure the Java client to point to the container started locally.

I have tried a few different configurations like this:

JsonStreamWriter writer = JsonStreamWriter.newBuilder(
    TableName.of(BQ_DATASET, BQ_PROJECT, BQ_TABLE).toString(),
    BigQueryWriteClient.create(
        BigQueryWriteSettings.newBuilder()
            .setTransportChannelProvider(
                FixedTransportChannelProvider.create(
                    GrpcTransportChannel.create(
                        NettyChannelBuilder.forTarget("localhost:9060")
                            .usePlaintext()
                            .build()
                    )
                )
            )
            .setCredentialsProvider(NoCredentialsProvider.create())
            .build()
    )
).build();

Would it be possible to update the docs or the GitHub repo and provide an example of how can this be achieved?

[PhongChuong]

Hi @etrandafir93 , testcontainers is not part of googleapis libraries. As such, providing an example on how to integrate with it would be difficult for us as we do not know their product. I would suggest asking the owners of Testcontainers directly as they will have more experience with integrating the two.

I have not tried this myself but another option would be to look into setEndpoint() in BigQueryWriteSettings when creating BigQueryWriteClient for the JsonStreamWriter.

[etrandafir93]

hello @PhongChuong - thanks for reaching out!

To summarize, I'm asking if the documentation/javadocs for this project (the java-bigquey client library) can be improved a bit so that it's clear how to configure it to point to a different grpc endpoint. Since the library supports this feature, it'd be helpful to have a clearer example/docs to guide users in using it.

I did mention testcontainers here just to offer a bit of context about what I'm trying to achieve, but it's not highly relevant. My main aim is to use the java lib to connect to a different grpc endpoint.

I have tried multiple configurations, including BigQueryWriteSettings::setEndpoint, as illustrated in the StackOverflow question, but none of them worked.

[PhongChuong]

Thanks for the clarification.
We'll keep this open until we can find a tech writer who can work on this item.