manifold.sql.rt.api

Interface DbConfig

All Known Implementing Classes:

DbConfigImpl

public interface DbConfig

Configuration for connecting to a JDBC data source. Maps directly to JSON data obtained from a .dbconfig file, or at runtime if the config is provided from a DbConfigProvider SPI implementation, it is obtained programmatically. At compile-time the dbconfig is supplied as a resource file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCHEMA_PKG

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBuildUrl() (Optional) JDBC URL for database (build time).
default java.lang.String	getBuildUrlOtherwiseRuntimeUrl() Returns the build URL if provided, otherwise the runtime URL
java.lang.String	getCatalogName() (Optional) The catalog containing the schema.
java.lang.String	getCustomBaseClass() (Optional) The qualified name of the base class to be used for generated schema table classes
java.lang.String	getCustomBaseInterface() (Optional) The qualified name of the base interface to be used for generated schema table classes
java.lang.String	getDbDdl() (Optional) The DDL for the database/schema this configuration is using.
java.lang.String	getName() (Provided) Name corresponding with the dbconfig file: MyDatabase.dbconfig -> "MyDatabase".
java.lang.String	getPassword() (Optional) Password for database account
java.lang.String	getPath() (Provided: Compile) Location of dbconfig file corresponding with this class.
manifold.rt.api.Bindings	getProperties() (Optional) JDBC connection properties in JSON format.
java.lang.String	getSchemaName() (Optional) The name of the database schema used for this configuration.
java.lang.String	getSchemaPackage() (Optional) The fully qualified package name where schema .class files will be generated.
java.lang.String	getUrl() (Required: Compile/Run) JDBC URL for database (run time).
java.lang.String	getUser() (Optional) Username for database account
void	init(java.sql.Connection connection, ExecutionEnv environment)
boolean	isDefault() (Optional) If true, this dbconfig is the "default" configuration.
boolean	isInMemory() (Optional) true if using the database and driver in-process (in-memory) e.g., jdbc:h2:mem or jdbc:sqlite::memory:.
default java.util.Properties	toProperties() Convert the connection related config attributes to a Properties object

Field Detail

DEFAULT_SCHEMA_PKG

static final java.lang.String DEFAULT_SCHEMA_PKG

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

(Provided) Name corresponding with the dbconfig file: MyDatabase.dbconfig -> "MyDatabase". This name will be the parent Java type name of db table entities.

If the dbconfig does not provide a "schemaName" and the JDBC URL does not indicate a schema, this name is also the schema name.

This name is automatically set by manifold on load of the file, or if this DbConfig was constructed via DbConfigProvider SPI, it will be supplied by the implementation.

getCatalogName

java.lang.String getCatalogName()

(Optional) The catalog containing the schema. If dbconfig does not provide a "catalogName", all accessible database catalogs are searched for a schema matching "schemaName", in no particular order. If "catalogName" is the empty string "", this indicates only schemas without a catalog will be considered.

Note, it is common for JDBC drivers to support naming the catalog in the URL. In this case the catalog name is unnecessary in the dbconfig.

Note, some drivers provide schema names as catalog names i.e., catalogs without schemas. For instance, MySql does this. In this case the catalog names are queried from the database metadata, but used as schema names. Do not provide the catalog name if it is not the container of the schema.

getSchemaName

java.lang.String getSchemaName()

(Optional) The name of the database schema used for this configuration. If no "schemaName" is provided, the dbconfig file name is used as the schema name. If the file name, does not correspond with a schema in the database, a default schema will be selected automatically.

Note, some drivers provide schema names as catalog names e.g., MySql. In this case the catalog names are queried from the catalogs of the driver's database metadata.

getPath

java.lang.String getPath()

(Provided: Compile) Location of dbconfig file corresponding with this class. This field is supplied and is relevant only at compile-time. This is fields is used for logging and debugging.

getUrl

java.lang.String getUrl()

(Required: Compile/Run) JDBC URL for database (run time). If getBuildUrl() returns null, this URL is used both for runtime and build time.

getBuildUrl

java.lang.String getBuildUrl()

(Optional) JDBC URL for database (build time). This database may be void of data, it is used solely for metadata during compilation.

getSchemaPackage

java.lang.String getSchemaPackage()

(Optional) The fully qualified package name where schema .class files will be generated. If not provided, the default package will be used: DEFAULT_SCHEMA_PKG.

This property is used exclusively for compile time.

getUser

java.lang.String getUser()

(Optional) Username for database account

getPassword

java.lang.String getPassword()

(Optional) Password for database account

isDefault

boolean isDefault()

(Optional) If true, this dbconfig is the "default" configuration. The default dbconfig is applied to all SQL resources not qualified with a dbconfig.

If there is only one dbconfig in use, it is considered default. Otherwise, if multiple dbconfigs are in use, a SQL resource not intended for the default dbconfig must qualify its name with the intended dbconfig. As such, if are not using multiple dbconfigs in your project you can ignore this setting.

To specify a dbconfig name a .sql file follows the naming convention:
MyQueryFile.MyDbConfig.sql

Inline SQL follows a similar pattern:
"[.sql:MyDbConfig/] select * from ..." "[MyQuery.sql:MyDbConfig/] select * from ..."

getProperties

manifold.rt.api.Bindings getProperties()

(Optional) JDBC connection properties in JSON format. These properties are driver-specific. See toProperties().

getDbDdl

java.lang.String getDbDdl()

(Optional) The DDL for the database/schema this configuration is using. This is often a DDL dump from the DBMS.

getCustomBaseInterface

java.lang.String getCustomBaseInterface()

(Optional) The qualified name of the base interface to be used for generated schema table classes

getCustomBaseClass

java.lang.String getCustomBaseClass()

(Optional) The qualified name of the base class to be used for generated schema table classes

isInMemory

boolean isInMemory()

(Optional) true if using the database and driver in-process (in-memory) e.g., jdbc:h2:mem or jdbc:sqlite::memory:.

getBuildUrlOtherwiseRuntimeUrl

default java.lang.String getBuildUrlOtherwiseRuntimeUrl()

Returns the build URL if provided, otherwise the runtime URL

toProperties

default java.util.Properties toProperties()

Convert the connection related config attributes to a Properties object

init

void init(java.sql.Connection connection,
          ExecutionEnv environment)
   throws java.sql.SQLException

Throws:

java.sql.SQLException