Skip navigation links
A B C D E F G H I J M N O P Q R S T U V W 

A

AbstractJdbcColumnType<J,C> - Class in io.spine.server.storage.jdbc.type
The implementation base for the JDBC-storage ColumnTypes.
AbstractJdbcColumnType() - Constructor for class io.spine.server.storage.jdbc.type.AbstractJdbcColumnType
 
AbstractQuery - Class in io.spine.server.storage.jdbc.query
The implementation base for the queries to an SQL-compliant database.
AbstractQuery(AbstractQuery.Builder<? extends AbstractQuery.Builder, ? extends StorageQuery>) - Constructor for class io.spine.server.storage.jdbc.query.AbstractQuery
 
AbstractQuery.Builder<B extends AbstractQuery.Builder<B,Q>,Q extends AbstractQuery> - Class in io.spine.server.storage.jdbc.query
An abstract builder for queries.
AbstractTable<I,R,W> - Class in io.spine.server.storage.jdbc.query
A representation of an SQL table.
AbstractTable(String, IdColumn<I>, DataSourceWrapper, TypeMapping) - Constructor for class io.spine.server.storage.jdbc.query.AbstractTable
 
add(Type, String) - Method in class io.spine.server.storage.jdbc.TypeMappingBuilder
Adds a mapping for the specified type.
addBatch(SQLUpdateClause) - Method in class io.spine.server.storage.jdbc.message.UpdateMessagesInBulk
 
addParameter(String, Parameter) - Method in class io.spine.server.storage.jdbc.query.Parameters.Builder
Adds a parameters with the specified identifier.
addParameters(Parameters) - Method in class io.spine.server.storage.jdbc.query.Parameters.Builder
Adds parameters with identifiers to the builder.
aliasedComparablePathOf(TableColumn, Class<T>) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
aliasedPathOf(TableColumn) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 

B

basicBuilder() - Static method in class io.spine.server.storage.jdbc.TypeMappingBuilder
Obtains the basic builder for mappings.
build() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Builds a config.
build() - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Returns a new instance of JdbcStorageFactory.
build() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Creates a new instance of the StorageQuery with respect to the preconditions.
build() - Method in class io.spine.server.storage.jdbc.query.Parameters.Builder
Returns the assembled Parameters.
build() - Method in class io.spine.server.storage.jdbc.StorageBuilder
Creates a new instance of the Storage with respect to the preconditions.
build() - Method in class io.spine.server.storage.jdbc.TypeMappingBuilder
Creates TypeMapping from the builder.
Builder() - Constructor for class io.spine.server.storage.jdbc.DataSourceConfig.Builder
 
Builder() - Constructor for class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage.Builder
 
Builder() - Constructor for class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry.Builder
 
Builder() - Constructor for class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
 
Builder() - Constructor for class io.spine.server.storage.jdbc.query.IdAwareQuery.Builder
 
Builder() - Constructor for class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery.Builder
 
bytesColumn() - Static method in class io.spine.server.storage.jdbc.message.MessageTable
Obtains a column responsible for storing serialized message bytes.
BytesColumn() - Constructor for class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 

C

checkPreconditions() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage.Builder
 
checkPreconditions() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
Checks the preconditions of the storage construction.
checkPreconditions() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Checks the preconditions of the query construction.
checkPreconditions() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
 
checkPreconditions() - Method in class io.spine.server.storage.jdbc.StorageBuilder
Checks the preconditions of the storage construction.
clause() - Method in class io.spine.server.storage.jdbc.message.UpdateMessagesInBulk
 
close() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
Closes the storage.
close() - Method in class io.spine.server.storage.jdbc.ConnectionWrapper
Wraps Connection.close() method.
close() - Method in class io.spine.server.storage.jdbc.DataSourceWrapper
Closes wrapped DataSource implementation if it implements AutoCloseable.
close() - Method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage
close() - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory
Closes used DataSourceWrapper.
close() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
close() - Method in class io.spine.server.storage.jdbc.query.DbIterator
Closes DbIterator.resultSet and the related Statement and Connection.
close() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
column() - Method in class io.spine.server.storage.jdbc.query.IdColumn
 
columnDefaults() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Obtains the map of column defaults for this table.
columnDefaults() - Method in class io.spine.server.storage.jdbc.query.EntityTable
 
