001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019/**
020 * Controls how {@link java.time.Instant} and {@link java.time.OffsetDateTime} parameters are bound when JDBC
021 * {@link java.sql.ParameterMetaData} cannot identify whether the target column is {@code TIMESTAMP} or
022 * {@code TIMESTAMP WITH TIME ZONE}.
023 *
024 * @author <a href="https://www.revetkn.com">Mark Allen</a>
025 * @since 4.2.0
026 */
027public enum AmbiguousTimestampBindingStrategy {
028        /**
029         * Bind ambiguous {@link java.time.Instant} and {@link java.time.OffsetDateTime} parameters as
030         * {@code TIMESTAMP WITH TIME ZONE}.
031         * <p>
032         * This is Pyranid's default strategy and is appropriate when ambiguous parameters target timestamp-with-time-zone
033         * columns.
034         */
035        TIMESTAMP_WITH_TIME_ZONE,
036
037        /**
038         * Bind ambiguous {@link java.time.Instant} and {@link java.time.OffsetDateTime} parameters as {@code TIMESTAMP}
039         * without time zone.
040         * <p>
041         * Pyranid converts {@link java.time.Instant} and {@link java.time.OffsetDateTime} parameters to the
042         * {@link Database.Builder#timeZone(java.time.ZoneId)} zone and binds the resulting local timestamp with
043         * {@link java.sql.Types#TIMESTAMP}.
044         */
045        TIMESTAMP_WITHOUT_TIME_ZONE
046}