/*
 * Copyright 2020-2023 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.relational.core.dialect;

import java.sql.Connection;
import java.sql.PreparedStatement;

/**
 * Describes how obtaining generated ids after an insert works for a given JDBC driver.
 *
 * @author Jens Schauder
 * @author Chirag Tailor
 * @since 2.1
 */
public interface IdGeneration {

	/**
	 * A default instance working for many databases and equivalent to Spring Data JDBCs behavior before version 2.1.
	 */
	IdGeneration DEFAULT = new IdGeneration() {};

	/**
	 * Does the driver require the specification of those columns for which a generated id shall be returned.
	 * <p>
	 * This should be {@literal false} for most dialects. One notable exception is Oracle.
	 *
	 * @return {@literal true} if the a list of column names should get passed to the JDBC driver for which ids shall be
	 *         generated.
	 * @see Connection#prepareStatement(String, String[])
	 */
	default boolean driverRequiresKeyColumnNames() {
		return false;
	}

	/**
	 * Does the driver support id generation for batch operations.
	 * <p>
	 * This should be {@literal true} for most dialects, except DB2 and SqlServer.
	 *
	 * @return {@literal true} if the JDBC driver supports generated keys for batch operations.
	 * @see PreparedStatement#getGeneratedKeys()
	 * @since 2.4
	 */
	default boolean supportedForBatchOperations() {
		return true;
	}
}