columnName() - Method in class io.spine.server.storage.jdbc.query.IdColumn
 
ColumnReader<R> - Class in io.spine.server.storage.jdbc.query
A reader of the designated column value in the current row of the ResultSet.
ColumnReader(String) - Constructor for class io.spine.server.storage.jdbc.query.ColumnReader
Creates a new ColumnReader for the specified column.
ColumnReaderFactory - Class in io.spine.server.storage.jdbc.query
The factory which creates ColumnReader instances.
commit() - Method in class io.spine.server.storage.jdbc.ConnectionWrapper
Wraps Connection.commit() method.
comparablePathOf(TableColumn, Class<T>) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
composeInsertQuery(I, M) - Method in class io.spine.server.storage.jdbc.message.MessageTable
 
composeInsertQuery(I, W) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
composeSelectQuery(I) - Method in class io.spine.server.storage.jdbc.message.MessageTable
 
composeSelectQuery(I) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
composeUpdateQuery(I, M) - Method in class io.spine.server.storage.jdbc.message.MessageTable
 
composeUpdateQuery(I, W) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
ConnectionWrapper - Class in io.spine.server.storage.jdbc
The wrapper for Connection instances.
containsRecord(I) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Checks if the table contains a record with given ID.
convertColumnValue(T) - Method in class io.spine.server.storage.jdbc.type.SimpleJdbcColumnType
 
create() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Creates current table in the database if it does not exist yet.
createAggregateStorage(ContextSpec, Class<? extends Aggregate<I, ?, ?>>) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory
 
createInboxStorage(boolean) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory
 
createProjectionStorage(ContextSpec, Class<? extends Projection<I, ?, ?>>) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory
 
createRecordStorage(ContextSpec, Class<? extends Entity<I, ?>>) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory
 

D

DatabaseException - Exception in io.spine.server.storage.jdbc
Signals that an error occurred during an interaction with the DB.
DatabaseException(Throwable) - Constructor for exception io.spine.server.storage.jdbc.DatabaseException
 
DatabaseException(String, Throwable) - Constructor for exception io.spine.server.storage.jdbc.DatabaseException
 
dataSource() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
DataSourceConfig - Class in io.spine.server.storage.jdbc
The configuration object for an underlying DataSource or Driver implementation and a connection pool.
DataSourceConfig.Builder - Class in io.spine.server.storage.jdbc
The builder for DataSourceConfig.
DataSourceWrapper - Class in io.spine.server.storage.jdbc
Wrapper for DataSource instances.
DataSourceWrapper(DataSource) - Constructor for class io.spine.server.storage.jdbc.DataSourceWrapper
 
DbIterator<R> - Class in io.spine.server.storage.jdbc.query
An iterator over a ResultSet of storage records.
DbIterator.DoubleColumnRecord<A,B> - Class in io.spine.server.storage.jdbc.query
A holder of a pair of column values for the simultaneous iteration over a ResultSet.
defaultInstance() - Static method in class io.spine.server.storage.jdbc.type.JdbcTypeRegistryFactory
Retrieves a default ColumnTypeRegistry<? extends JdbcColumnType>.
delete(I) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
delete(I) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Deletes a row in the table corresponding to the given ID.
delete(I) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
deleteAll() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Deletes all the records from the table.
doBuild() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage.Builder
 
doBuild() - Method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage.Builder
 
doBuild() - Method in class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry.Builder
 
doBuild() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
 
doBuild() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Builds a new instance of the query.
doBuild() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
 
doBuild() - Method in class io.spine.server.storage.jdbc.StorageBuilder
Builds a new instance of the Storage.

E

empty() - Static method in class io.spine.server.storage.jdbc.query.Parameters
Creates empty Parameters.
EntityTable<I,R,W> - Class in io.spine.server.storage.jdbc.query
A common base for the storage tables, that are used to maintain entities.
EntityTable(Class<? extends Entity<I, ?>>, TableColumn, DataSourceWrapper, TypeMapping) - Constructor for class io.spine.server.storage.jdbc.query.EntityTable
Creates a new instance of the EntityTable.
EntityTable(String, Class<? extends Entity<I, ?>>, TableColumn, DataSourceWrapper, TypeMapping) - Constructor for class io.spine.server.storage.jdbc.query.EntityTable
Creates a new instance of the EntityTable.
execute() - Method in class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery
Executes a query, obtains a serialized message and deserializes it.
execute() - Method in interface io.spine.server.storage.jdbc.query.SelectQuery
Executes the query and returns the result.
execute() - Method in interface io.spine.server.storage.jdbc.query.WriteQuery
Executes a write query and return the amount of affected rows.

