manifold.sql.rt.api

Interface DbConfig

All Known Implementing Classes:

DbConfigImpl

public interface DbConfig

Configuration for connecting to a JDBC datasource. 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.

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	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() (Required: Compile) 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, java.lang.String url)
boolean	isDefault() (Optional) If true, this dbconfig is applied to SQL resources that do not specify a dbconfig name.
default java.util.Properties	toProperties() Convert the connection related config attributes to a Properties object

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.

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 may be chosen.

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

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 empty, it is used solely for metadata during compilation.

getSchemaPackage

java.lang.String getSchemaPackage()

(Required: Compile) The fully qualified package name where schema .class files will be generated. This field is required for compile-time only.

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 applied to SQL resources that do not specify a dbconfig name.

To specify a dbconfig name a .sql file follows the naming convention:
MyQuery.dbconfigName.sql

Embedded SQL follows a similar pattern:
"[.sql:dbconfigName/] select * from ..."

getProperties

manifold.rt.api.Bindings getProperties()

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

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,
          java.lang.String url)