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
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.List;
023import java.util.Optional;
024
025/**
026 * Encapsulates {@link java.sql.PreparedStatement} parameter data meant to be bound to a formal <a href="https://docs.oracle.com/en/java/javase/26/docs/api/java.sql/java/sql/Array.html" target="_blank">{@code java.sql.Array}</a> type by {@link PreparedStatementBinder}.
027 * <p>
028 * The {@code baseTypeName} corresponds to the value of <a href="https://docs.oracle.com/en/java/javase/26/docs/api/java.sql/java/sql/Array.html#getBaseTypeName()" target="_blank">{@code java.sql.Array#getBaseTypeName()}</a>
029 * and is database-specific.
030 * <p>
031 * You may determine available {@code baseTypeName} values for your database by examining metadata exposed via {@link Database#readDatabaseMetaData(DatabaseMetaDataReader)}.
032 * <p>
033 * Standard instances may be constructed via {@link Parameters#sqlArrayOf(String, Object[])} and {@link Parameters#sqlArrayOf(String, List)}.
034 * <p>
035 * Elements may themselves be {@code SqlArrayParameter}s. Pyranid materializes nested arrays recursively, but
036 * multidimensional support and type-name syntax remain driver-specific; this shape is integration-verified on
037 * DuckDB. Each containing array's {@code baseTypeName} must name its element type.
038 * <p>
039 * DuckDB elements that represent an instant require an explicit {@code TIMESTAMP} or {@code TIMESTAMPTZ}
040 * base type. A named type alias does not expose its underlying timestamp semantics through this binding path,
041 * so binding an instant-bearing value through one fails fast rather than guessing.
042 * <p>
043 * Implementations should be threadsafe.
044 *
045 * @param <E> the Java element type of the array; each element must be bindable to the SQL element type named by {@link #getBaseTypeName()} by the active {@link PreparedStatementBinder}.
046 * @author <a href="https://www.revetkn.com">Mark Allen</a>
047 * @since 3.0.0
048 */
049@ThreadSafe
050public interface SqlArrayParameter<E> {
051        /**
052         * Gets the element type of this SQL ARRAY, which corresponds to the value of <a href="https://docs.oracle.com/en/java/javase/26/docs/api/java.sql/java/sql/Array.html#getBaseTypeName()" target="_blank">{@code java.sql.Array#getBaseTypeName()}</a>
053         * and is database-specific.
054         *
055         * @return the element type of this SQL ARRAY
056         */
057        @NonNull
058        String getBaseTypeName();
059
060        /**
061         * Gets the elements of this SQL ARRAY.
062         *
063         * @return the elements of this SQL ARRAY
064         */
065        @NonNull
066        Optional<E[]> getElements();
067}