F

factory() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
Obtains a factory to compose the query.
first() - Method in class io.spine.server.storage.jdbc.query.DbIterator.DoubleColumnRecord
 

G

get() - Method in class io.spine.server.storage.jdbc.ConnectionWrapper
Returns the wrapped connection object.
getAggregateClass() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage.Builder
 
getAutoCommit() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getColumnTypeRegistry() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
 
getConnection(boolean) - Method in class io.spine.server.storage.jdbc.DataSourceWrapper
Retrieves a wrapped connection with the given auto commit mode.
getConnectionTestQuery() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getConnectionTestQuery() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getConnectionTimeout() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getConnectionTimeout() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getDataSource() - Method in class io.spine.server.storage.jdbc.StorageBuilder
 
getDataSourceClassName() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getDataSourceClassName() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getEntityClass() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
 
getIdentifiers() - Method in class io.spine.server.storage.jdbc.query.Parameters
Obtains a set of parameter identifiers.
getIdleTimeout() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getIdleTimeout() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getJdbcUrl() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getJdbcUrl() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getMaxLifetime() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getMaxLifetime() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getMaxPoolSize() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getMaxPoolSize() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getParameter(String) - Method in class io.spine.server.storage.jdbc.query.Parameters
Obtains a Parameter by the specified identifier.
getPassword() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getPassword() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getPoolName() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getPoolName() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getProjectionClass() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
 
getRecordStorage() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
 
getter() - Method in class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 
getter() - Method in interface io.spine.server.storage.jdbc.message.MessageTable.Column
 
getThis() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage.Builder
 
getThis() - Method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage.Builder
 
getThis() - Method in class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry.Builder
 
getThis() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
 
getThis() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Obtains typed reference to this.
getThis() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
 
getThis() - Method in class io.spine.server.storage.jdbc.StorageBuilder
Returns current instance of StorageBuilder.
getType() - Method in interface io.spine.server.storage.jdbc.type.JdbcColumnType
Obtains Type representing this column.
getTypeMapping() - Method in class io.spine.server.storage.jdbc.StorageBuilder
 
getUsername() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
getUsername() - Method in class io.spine.server.storage.jdbc.DataSourceConfig
getValue() - Method in class io.spine.server.storage.jdbc.query.Parameter
Obtains a raw value of the parameter.

H

hasNext() - Method in class io.spine.server.storage.jdbc.query.DbIterator
historyBackward(AggregateReadRequest<I>) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage

I

IdAwareQuery<I> - Class in io.spine.server.storage.jdbc.query
An abstract base for queries, which work with a single ID.
IdAwareQuery(IdAwareQuery.Builder<I, ? extends IdAwareQuery.Builder, ? extends IdAwareQuery>) - Constructor for class io.spine.server.storage.jdbc.query.IdAwareQuery
 
IdAwareQuery.Builder<I,B extends IdAwareQuery.Builder<I,B,Q>,Q extends IdAwareQuery<I>> - Class in io.spine.server.storage.jdbc.query
 
idColumn() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
idColumn() - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery
 
IdColumn<I> - Class in io.spine.server.storage.jdbc.query
A wrapper for the column which stores a primary key in a DB table.
idEquals() - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery
Returns a Predicate to check if the value of the ID column matches the stored set of IDs.
idReader(String, Class<I>) - Static method in class io.spine.server.storage.jdbc.query.ColumnReaderFactory
Creates a reader for the column storing index values.
index() - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
 
index() - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
Always throws an UnsupportedOperationException.
index() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
index() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Retrieves the table index.
index() - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
inIds(IdColumn<I>, Collection<I>) - Static method in class io.spine.server.storage.jdbc.query.QueryPredicates
Creates a predicate to match an ID to one of the specified IDs.
insert(I, W) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Inserts the record into the table using the specified ID.
insertWithId() - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery
 
