Package de.julianweinelt.datacat.dbx.database

Interface DatabaseMetaData

All Known Implementing Classes:
DBMetaMariaDB, DBMetaMSSQL, DBMetaMySQL
public interface DatabaseMetaData
Defines meta information for database types, such as JDBC urls, the syntax and how parameters are processed.
Version:
1.0.0
Author:
Julian Weinelt

  • Method Details

    • jdbcString

      String jdbcString()
      Gets the part of the jdbc url after jdbc:[String]://
      Returns:
      The JDBC String

    • jdbcURL

      String jdbcURL()
      Gets the JDBC URL as a String object containing all needed placeholders.
      Returns:
      A full JDBC URL with placeholders

    • syntax

      DatabaseSyntax syntax()
      Gets how this database's syntax is defined.
      Returns:
      A DatabaseSyntax object defining the syntax

    • engineName

      String engineName()
      The engine name of this database, e.g. "mysql"
      Returns:
      The engine's name, often the same as jdbcString()

    • parameters

      String parameters(Map<String,String> parameters)
      Define how parameters are added to the JDBC URL.
      Parameters:
      parameters - A Map contains Strings (key-value-format) as the parameters.
      Returns:
      A String which can be added to the URL String.

    • defaultParameters

      ADatabase.ParameterBuilder defaultParameters()
      Get the default parameters of this database type.
      Returns:
      A ADatabase.ParameterBuilder object containing all default parameters.

    • defaultPort

      int defaultPort()
      Get the default port of this database
      Returns:
      An integer of the port that is used by default