DatabaseIdProvider.java

  1. /*
  2.  *    Copyright 2009-2024 the original author or authors.
  3.  *
  4.  *    Licensed under the Apache License, Version 2.0 (the "License");
  5.  *    you may not use this file except in compliance with the License.
  6.  *    You may obtain a copy of the License at
  7.  *
  8.  *       https://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  *    Unless required by applicable law or agreed to in writing, software
  11.  *    distributed under the License is distributed on an "AS IS" BASIS,
  12.  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  *    See the License for the specific language governing permissions and
  14.  *    limitations under the License.
  15.  */
  16. package org.apache.ibatis.mapping;

  17. import java.sql.SQLException;
  18. import java.util.Properties;

  19. import javax.sql.DataSource;

  20. /**
  21.  * Should return an id to identify the type of this database. That id can be used later on to build different queries
  22.  * for each database type This mechanism enables supporting multiple vendors or versions
  23.  *
  24.  * @author Eduardo Macarron
  25.  */
  26. public interface DatabaseIdProvider {

  27.   default void setProperties(Properties p) {
  28.     // NOP
  29.   }

  30.   String getDatabaseId(DataSource dataSource) throws SQLException;
  31. }