intReader(String) - Static method in class io.spine.server.storage.jdbc.query.ColumnReaderFactory
 
io.spine.server.storage.jdbc - package io.spine.server.storage.jdbc
The API for the JDBC-based storage implementation.
io.spine.server.storage.jdbc.aggregate - package io.spine.server.storage.jdbc.aggregate
The JDBC-based implementation of the AggregateStorage.
io.spine.server.storage.jdbc.delivery - package io.spine.server.storage.jdbc.delivery
Contains the implementation of InboxStorage and other mechanisms of message delivery.
io.spine.server.storage.jdbc.message - package io.spine.server.storage.jdbc.message
This package contains the JdbcMessageStorage which enables storing of plain Protobuf messages to the database, and related classes.
io.spine.server.storage.jdbc.projection - package io.spine.server.storage.jdbc.projection
The JDBC-based implementation of the ProjectionStorage.
io.spine.server.storage.jdbc.query - package io.spine.server.storage.jdbc.query
This package contains the API for working with queries and common queries for different storages.
io.spine.server.storage.jdbc.record - package io.spine.server.storage.jdbc.record
The JDBC-based implementation of the RecordStorage.
io.spine.server.storage.jdbc.type - package io.spine.server.storage.jdbc.type
This package provides classes for JDBC column types.
isAutoCommit() - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
isMultitenant() - Method in class io.spine.server.storage.jdbc.StorageBuilder
 
isNullable() - Method in class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 
isNullable() - Method in interface io.spine.server.storage.jdbc.TableColumn
Returns true if this column may contain NULL values, false otherwise.
isPrimaryKey() - Method in class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 
isPrimaryKey() - Method in interface io.spine.server.storage.jdbc.TableColumn
Returns true is this column is a primary key of the table, false otherwise.

J

javaType() - Method in class io.spine.server.storage.jdbc.query.IdColumn
Retrieves the Java class of the ID before normalization.
JdbcAggregateStorage<I> - Class in io.spine.server.storage.jdbc.aggregate
The implementation of the aggregate storage based on the RDBMS.
JdbcAggregateStorage(JdbcAggregateStorage.Builder<I>) - Constructor for class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
Creates a new instance using the builder.
JdbcAggregateStorage.Builder<I> - Class in io.spine.server.storage.jdbc.aggregate
The builder for JdbcAggregateStorage.
JdbcColumnType<J,C> - Interface in io.spine.server.storage.jdbc.type
The contract of a ColumnType used by the JDBC storage.
JdbcInboxStorage - Class in io.spine.server.storage.jdbc.delivery
A JDBC-based implementation of the InboxStorage.
JdbcInboxStorage.Builder - Class in io.spine.server.storage.jdbc.delivery
 
JdbcMessageStorage<I,M extends com.google.protobuf.Message,R extends io.spine.server.storage.ReadRequest<I>,T extends MessageTable<I,M>> - Class in io.spine.server.storage.jdbc.message
A storage which stores plain messages in a single SQL table.
JdbcMessageStorage(boolean, T) - Constructor for class io.spine.server.storage.jdbc.message.JdbcMessageStorage
 
JdbcProjectionStorage<I> - Class in io.spine.server.storage.jdbc.projection
The implementation of the projection storage based on the RDBMS.
JdbcProjectionStorage(JdbcProjectionStorage.Builder<I>) - Constructor for class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
Creates a new instance using the builder.
JdbcProjectionStorage.Builder<I> - Class in io.spine.server.storage.jdbc.projection
The builder for JdbcProjectionStorage.
JdbcRecordStorage<I> - Class in io.spine.server.storage.jdbc.record
The implementation of the entity storage based on the RDBMS.
JdbcRecordStorage(JdbcRecordStorage.Builder<I>) - Constructor for class io.spine.server.storage.jdbc.record.JdbcRecordStorage
Creates a new instance using the builder.
JdbcRecordStorage.Builder<I> - Class in io.spine.server.storage.jdbc.record
The builder for JdbcRecordStorage.
JdbcShardedWorkRegistry - Class in io.spine.server.storage.jdbc.delivery
A JDBC-based implementation of the ShardedWorkRegistry.
JdbcShardedWorkRegistry.Builder - Class in io.spine.server.storage.jdbc.delivery
 
