io.inversion.jdbc

Class JdbcDb

java.lang.Object

io.inversion.Rule<T>

io.inversion.Db<JdbcDb>

io.inversion.jdbc.JdbcDb

All Implemented Interfaces:

java.lang.Comparable<JdbcDb>

public class JdbcDb
extends io.inversion.Db<JdbcDb>

Exposes the tables of a JDBC data source as REST Collections.

Nested Class Summary

Nested classes/interfaces inherited from class io.inversion.Rule

io.inversion.Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoCommit Should the JDBC connection be set to autoCommit.
protected boolean	calcRowsFound For MySQL only, set this to false to turn off SQL_CALC_FOUND_ROWS and SELECT FOUND_ROWS()
protected char	columnQuote
protected java.util.List<java.lang.String>	ddlUrls Urls to DDL files that should be executed on startup of this Db.
protected java.lang.String	driver The JDBC driver class name.
protected int	idleConnectionTestPeriod
protected java.lang.String	pass The JDBC password.
protected int	poolMax The maximum number of connections in the JDBC Connection pool, defaults to 50.
protected char	stringQuote
protected java.lang.String	url The JDBC url.
protected java.lang.String	user The JDBC username.

Fields inherited from class io.inversion.Db

bootstrap, collections, dryRun, excludeColumns, includeColumns, includeTables, log, reservedParams, type

Fields inherited from class io.inversion.Rule

ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, name, order, params

Constructor Summary

Constructors

Constructor and Description
JdbcDb()
JdbcDb(java.lang.String name)
JdbcDb(java.lang.String url, java.lang.String user, java.lang.String pass)
JdbcDb(java.lang.String name, java.lang.String driver, java.lang.String url, java.lang.String user, java.lang.String pass, java.lang.String... ddlUrls)

Method Summary

Modifier and Type	Method and Description
void	buildCollections()
protected javax.sql.DataSource	createConnectionPool()
void	doDelete(io.inversion.Collection table, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> columnMappedIndexValues)
java.util.List<java.lang.String>	doPatch(io.inversion.Collection table, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows)
io.inversion.Results	doSelect(io.inversion.Collection coll, java.util.List<io.inversion.rql.Term> columnMappedTerms)
protected void	doShutdown()
protected void	doStartup(io.inversion.Api api)
java.util.List<java.lang.String>	doUpsert(io.inversion.Collection table, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows)
java.sql.Connection	getConnection() Shortcut for getConnection(true);
java.sql.Connection	getConnection(boolean managed) Returns a JDBC connection to the underlying JDBC db.
protected java.sql.Connection	getConnection0(boolean managed)
java.lang.String	getDriver()
int	getIdleConnectionTestPeriod()
java.lang.String	getPass()
int	getPoolMax()
java.lang.String	getType()
java.lang.String	getUrl()
java.lang.String	getUser()
boolean	isAutoCommit()
java.lang.String	quoteCol(java.lang.String columnName)
java.lang.String	quoteStr(java.lang.String string)
void	setIdleConnectionTestPeriod(int idleConnectionTestPeriod)
void	setPoolMax(int poolMax)
JdbcDb	withAutoCommit(boolean autoCommit)
JdbcDb	withColumnQuote(char columnQuote)
JdbcDb	withConfig(java.lang.String driver, java.lang.String url, java.lang.String user, java.lang.String pass)
JdbcDb	withDdlUrl(java.lang.String... ddlUrl)
JdbcDb	withDriver(java.lang.String driver)
JdbcDb	withPass(java.lang.String pass)
JdbcDb	withStringQuote(char stringQuote)
JdbcDb	withType(java.lang.String type)
JdbcDb	withUrl(java.lang.String url)
JdbcDb	withUser(java.lang.String user)

Methods inherited from class io.inversion.Db

beautifyCollectionName, beautifyName, buildRelationships, castDbOutput, castJsonInput, castJsonInput, configApi, configDb, delete, doShutdown, excludeTable, filterOutJsonProperty, getCollection, getCollectionByTableName, getCollections, getProperty, isBootstrap, isDryRun, isRunning, isType, makeRelationshipName, mapToColumnNames, mapToColumnNames, mapToJsonNames, patch, removeCollection, select, shutdown, shutdown, startup, upsert, withBootstrap, withCollection, withCollections, withDryRun, withExcludeColumns, withIncludeColumns, withIncludeTable, withIncludeTables

Methods inherited from class io.inversion.Rule

afterWiringComplete, checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludeMethods, getAllIncludePaths, getDefaultIncludeMatchers, getDescription, getExcludeMatchers, getIncludeMatchers, getName, getOrder, getParams, match, match, matches, matches, toString, withDescription, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withName, withOrder, withParam, withParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ddlUrls

protected final java.util.List<java.lang.String> ddlUrls

Urls to DDL files that should be executed on startup of this Db.

stringQuote

protected char stringQuote

columnQuote

protected char columnQuote

driver

protected java.lang.String driver

The JDBC driver class name.

url

protected java.lang.String url

The JDBC url.

Generally you will want to have this value dependency inject this at runtime by setting "${name}.url=${MY_DB_URL}" somewhere where it can be discovered by Config...for example as an environment variable or in an inversion.properties file.

See Also:

Config, Configuration

user

protected java.lang.String user

The JDBC username.

Generally you will want to have this value dependency inject this at runtime by setting "${name}.user=${MY_DB_USER_NAME}" somewhere where it can be discovered by Config...for example as an environment variable or in an inversion.properties file.

See Also:

Config, Configuration

pass

protected java.lang.String pass

The JDBC password.

