org.projectnessie.versioned.persist.tx.local.LocalTxConnectionConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nessie-versioned-persist-transactional-test Show documentation
There is a newer version: 0.59.0
Show newest version
/*
 * Copyright (C) 2020 Dremio
 *
 * 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 org.projectnessie.versioned.persist.tx.local;

import io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation;
import javax.annotation.Nullable;
import org.immutables.value.Value;
import org.projectnessie.versioned.persist.tx.TxConnectionConfig;

/** TX-database-adapter config interface. */
@Value.Immutable
public interface LocalTxConnectionConfig extends TxConnectionConfig {

  @Nullable
  String getJdbcUrl();

  LocalTxConnectionConfig withJdbcUrl(String jdbcUrl);

  @Nullable
  String getJdbcUser();

  LocalTxConnectionConfig withJdbcUser(String jdbcUser);

  @Nullable
  String getJdbcPass();

  LocalTxConnectionConfig withJdbcPass(String jdbcPass);

  /** For "unmanaged" connection-pools: the JDBC pool's minimum size, defaults to {@code 1}. */
  @Value.Default
  default int getPoolMinSize() {
    return 1;
  }

  LocalTxConnectionConfig withPoolMinSize(int poolMinSize);

  /** For "unmanaged" connection-pools: the JDBC pool's maximum size, defaults to {@code 10}. */
  @Value.Default
  default int getPoolMaxSize() {
    return 10;
  }

  LocalTxConnectionConfig withPoolMaxSize(int poolMaxSize);

  /** For "unmanaged" connection-pools: the JDBC pool's initial size, defaults to {@code 1}. */
  @Value.Default
  default int getPoolInitialSize() {
    return 1;
  }

  LocalTxConnectionConfig withPoolInitialSize(int poolInitialSize);

  /**
   * For "unmanaged" connection-pools: the JDBC pool's connection acquisition timeout in seconds,
   * defaults to {@code 30}.
   */
  @Value.Default
  default int getPoolAcquisitionTimeoutSeconds() {
    return 30;
  }

  LocalTxConnectionConfig withPoolAcquisitionTimeoutSeconds(int poolAcquisitionTimeoutSeconds);

  /**
   * For "unmanaged" connection-pools: the JDBC pool's connection max lifetime in minutes, defaults
   * to {@code 5}.
   */
  @Value.Default
  default int getPoolConnectionLifetimeMinutes() {
    return 5;
  }

  LocalTxConnectionConfig withPoolConnectionLifetimeMinutes(int poolConnectionLifetimeMinutes);

  /**
   * For "unmanaged" connection-pools: the JDBC pool's transaction isolation, one of the enums from
   * {@link io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation},
   * defaults to {@link
   * io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation#READ_COMMITTED}.
   *
   * Technically we only need {@code READ_COMMITTED}. The extra bit that {@code SERIALIZABLE}
   * brings is not needed. Reason is that we "only" do CAS-ish operations on 'global_state' and
   * 'named_refs' tables (think: {@code INSERT INTO resp. UPDATE value=? ... WHERE value=?}) - the
   * other operations (on 'commit_log' and 'key_list') are {@code INSERT INTO} only. All "guarded"
   * by a transaction - so either everything or nothing becomes visible atomically.
   */
  @Value.Default
  default String getPoolTransactionIsolation() {
    return TransactionIsolation.READ_COMMITTED.name();
  }

  LocalTxConnectionConfig withPoolTransactionIsolation(String poolTransactionIsolation);
}