JdbcStorageFactory - Class in io.spine.server.storage.jdbc
Creates storages based on JDBC-compliant RDBMS.
JdbcStorageFactory.Builder - Class in io.spine.server.storage.jdbc
Builds instances of JdbcStorageFactory.
JdbcTypeRegistryFactory - Class in io.spine.server.storage.jdbc.type
A factory of the JDBC-specific ColumnTypeRegistries.

M

matchParameters(QueryParameters, ColumnTypeRegistry<? extends JdbcColumnType<? super Object, ? super Object>>) - Static method in class io.spine.server.storage.jdbc.query.QueryPredicates
Obtains a predicate to match entity records by the specified parameters.
messageDescriptor() - Method in class io.spine.server.storage.jdbc.message.MessageTable
Obtains a Descriptor of the stored message type.
messageReader(String, Descriptors.Descriptor) - Static method in class io.spine.server.storage.jdbc.query.ColumnReaderFactory
Creates a reader for the column storing serialized Protobuf messages.
messageSpecificColumns() - Method in class io.spine.server.storage.jdbc.message.MessageTable
Obtains columns specific to a concrete subtype of the MessageTable.
MessageTable<I,M extends com.google.protobuf.Message> - Class in io.spine.server.storage.jdbc.message
An SQL table storing a single Message type.
MessageTable(String, IdColumn<I>, DataSourceWrapper, TypeMapping) - Constructor for class io.spine.server.storage.jdbc.message.MessageTable
 
MessageTable.BytesColumn<M extends com.google.protobuf.Message> - Class in io.spine.server.storage.jdbc.message
A column responsible for storing serialized message bytes.
MessageTable.Column<M extends com.google.protobuf.Message> - Interface in io.spine.server.storage.jdbc.message
Represents a MessageTable column.
MessageTable.Column.Getter<M extends com.google.protobuf.Message> - Interface in io.spine.server.storage.jdbc.message
 

N

name() - Method in class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 
name() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
name() - Method in interface io.spine.server.storage.jdbc.TableColumn
Returns the name of the column.
newBuilder() - Static method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
Creates the builder for the storage.
newBuilder() - Static method in class io.spine.server.storage.jdbc.DataSourceConfig
Creates a new builder for DataSourceConfig.
newBuilder() - Static method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage
 
newBuilder() - Static method in class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry
 
newBuilder() - Static method in class io.spine.server.storage.jdbc.JdbcStorageFactory
 
newBuilder() - Static method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
Creates the builder for the storage.
newBuilder() - Static method in class io.spine.server.storage.jdbc.query.Parameters
Creates a builder for Parameters.
newBuilder() - Static method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
Creates the builder for the storage.
next() - Method in class io.spine.server.storage.jdbc.query.DbIterator
 
normalize(I) - Method in class io.spine.server.storage.jdbc.query.IdColumn
Normalizes the identifier before setting it to a Parameter.
normalize(Iterable<I>) - Method in class io.spine.server.storage.jdbc.query.IdColumn
Normalizes the specified IDs.

O

of(A, B) - Static method in class io.spine.server.storage.jdbc.query.DbIterator.DoubleColumnRecord
 
of(TableColumn) - Static method in class io.spine.server.storage.jdbc.query.IdColumn
Wraps a given ID column of a primitive type.
of(TableColumn, Class<I>) - Static method in class io.spine.server.storage.jdbc.query.IdColumn
Wraps a given ID column of Message type.
of(Object) - Static method in class io.spine.server.storage.jdbc.query.Parameter
Creates a parameter using the specified parameters.
ofEntityClass(TableColumn, Class<? extends Entity<I, ?>>) - Static method in class io.spine.server.storage.jdbc.query.IdColumn
Wraps a given Entity ID column.
orderBy(TableColumn, Order) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
over(ResultSet, ColumnReader<R>) - Static method in class io.spine.server.storage.jdbc.query.DbIterator
Creates a DbIterator over the given ResultSet.
over(ResultSet, ColumnReader<A>, ColumnReader<B>) - Static method in class io.spine.server.storage.jdbc.query.DbIterator
Creates a DbIterator for the simultaneous iteration over the entity records and their IDs in the ResultSet.