Generally you will want to have this value dependency inject this at runtime by setting "${name}.user=${MY_DB_USER_NAME}" somewhere where it can be discovered by Config...for example as an environment variable or in an inversion.properties file.

See Also:

Config, Configuration

poolMax

protected int poolMax

The maximum number of connections in the JDBC Connection pool, defaults to 50.

idleConnectionTestPeriod

protected int idleConnectionTestPeriod

autoCommit

protected boolean autoCommit

Should the JDBC connection be set to autoCommit.

By default, autoCommit is false because the system is setup to execute all sql statements for a single Request inside of one transaction that commits just before the root Response is returned to the caller.

calcRowsFound

protected boolean calcRowsFound

For MySQL only, set this to false to turn off SQL_CALC_FOUND_ROWS and SELECT FOUND_ROWS()

Constructor Detail

JdbcDb

public JdbcDb()

JdbcDb

public JdbcDb(java.lang.String name)

JdbcDb

public JdbcDb(java.lang.String name,
              java.lang.String driver,
              java.lang.String url,
              java.lang.String user,
              java.lang.String pass,
              java.lang.String... ddlUrls)

JdbcDb

public JdbcDb(java.lang.String url,
              java.lang.String user,
              java.lang.String pass)

Method Detail

doStartup

protected void doStartup(io.inversion.Api api)

Overrides:

doStartup in class io.inversion.Db<JdbcDb>

doShutdown

protected void doShutdown()

Overrides:

doShutdown in class io.inversion.Db<JdbcDb>

getType

public java.lang.String getType()

Overrides:

getType in class io.inversion.Db<JdbcDb>

doSelect

public io.inversion.Results doSelect(io.inversion.Collection coll,
                                     java.util.List<io.inversion.rql.Term> columnMappedTerms)
                              throws io.inversion.ApiException

Overrides:

doSelect in class io.inversion.Db<JdbcDb>

Throws:

io.inversion.ApiException

doUpsert

public java.util.List<java.lang.String> doUpsert(io.inversion.Collection table,
                                                 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows)
                                          throws io.inversion.ApiException

Overrides:

doUpsert in class io.inversion.Db<JdbcDb>

Throws:

io.inversion.ApiException

doPatch

public java.util.List<java.lang.String> doPatch(io.inversion.Collection table,
                                                java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows)
                                         throws io.inversion.ApiException

Overrides:

doPatch in class io.inversion.Db<JdbcDb>

Throws:

io.inversion.ApiException

doDelete

public void doDelete(io.inversion.Collection table,
                     java.util.List<java.util.Map<java.lang.String,java.lang.Object>> columnMappedIndexValues)
              throws io.inversion.ApiException

Overrides:

doDelete in class io.inversion.Db<JdbcDb>

Throws:

io.inversion.ApiException

getConnection

public java.sql.Connection getConnection()
                                  throws io.inversion.ApiException

Shortcut for getConnection(true);

Returns:

a connection

Throws:

io.inversion.ApiException

getConnection

public java.sql.Connection getConnection(boolean managed)
                                  throws io.inversion.ApiException

Returns a JDBC connection to the underlying JDBC db.

If managed is true the Connection is shared on the ThreadLocal with autoCommit managed by this Db and an EngineListener. Callers should NOT close this connection. It will not create a connection pool leak. All managed connections attached to the ThreadLocal are closed/returned to the pool when the Engine finishes serving a s Request.

If managed is false, a completely new Connection is returned.

Parameters:

managed - should this be a net new collection or a pool connection that is automatically closed when the Request ends

Returns:

a Connection

Throws:

io.inversion.ApiException

getConnection0

protected java.sql.Connection getConnection0(boolean managed)
                                      throws io.inversion.ApiException

Throws:

io.inversion.ApiException

createConnectionPool

protected javax.sql.DataSource createConnectionPool()
                                             throws java.lang.Exception

Throws:

java.lang.Exception

buildCollections

public void buildCollections()
                      throws io.inversion.ApiException

Overrides:

buildCollections in class io.inversion.Db<JdbcDb>

Throws:

io.inversion.ApiException

withType

public JdbcDb withType(java.lang.String type)

Overrides:

withType in class io.inversion.Db<JdbcDb>

withConfig

public JdbcDb withConfig(java.lang.String driver,
                         java.lang.String url,
                         java.lang.String user,
                         java.lang.String pass)

getDriver

public java.lang.String getDriver()

withDriver

public JdbcDb withDriver(java.lang.String driver)

getUrl

public java.lang.String getUrl()

withUrl

public JdbcDb withUrl(java.lang.String url)

getUser

public java.lang.String getUser()

withUser

public JdbcDb withUser(java.lang.String user)

getPass

public java.lang.String getPass()

withPass

public JdbcDb withPass(java.lang.String pass)

getPoolMax

public int getPoolMax()

setPoolMax

public void setPoolMax(int poolMax)

getIdleConnectionTestPeriod

public int getIdleConnectionTestPeriod()

setIdleConnectionTestPeriod

public void setIdleConnectionTestPeriod(int idleConnectionTestPeriod)

withStringQuote

public JdbcDb withStringQuote(char stringQuote)

withColumnQuote

public JdbcDb withColumnQuote(char columnQuote)

quoteCol

public java.lang.String quoteCol(java.lang.String columnName)

quoteStr

public java.lang.String quoteStr(java.lang.String string)

withDdlUrl

public JdbcDb withDdlUrl(java.lang.String... ddlUrl)

isAutoCommit

public boolean isAutoCommit()

withAutoCommit

public JdbcDb withAutoCommit(boolean autoCommit)