org.modeshape.persistence.relational

Interface Statements

All Known Implementing Classes:

DefaultStatements, OracleStatements

public interface Statements

A group of statements which are executed against a database.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Statements.BatchUpdate A batch of table update operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_EXISTS
static String	CREATE_TABLE A set of constants representing keys in the statements properties files, for each of the DB statements
static String	DELETE_TABLE
static String	GET_ALL_IDS
static String	GET_BY_ID
static String	GET_MULTIPLE
static String	INSERT_CONTENT
static String	REMOVE_ALL_CONTENT
static String	REMOVE_CONTENT
static String	UPDATE_CONTENT

Method Summary

Modifier and Type	Method and Description
Statements.BatchUpdate	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.
Void	removeAll(Connection connection) Removes all the contents of a table.

Field Detail

CREATE_TABLE

static final String CREATE_TABLE

A set of constants representing keys in the statements properties files, for each of the DB statements

See Also:

Constant Field Values

DELETE_TABLE

static final String DELETE_TABLE

See Also:

Constant Field Values

GET_ALL_IDS

static final String GET_ALL_IDS

See Also:

Constant Field Values

GET_BY_ID

static final String GET_BY_ID

See Also:

Constant Field Values

CONTENT_EXISTS

static final String CONTENT_EXISTS

See Also:

Constant Field Values

INSERT_CONTENT

static final String INSERT_CONTENT

See Also:

Constant Field Values

UPDATE_CONTENT

static final String UPDATE_CONTENT

See Also:

Constant Field Values

REMOVE_CONTENT

static final String REMOVE_CONTENT

See Also:

Constant Field Values

REMOVE_ALL_CONTENT

static final String REMOVE_ALL_CONTENT

See Also:

Constant Field Values

GET_MULTIPLE

static final String GET_MULTIPLE

See Also:

Constant Field Values

Method Detail

createTable

Void createTable(Connection connection)
          throws SQLException

Create a new table.

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.

dropTable

Void dropTable(Connection connection)
        throws SQLException

Drops a table.

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.

getAllIds

List<String> getAllIds(Connection connection)
                throws SQLException

Returns all the ids from a table.

Parameters:

connection - a Connection instance; may not be null

Returns:

a List of ids; never null

Throws:

SQLException - if the operation fails.

getById

Document getById(Connection connection,
                 String id)
          throws SQLException

Searches for a document with a certain id.

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

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

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.

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

Statements.BatchUpdate batchUpdate(Connection connection)

Starts a batch update operation with the given connection.

Parameters:

connection - a Connection instance; may not be null

Returns:

a Statements.BatchUpdate instance, never null

exists

boolean exists(Connection connection,
               String id)
        throws SQLException

Checks if there is a document with the given id.

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

Void removeAll(Connection connection)
        throws SQLException

Removes all the contents of a table.

Parameters:

connection - a Connection instance; may not be null

Returns:

nothing

Throws:

SQLException - if the operation fails.