P

Parameter - Class in io.spine.server.storage.jdbc.query
A parameter of an SQL query.
Parameters - Class in io.spine.server.storage.jdbc.query
A query parameters with identifiers.
Parameters.Builder - Class in io.spine.server.storage.jdbc.query
A builder for Parameters.
pathOf(TableColumn) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
pathOf(IdColumn<?>) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
pathOf(String) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
pathOf(String, Class<T>) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
pickUp(ShardIndex, NodeId) - Method in class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry
 
PredefinedMapping - Enum in io.spine.server.storage.jdbc
Predefined type mappings for different databases.
predefinedValuesAnd() - Static method in class io.spine.server.storage.jdbc.type.JdbcTypeRegistryFactory
Retrieves a builder with all the predefined values set.
prepareStatement(String) - Method in class io.spine.server.storage.jdbc.ConnectionWrapper
Wraps Connection.prepareStatement(String) method.

Q

query() - Method in class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery
Obtains a query to get results.
QueryPredicates - Class in io.spine.server.storage.jdbc.query
A utility methods to work with predicates.

R

read(R) - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
 
read(I) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Reads a record with the given ID from the table.
readAll(ShardIndex) - Method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage
 
readAllRecords(ResponseFormat) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
readAllRecords(ResponseFormat) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
readAllRecords(EntityQuery<I>, ResponseFormat) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
readLastHandledEventTime() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
readLifecycleFlags(I) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
 
readMessage(ResultSet) - Method in class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery
Retrieves a message from a DB result set.
readMultipleRecords(Iterable<I>, FieldMask) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
readMultipleRecords(Iterable<I>, FieldMask) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
readRecord(I) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
Reads the record by the passed identifier.
readResult() - Method in class io.spine.server.storage.jdbc.query.DbIterator
 
readValue(ResultSet) - Method in class io.spine.server.storage.jdbc.query.ColumnReader
Reads the value of the designated column in the current row of the ResultSet.
recordStorage() - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
remove() - Method in class io.spine.server.storage.jdbc.query.DbIterator
Deprecated.
as unsupported
removeAll(Iterable<M>) - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
Removes the given messages from the storage.
resultSet() - Method in class io.spine.server.storage.jdbc.query.DbIterator
 
rollback() - Method in class io.spine.server.storage.jdbc.ConnectionWrapper
Wraps Connection.rollback() method.

S

second() - Method in class io.spine.server.storage.jdbc.query.DbIterator.DoubleColumnRecord
 
SelectMessageByIdQuery<I,M extends com.google.protobuf.Message> - Class in io.spine.server.storage.jdbc.query
A query which obtains a Message by an ID.
SelectMessageByIdQuery(SelectMessageByIdQuery.Builder<? extends SelectMessageByIdQuery.Builder, ? extends SelectMessageByIdQuery, I, M>) - Constructor for class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery
 
SelectMessageByIdQuery.Builder<B extends SelectMessageByIdQuery.Builder<B,Q,I,R>,Q extends SelectMessageByIdQuery<I,R>,I,R extends com.google.protobuf.Message> - Class in io.spine.server.storage.jdbc.query
 
SelectQuery<R> - Interface in io.spine.server.storage.jdbc.query
An interface for SELECT queries.
serialize(Message) - Static method in class io.spine.server.storage.jdbc.query.Serializer
Serializes a message to an array of bytes.
Serializer - Class in io.spine.server.storage.jdbc.query
A utility class for serializing/deserializing messages.
setAggregateClass(Class<? extends Aggregate<I, ?, ?>>) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage.Builder
Sets the class of aggregates to be stored.
setAutoCommit(Boolean) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the default auto-commit behavior of all connections.
setColumnTypeRegistry(ColumnTypeRegistry<? extends JdbcColumnType<? super Object, ? super Object>>) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Sets the ColumnTypeRegistry to use in the generated storages.
setColumnTypeRegistry(ColumnTypeRegistry<? extends JdbcColumnType<? super Object, ? super Object>>) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
Sets the column type registry.
setColumnValue(Parameters.Builder, C, String) - Method in class io.spine.server.storage.jdbc.type.AbstractJdbcColumnType
 
