Pika Streams

Pika Streams provide a powerful abstraction layer that combines the familiar Java Stream API with database query execution. Unlike standard Java Streams that operate on in-memory collections, Pika Streams execute queries lazily against your database — allowing you to process large datasets efficiently without loading entire result sets into memory.

Standard Streams vs Pika Streams

Getting Started with Pika Streams

Pika Streams are accessed through the main ORM instance using the stream() method:

// Get a stream finder for your entity class
PikaStreamFinder<SampleModel> streamFinder = orm.stream(SampleModel.class);

// Use within a connection context for proper resource management
try (var conn = orm.establishConnection()) {
    Stream<SampleModel> results = streamFinder.all();
    // Process your stream...
}

Query Methods

Single Record Queries

byId(Object id) — retrieves a single entity by its primary key.

try (var conn = orm.establishConnection()) {
    Stream<SampleModel> modelStream = orm.stream(SampleModel.class).byId(123);
    SampleModel model = modelStream.findFirst().orElse(null);
}

byKey(String column, Object value) — finds a single entity by any column value.

try (var conn = orm.establishConnection()) {
    Stream<SampleModel> modelStream = orm.stream(SampleModel.class)
        .byKey("str_val", "specificValue");
    SampleModel model = modelStream.findFirst().get();
}

Collection Queries

all() — retrieves all records from the entity's table.

try (var conn = orm.establishConnection()) {
    List<SampleModel> allModels = orm.stream(SampleModel.class).all().toList();
}

Dynamic Queries

where(String whereClause, Map<String, Object> args) — custom WHERE clauses with named parameters.

try (var conn = orm.establishConnection()) {
    List<SampleModel> results = orm.stream(SampleModel.class)
        .where("int_val = :val", Map.of("val", 10))
        .toList();
}