All Classes and Interfaces
Class
Description
Extension of
AbstractMetamodel that implements Metamodel.Key, indicating that the field has a
uniqueness constraint.Implementation that is used by the generated models.
Base implementation for generated navigation-only metamodels — nodes that navigate the entity graph beyond a
Ref foreign key.Marker interface used within an SQL template to indicate where bind variables (parameters) should be injected.
A listener for record events within a SQL query context.
Builds the Java facade over an engine template builder.
Represents metadata about a single column in a database table, as derived from the entity or projection model.
Represents a column in a database table.
Resolves the column name for a record component.
Declares how a
Converter should be applied.Converts between an entity value type and a database column type.
Encodes and decodes a single scalar value for cursor serialization.
A cursor codec registration entry, binding a tag, Java type, and codec together.
Service provider interface for registering custom cursor codecs.
Marker interface for record-based data classes.
Specifies the name of the database column.
Annotation for specifying multiple database column names, e.g., for compound keys.
Specifies how an enum should be mapped when reading or writing to a column.
Suppresses schema validation for the annotated entity type or record component.
Specifies the name of the database table or view, and optionally its schema.
Default implementation of the
JoinType interface used to represent the default join types.Defines how dirty checking is performed for an entity.
Configures discriminator behavior for sealed type hierarchies.
The discriminator column types supported for sealed type hierarchies.
Configures how changes are detected and how UPDATE statements are generated for a specific entity.
Represents an element in a ST/ORM SQL query.
Verifies that the engine backing this API is on the runtime classpath.
Optional marker interface for record-based entities.
Typed callback interface for entity lifecycle events.
Declares the
EntityCallback types that apply to the annotated entity.Provides a generic interface with CRUD operations for entities.
Defines the strategy to use when mapping enums.
Describes the execution context in which a failure occurred.
Maps failures raised during query execution to the runtime exception thrown to the caller.
Marks a field as a foreign key.
Resolves the column name for a foreign key component.
Indicates that a metamodel class should be generated for the annotated record or data class.
Defines the strategy to use when generating values for primary keys.
Thrown when a transaction block cannot open against the transaction state it finds:
MANDATORY without
a transaction, NEVER inside one, or a joining block that states a stricter isolation level than the
transaction it joins runs at.Indicates that the underlying fields of the record component are inlined in this record.
Constructs record instances without reflection.
Thrown when a cursor string cannot be turned into a position: it is malformed, was issued by an earlier cursor
format, was issued for another ordering or codec registry, or carries a value of the wrong type.
A builder for specifying the ON condition of a JOIN clause using a custom string template expression.
Represents a join type in a SQL query.
Marks a record component as a json object.
The metamodel provides type-safe references to entity fields for use in queries.
Marker interface for metamodel fields that correspond to columns known to be unique.
Delegating wrapper that adds the
Metamodel.Key marker to an existing Metamodel instance.Marks an annotation type to be represented as the specified type in the
Metamodel.Provides metadata about an entity or projection type, including its table name, primary key type, and column
definitions.
Represents the model of an entity.
The navigational part of a
Metamodel: everything needed to locate a field within the entity graph and use it
in a query (filter, join, order, group, select), without exposing value extraction.Thrown when
getSingleResult is executed on a query and there is more than one result from the query.Thrown when
getSingleResult is executed on a query and there is no result to return.Represents a comparison operator in a SQL query.
Thrown when an optimistic locking conflict occurs.
A sort order for one metamodel field.
The primary entry point for Storm's ORM functionality, combining SQL template query construction with
repository access.
Builder for constructing an
ORMTemplate with instance-scoped integration strategies.Represents a page of query results for offset-based pagination.
Represents a pagination request with a zero-based page number, page size, and optional sort orders.
Allows the persistence properties of a record component to be configured.
Thrown when a database or sql problem occurs.
Marks a field as the primary key of an entity.
Specifies the inheritance strategy for a sealed entity hierarchy.
The inheritance strategies for sealed entity hierarchies.
The row a scroll request continues from, and on which side of it.
Represents a composable predicate for the WHERE clause of a query, supporting
AND and OR composition.Represents an eagerly constructed, reusable query that supports batch operations and generated key retrieval.
Marker interface for record-based projections.
Projection records marked with this annotation type can specify a SQL query that represents the projection.
Provides a generic interface with read operations for projections.
Represents a constructed SQL statement that is ready for execution.
A fluent builder for constructing type-safe SELECT and DELETE queries using the entity graph and metamodel.
Describes a single statement execution observed by a
QueryObserver.Classifies how a statement is executed.
Observes query executions performed by an ORM template.
Tracks a single observed statement execution.
Tracks a single observed physical transaction.
Provides methods for constructing SQL queries and query builders using String Templates or the fluent API.
Thrown when a statement Storm recognises as a write, an
INSERT, UPDATE or DELETE, is
executed inside a read-only transaction.Represents metadata about a field in a data record type.
Represents metadata about a data record type.
Ref records are used to represent reference to records, allowing them to be fetched from the database.
Base interface for all Storm repositories, providing access to the underlying
ORMTemplate.Provides access to repositories.
Enumeration of the different modes for resolving an alias.
Resolves the schema a table lives in, per template.
A scroll request: an ordering, a window size, and the position to continue from.
Specifies how much data a query should select for an entity or projection.
Contributes a comment appended to SQL statements at execution time.
Records the statements a call executes, so a unit of work can be judged by what it cost the database.
A scope opened with
SqlLog.open(java.lang.String), reporting its summary once closed.Represents the SQL mode.
Thrown to indicate an error occurred while processing a SQL template.
Classifies what caused a statement to execute.
Immutable, untyped configuration for the Storm ORM framework.
Provides factory methods for constructing subqueries that can be correlated with or embedded in an outer query.
Resolves the table name for a given record type.
Decorator used for integrations with applications and frameworks.
The
Templates interface provides a collection of static methods for constructing SQL query elements
and creating ORM repository templates.Represents the type of a temporal attribute.
Handle to the transaction a transactional block runs in: exposes the rollback-only state and registration of
completion callbacks.
A transactional block executed by
Transactions.transaction(st.orm.template.TransactionBlock<R, E>).Thrown when a transaction completion callback fails.
Transaction isolation levels, mapping to the JDBC isolation constants.
Options for a transactional block.
Defines how a transaction block relates to a transaction that is already active when the block starts.
Programmatic transactions for Java.
A block executed with scoped transaction defaults by
Transactions.withTransactionOptions(st.orm.TransactionOptions, TransactionSupplier).Thrown when a transaction does not complete within its timeout.
A builder for specifying the ON condition of a JOIN clause using a type-safe entity relation or a custom expression.
A
Metamodel that also carries the declared component type of the field it represents.Marks a field as a unique key.
Thrown when a transaction completes with an unexpected rollback: the block finished normally, but the
physical transaction was rolled back, for example because a joined inner scope marked it rollback-only.
Controls how changes are detected and how UPDATE statements are generated for entities.
Marks a record component as a version field to detect optimistic locking conflicts.
A builder for constructing the WHERE clause of a query, providing type-safe predicate construction.
Represents a window of query results from a scrolling operation with
Scrollable navigation tokens.Dependency-aware write operations over mixed-type sets of entities.