org.modeshape.persistence.relational

Class DefaultStatements

java.lang.Object

org.modeshape.persistence.relational.DefaultStatements

All Implemented Interfaces:

Statements

Direct Known Subclasses:

OracleStatements

public class DefaultStatements
extends Object
implements Statements

Default implementation for the Statements interface which applies to all databases.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultStatements.BatchOperation<T>
protected class	DefaultStatements.DefaultBatchUpdate

Nested classes/interfaces inherited from interface org.modeshape.persistence.relational.Statements

Statements.BatchUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger

Fields inherited from interface org.modeshape.persistence.relational.Statements

CONTENT_EXISTS, CREATE_TABLE, DELETE_TABLE, GET_ALL_IDS, GET_BY_ID, GET_MULTIPLE, INSERT_CONTENT, REMOVE_ALL_CONTENT, REMOVE_CONTENT, UPDATE_CONTENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultStatements(RelationalDbConfig config, Map<String,String> statements)

Method Summary

Modifier and Type	Method and Description
protected int	batchLoadSize()
DefaultStatements.DefaultBatchUpdate	batchUpdate(Connection connection) Starts a batch update operation with the given connection.
Void	createTable(Connection connection) Create a new table.
Void	dropTable(Connection connection) Drops a table.
boolean	exists(Connection connection, String id) Checks if there is a document with the given id.
List<String>	getAllIds(Connection connection) Returns all the ids from a table.
Document	getById(Connection connection, String id) Searches for a document with a certain id.
<R> List<R>	load(Connection connection, List<String> ids, Function<Document,R> parser) Loads multiple documents based on a set of ids.
protected void	logTableInfo(String message)
protected Document	readDocument(InputStream is)
Void	removeAll(Connection connection) Removes all the contents of a table.
protected String	tableName()
protected byte[]	writeDocument(Document content)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Logger logger

Constructor Detail

DefaultStatements

protected DefaultStatements(RelationalDbConfig config,
                            Map<String,String> statements)

Method Detail

createTable

public Void createTable(Connection connection)
                 throws SQLException

Description copied from interface: Statements

Create a new table.

Specified by:

createTable in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.

dropTable

public Void dropTable(Connection connection)
               throws SQLException

Description copied from interface: Statements

Drops a table.

Specified by:

dropTable in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.

getAllIds

public List<String> getAllIds(Connection connection)
                       throws SQLException

Description copied from interface: Statements

Returns all the ids from a table.

Specified by:

getAllIds in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

a List of ids; never null

Throws:

SQLException - if the operation fails.

getById

public Document getById(Connection connection,
                        String id)
                 throws SQLException

Description copied from interface: Statements

Searches for a document with a certain id.

Specified by:

getById in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

a Document instance or null if the document is not found.

Throws:

SQLException - if the operation fails.

load

public <R> List<R> load(Connection connection,
                        List<String> ids,
                        Function<Document,R> parser)
                 throws SQLException

Description copied from interface: Statements

Loads multiple documents based on a set of ids.

Depending on the type of DB, if a very large number of IDs is used this may have side effects:

• MySQL: limited by the max_allowed_packet value.
• SQL Server: "limited by 65,536 * Network Packet Size" (which defaults to 4K).
• Oracle has an expression limit of 1000 values.
• PostgreSQL apparently slows dramatically with lots of values.

Specified by:

load in interface Statements

Parameters:

connection - a Connection instance; may not be null

ids - a List of ids; may not be null

parser - a Function which is used to transform or process each of documents corresponding to the given IDS; may not be null

Returns:

a List of Object instances for each of the ids which were found in the DB; never null

Throws:

SQLException - if the operation fails.

batchUpdate

public DefaultStatements.DefaultBatchUpdate batchUpdate(Connection connection)

Description copied from interface: Statements

Starts a batch update operation with the given connection.

Specified by:

batchUpdate in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

a Statements.BatchUpdate instance, never null

exists

public boolean exists(Connection connection,
                      String id)
               throws SQLException

Description copied from interface: Statements

Checks if there is a document with the given id.

Specified by:

exists in interface Statements

Parameters:

connection - a Connection instance; may not be null

id - a String the id of a document; may not be null

Returns:

true if the document exists, false otherwise.

Throws:

SQLException - if the operation fails.

removeAll

public Void removeAll(Connection connection)
               throws SQLException

Description copied from interface: Statements

Removes all the contents of a table.

Specified by:

removeAll in interface Statements

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.

batchLoadSize

protected int batchLoadSize()

logTableInfo

protected void logTableInfo(String message)

tableName

protected String tableName()

readDocument

protected Document readDocument(InputStream is)

writeDocument

protected byte[] writeDocument(Document content)