Package org.springframework.boot.jdbc

Enum Class EmbeddedDatabaseConnection

java.lang.Object
java.lang.Enum<EmbeddedDatabaseConnection>
org.springframework.boot.jdbc.EmbeddedDatabaseConnection
All Implemented Interfaces:
Serializable, Comparable<EmbeddedDatabaseConnection>, Constable
public enum EmbeddedDatabaseConnection extends Enum<EmbeddedDatabaseConnection>
Connection details for embedded databases.
Since:
1.0.0
See Also:

  • Enum Constant Details

  • Method Details

    • values

      public static EmbeddedDatabaseConnection[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EmbeddedDatabaseConnection valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDriverClassName

      public String getDriverClassName()
      Returns the driver class name.
      Returns:
      the driver class name

    • getType

      public org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType getType()
      Returns the EmbeddedDatabaseType for the connection.
      Returns:
      the database type

    • getUrl

      public String getUrl(String databaseName)
      Returns the URL for the connection using the specified databaseName.
      Parameters:
      databaseName - the name of the database
      Returns:
      the connection URL

    • isEmbedded

      public static boolean isEmbedded(String driverClass, String url)
      Convenience method to determine if a given driver class name and url represent an embedded database type.
      Parameters:
      driverClass - the driver class
      url - the jdbc url (can be null)
      Returns:
      true if the driver class and url refer to an embedded database
      Since:
      2.4.0

    • isEmbedded

      public static boolean isEmbedded(DataSource dataSource)
      Convenience method to determine if a given data source represents an embedded database type.
      Parameters:
      dataSource - the data source to interrogate
      Returns:
      true if the data source is one of the embedded types

    • get

      public static EmbeddedDatabaseConnection get(ClassLoader classLoader)
      Returns the most suitable EmbeddedDatabaseConnection for the given class loader.
      Parameters:
      classLoader - the class loader used to check for classes
      Returns:
      an EmbeddedDatabaseConnection or NONE.