manifold.sql.rt.impl

Class DbConfigImpl

java.lang.Object

manifold.sql.rt.impl.DbConfigImpl

All Implemented Interfaces:

DbConfig

public class DbConfigImpl
extends java.lang.Object
implements DbConfig

Field Summary

Fields

Modifier and Type	Field and Description
static DbConfig	EMPTY

Fields inherited from interface manifold.sql.rt.api.DbConfig

DEFAULT_SCHEMA_PKG

Constructor Summary

Constructors

Constructor and Description
DbConfigImpl(manifold.rt.api.Bindings bindings, ExecutionEnv executionEnv) For testing only!!
DbConfigImpl(java.util.function.Function<java.lang.String,manifold.api.util.cache.FqnCache<manifold.api.fs.IFile>> resByExt, manifold.rt.api.Bindings bindings, ExecutionEnv executionEnv)
DbConfigImpl(java.util.function.Function<java.lang.String,manifold.api.util.cache.FqnCache<manifold.api.fs.IFile>> resByExt, manifold.rt.api.Bindings bindings, ExecutionEnv executionEnv, java.util.function.Function<java.lang.String,java.lang.String> exprHandler) Type-safe access to configuration from .dbconfig files.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getBuildUrl() (Optional) JDBC URL for database (build time).
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
int	hashCode()
void	init(java.sql.Connection connection, ExecutionEnv env)
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:.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface manifold.sql.rt.api.DbConfig

getBuildUrlOtherwiseRuntimeUrl, toProperties

Field Detail

EMPTY

public static final DbConfig EMPTY

Constructor Detail

DbConfigImpl

public DbConfigImpl(java.util.function.Function<java.lang.String,manifold.api.util.cache.FqnCache<manifold.api.fs.IFile>> resByExt,
                    manifold.rt.api.Bindings bindings,
                    ExecutionEnv executionEnv)

DbConfigImpl

public DbConfigImpl(java.util.function.Function<java.lang.String,manifold.api.util.cache.FqnCache<manifold.api.fs.IFile>> resByExt,
                    manifold.rt.api.Bindings bindings,
                    ExecutionEnv executionEnv,
                    java.util.function.Function<java.lang.String,java.lang.String> exprHandler)

Type-safe access to configuration from .dbconfig files.

Parameters:

bindings - JSON bindings from a .dbconfig file

exprHandler - An optional handler to evaluate expressions in URL fields

DbConfigImpl

public DbConfigImpl(manifold.rt.api.Bindings bindings,
                    ExecutionEnv executionEnv)

For testing only!!

Method Detail

init

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

Specified by:

init in interface DbConfig

Throws:

java.sql.SQLException

getName

public java.lang.String getName()

Description copied from interface: DbConfig

(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.

Specified by:

getName in interface DbConfig

getCatalogName

public java.lang.String getCatalogName()

Description copied from interface: DbConfig

(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.

Specified by:

getCatalogName in interface DbConfig

getSchemaName

public java.lang.String getSchemaName()

Description copied from interface: DbConfig

(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.

Specified by:

getSchemaName in interface DbConfig

getPath

public java.lang.String getPath()

Description copied from interface: DbConfig

(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.

Specified by:

getPath in interface DbConfig

getUrl

public java.lang.String getUrl()

Description copied from interface: DbConfig

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

Specified by:

getUrl in interface DbConfig

getBuildUrl

public java.lang.String getBuildUrl()

Description copied from interface: DbConfig

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

Specified by:

getBuildUrl in interface DbConfig

getUser

public java.lang.String getUser()

Description copied from interface: DbConfig

(Optional) Username for database account

Specified by:

getUser in interface DbConfig

getPassword

public java.lang.String getPassword()

Description copied from interface: DbConfig

(Optional) Password for database account

Specified by:

getPassword in interface DbConfig

isDefault

public boolean isDefault()

Description copied from interface: DbConfig

(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 ..."

Specified by:

isDefault in interface DbConfig

getSchemaPackage

public java.lang.String getSchemaPackage()

Description copied from interface: DbConfig

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

This property is used exclusively for compile time.

Specified by:

getSchemaPackage in interface DbConfig

getProperties

public manifold.rt.api.Bindings getProperties()

Description copied from interface: DbConfig

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

Specified by:

getProperties in interface DbConfig

getDbDdl

public java.lang.String getDbDdl()

Description copied from interface: DbConfig

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

Specified by:

getDbDdl in interface DbConfig

getCustomBaseInterface

public java.lang.String getCustomBaseInterface()

Description copied from interface: DbConfig

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

Specified by:

getCustomBaseInterface in interface DbConfig

getCustomBaseClass

public java.lang.String getCustomBaseClass()

Description copied from interface: DbConfig

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

Specified by:

getCustomBaseClass in interface DbConfig

isInMemory

public boolean isInMemory()

Description copied from interface: DbConfig

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

Specified by:

isInMemory in interface DbConfig

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object