setConnectionTestQuery(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
If your driver supports JDBC4 it is strongly recommended not setting this property.
setConnectionTimeout(Long) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the maximum number of milliseconds to wait for a connection from the pool.
setDataSource(DataSourceWrapper) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Sets required field dataSource.
setDataSource(DataSource) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Sets required field dataSource from wrapped DataSource.
setDataSource(DataSourceConfig) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Sets required field dataSource from DataSourceConfig.
setDataSource(DataSourceWrapper) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Sets the data source to be used for query execution.
setDataSource(DataSourceWrapper) - Method in class io.spine.server.storage.jdbc.StorageBuilder
Sets the data source.
setDataSourceClassName(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the name of the class implementing DataSource provided by the JDBC driver.
setEntityClass(Class<? extends Entity<I, ?>>) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage.Builder
Sets the entity class.
setId(I) - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery.Builder
 
setId(String, I, Parameters.Builder) - Method in class io.spine.server.storage.jdbc.query.IdColumn
Sets an ID parameter to the given value.
setIdClause(SQLUpdateClause, I, M) - Method in class io.spine.server.storage.jdbc.message.UpdateMessagesInBulk
 
setIdColumn(IdColumn<I>) - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery.Builder
 
setIdleTimeout(Long) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the maximum amount of time that a connection is allowed to sit idle in the pool.
setJdbcUrl(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
This property directs the connection pool to use DriverManager-based configuration.
setMaxLifetime(Long) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the maximum lifetime of a connection in the pool.
setMaxPoolSize(Integer) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the maximum size that the pool is allowed to reach, including both idle and in-use connections.
setMessageColumnName(String) - Method in class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery.Builder
 
setMessageDescriptor(Descriptors.Descriptor) - Method in class io.spine.server.storage.jdbc.query.SelectMessageByIdQuery.Builder
 
setMultitenant(boolean) - Method in class io.spine.server.storage.jdbc.delivery.JdbcShardedWorkRegistry.Builder
 
setMultitenant(boolean) - Method in class io.spine.server.storage.jdbc.StorageBuilder
Specifies the multitenant behavior.
setNull(Parameters.Builder, String) - Method in class io.spine.server.storage.jdbc.type.AbstractJdbcColumnType
 
setPassword(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets the default authentication password used for obtaining Connections from the underlying driver.
setPoolName(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
Sets a name of the connection pool and appears mainly in logging and JMX management consoles to identify pools and pool configurations.
setProjectionClass(Class<? extends Projection<I, ?, ?>>) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
Sets the class of projections to be stored.
setReadBatchSize(int) - Method in class io.spine.server.storage.jdbc.delivery.JdbcInboxStorage.Builder
 
setRecordStorage(JdbcRecordStorage<I>) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage.Builder
Sets a RecordStorage to store projection instances.
setTableName(String) - Method in class io.spine.server.storage.jdbc.query.AbstractQuery.Builder
Sets the table name to use as a target for the query.
setTypeMapping(TypeMapping) - Method in class io.spine.server.storage.jdbc.JdbcStorageFactory.Builder
Sets TypeMapping, which defines Type names for the database used.
setTypeMapping(TypeMapping) - Method in class io.spine.server.storage.jdbc.StorageBuilder
Sets the type mapping schema.
setUsername(String) - Method in class io.spine.server.storage.jdbc.DataSourceConfig.Builder
This property sets the default authentication username used for obtaining Connections from the underlying driver.
SimpleJdbcColumnType<T> - Class in io.spine.server.storage.jdbc.type
An implementation base for the JdbcColumnTypes which store the given value "as is", i.e.
SimpleJdbcColumnType() - Constructor for class io.spine.server.storage.jdbc.type.SimpleJdbcColumnType
 
Sql - Class in io.spine.server.storage.jdbc
Set of enums and utilities for constructing the SQL sentences.
Sql.BuildingBlock - Enum in io.spine.server.storage.jdbc
Set of punctuation signs used in SQL: Operators: equal, not equal, comparison operators; Punctuation: comma, brackets, semicolon.
Sql.Function - Enum in io.spine.server.storage.jdbc
Set of SQL keywords representing 5 aggregating functions: MIN MAX COUNT AVG SUM
Sql.Query - Enum in io.spine.server.storage.jdbc
Set of basic SQL keywords/key-phrases for CRUD operations, predicate constructing, grouping and ordering, etc.
sqlType() - Method in class io.spine.server.storage.jdbc.query.IdColumn
Returns the Type of the column with which this helper instance works.
StorageBuilder<B extends StorageBuilder<B,S>,S extends io.spine.server.storage.Storage> - Class in io.spine.server.storage.jdbc
An abstract Builder for the JDBC-based Storage implementations.
StorageBuilder() - Constructor for class io.spine.server.storage.jdbc.StorageBuilder
 
StorageQuery - Interface in io.spine.server.storage.jdbc.query
A marker interface for an SQL query.

T

table() - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
 
table() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
Obtains the path of the target table for the query.
tableAlias() - Method in class io.spine.server.storage.jdbc.query.AbstractQuery
 
TableColumn - Interface in io.spine.server.storage.jdbc
An interface for the database table columns representation.
tableColumns() - Method in class io.spine.server.storage.jdbc.message.MessageTable
 
tableColumns() - Method in class io.spine.server.storage.jdbc.query.AbstractTable
 
toString() - Method in enum io.spine.server.storage.jdbc.Sql.BuildingBlock
 
toString() - Method in enum io.spine.server.storage.jdbc.Sql.Function
 
toString() - Method in enum io.spine.server.storage.jdbc.Sql.Query
 
truncate(int) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
 
truncate(int, Timestamp) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
 
type() - Method in class io.spine.server.storage.jdbc.message.MessageTable.BytesColumn
 
type() - Method in interface io.spine.server.storage.jdbc.TableColumn
Returns the Type of the column or null if the type is unknown at the compile time.
Type - Enum in io.spine.server.storage.jdbc
Data types used in the SQL tables of the project.
TypeMapping - Interface in io.spine.server.storage.jdbc
A Type-to-name mapping.
TypeMappingBuilder - Class in io.spine.server.storage.jdbc
A builder for type mappings.
TypeMappingBuilder() - Constructor for class io.spine.server.storage.jdbc.TypeMappingBuilder
 
typeNameFor(Type) - Method in enum io.spine.server.storage.jdbc.PredefinedMapping
 
typeNameFor(Type) - Method in interface io.spine.server.storage.jdbc.TypeMapping
Obtains the name of the specified Type.

U

update(I, W) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Updates the record with the specified ID for the table.
updateById() - Method in class io.spine.server.storage.jdbc.query.IdAwareQuery
 
UpdateMessagesInBulk<I,M extends com.google.protobuf.Message> - Class in io.spine.server.storage.jdbc.message
Updates multiple messages in the MessageTable in a bulk.

V

valueOf(String) - Static method in enum io.spine.server.storage.jdbc.PredefinedMapping
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.server.storage.jdbc.Sql.BuildingBlock
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.server.storage.jdbc.Sql.Function
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.server.storage.jdbc.Sql.Query
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.server.storage.jdbc.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.spine.server.storage.jdbc.PredefinedMapping
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.server.storage.jdbc.Sql.BuildingBlock
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.server.storage.jdbc.Sql.Function
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.server.storage.jdbc.Sql.Query
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.server.storage.jdbc.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(I, M) - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
 
write(M) - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
Writes a single message to the storage.
write(I, W) - Method in class io.spine.server.storage.jdbc.query.AbstractTable
Performs a write operation on the table.
writeAll(Iterable<M>) - Method in class io.spine.server.storage.jdbc.message.JdbcMessageStorage
Writes the given messages to the storage.
writeLastHandledEventTime(Timestamp) - Method in class io.spine.server.storage.jdbc.projection.JdbcProjectionStorage
 
writeLifecycleFlags(I, LifecycleFlags) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
 
WriteQuery - Interface in io.spine.server.storage.jdbc.query
A query which makes changes in a data source.
writeRecord(I, AggregateEventRecord) - Method in class io.spine.server.storage.jdbc.aggregate.JdbcAggregateStorage
writeRecord(I, EntityRecordWithColumns) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
writeRecords(Map<I, EntityRecordWithColumns>) - Method in class io.spine.server.storage.jdbc.record.JdbcRecordStorage
 
A B C D E F G H I J M N O P Q R S T U V W 
Skip navigation links