com.google.cloud.spanner.connection.PGAdapterConnectionOptionsHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-spanner-pgadapter Show documentation

The PGAdapter server implements the PostgreSQL wire-protocol, but sends all received statements to a Cloud Spanner database instead of a PostgreSQL database. The Cloud Spanner database must have been created to use the PostgreSQL dialect. See https://cloud.google.com/spanner/docs/quickstart-console#postgresql for more information on how to create PostgreSQL dialect databases on Cloud Spanner.

The newest version!

// Copyright 2022 Google LLC
//
// 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.google.cloud.spanner.connection;

import com.google.api.core.InternalApi;
import com.google.auth.Credentials;
import com.google.cloud.spanner.connection.ConnectionOptions.Builder;
import com.google.cloud.spanner.connection.StatementExecutor.StatementExecutorType;
import com.google.cloud.spanner.pgadapter.logging.GrpcLogInterceptor;
import com.google.common.collect.ImmutableList;
import java.util.logging.Level;

/** Simple helper class to get access to a package-private method in the ConnectionOptions. */
@InternalApi
public class PGAdapterConnectionOptionsHelper {
  /** Private constructor to prevent instantiation. */
  private PGAdapterConnectionOptionsHelper() {}

  // TODO: Remove when Builder.setCredentials(..) has been made public.
  public static Builder setCredentials(Builder connectionOptionsBuilder, Credentials credentials) {
    return connectionOptionsBuilder.setCredentials(credentials);
  }

  public static Builder useDirectExecutor(Builder connectionOptionsBuilder) {
    return connectionOptionsBuilder.setStatementExecutorType(StatementExecutorType.DIRECT_EXECUTOR);
  }

  /** Adds a gRPC log interceptor if the log level has been set to FINEST. */
  public static Builder maybeAddGrpcLogInterceptor(
      Builder connectionOptionsBuilder, boolean logGrpcMessagesAsInfo) {
    if (GrpcLogInterceptor.isGrpcFinestLogEnabled()) {
      return connectionOptionsBuilder.setConfigurator(
          options ->
              options.setInterceptorProvider(
                  () -> ImmutableList.of(new GrpcLogInterceptor(Level.FINEST))));
    }
    if (logGrpcMessagesAsInfo) {
      return connectionOptionsBuilder.setConfigurator(
          options ->
              options.setInterceptorProvider(
                  () -> ImmutableList.of(new GrpcLogInterceptor(Level.INFO))));
    }
    return connectionOptionsBuilder;
  }
}