com.google.cloud.spanner.hibernate.hints.GroupByScanOptimizationHint Maven / Gradle / Ivy

Go to download

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

The newest version!

/*
 * Copyright 2019-2024 Google LLC
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

package com.google.cloud.spanner.hibernate.hints;

import static com.google.cloud.spanner.hibernate.hints.Hints.fromTableHint;
import static com.google.cloud.spanner.hibernate.hints.Hints.joinTableHint;

import com.google.common.collect.ImmutableList;

/** Util class for adding a GROUPBY_SCAN_OPTIMIZATION hint to queries. */
class GroupByScanOptimizationHint extends ReplaceQueryPartsHint {

  private static final String HINT = "GROUPBY_SCAN_OPTIMIZATION";

  static GroupByScanOptimizationHint from(String table, boolean value, ReplaceMode replaceMode) {
    return new GroupByScanOptimizationHint(
        ImmutableList.of(
            new Replacement(
                Hints.from(table), groupByScanOptimizationFrom(table, value), replaceMode)));
  }

  static GroupByScanOptimizationHint join(String table, boolean value, ReplaceMode replaceMode) {
    return new GroupByScanOptimizationHint(
        ImmutableList.of(
            new Replacement(
                Hints.join(table), groupByScanOptimizationJoin(table, value), replaceMode)));
  }

  private GroupByScanOptimizationHint(ImmutableList replacements) {
    super(replacements);
  }

  private static String groupByScanOptimizationFrom(String table, boolean value) {
    return fromTableHint(table, HINT, String.valueOf(value));
  }

  private static String groupByScanOptimizationJoin(String table, boolean value) {
    return joinTableHint(table, HINT, String.valueOf(value));
  }
}