Remove default parameters in doc journal (#24704)

* Remove default parameters in doc journal

Making sure the examples are explicit about them

* Don't rely on default parameters in docs

As those default parameters might not be present for all implementations

* remove unrelated changes from PR

* Update BehaviorTestKitSpec.scala
This commit is contained in:
Arnout Engelen 2018-03-13 05:26:35 +01:00 committed by Konrad `ktoso` Malawski
parent ff5ee68e72
commit ab701e98be

View file

@ -66,7 +66,7 @@ object PersistenceQueryDocSpec {
* as the `offset` parameter in a subsequent query. * as the `offset` parameter in a subsequent query.
*/ */
override def eventsByTag( override def eventsByTag(
tag: String, offset: Offset = Sequence(0L)): Source[EventEnvelope, NotUsed] = offset match { tag: String, offset: Offset): Source[EventEnvelope, NotUsed] = offset match {
case Sequence(offsetValue) case Sequence(offsetValue)
val props = MyEventsByTagPublisher.props(tag, offsetValue, refreshInterval) val props = MyEventsByTagPublisher.props(tag, offsetValue, refreshInterval)
Source.actorPublisher[EventEnvelope](props) Source.actorPublisher[EventEnvelope](props)
@ -77,8 +77,8 @@ object PersistenceQueryDocSpec {
} }
override def eventsByPersistenceId( override def eventsByPersistenceId(
persistenceId: String, fromSequenceNr: Long = 0L, persistenceId: String, fromSequenceNr: Long,
toSequenceNr: Long = Long.MaxValue): Source[EventEnvelope, NotUsed] = { toSequenceNr: Long): Source[EventEnvelope, NotUsed] = {
// implement in a similar way as eventsByTag // implement in a similar way as eventsByTag
??? ???
} }
@ -165,7 +165,7 @@ object PersistenceQueryDocSpec {
// Using an example (Reactive Streams) Database driver // Using an example (Reactive Streams) Database driver
readJournal readJournal
.eventsByPersistenceId("user-1337") .eventsByPersistenceId("user-1337", fromSequenceNr = 0L, toSequenceNr = Long.MaxValue)
.map(envelope envelope.event) .map(envelope envelope.event)
.map(convertToReadSideTypes) // convert to datatype .map(convertToReadSideTypes) // convert to datatype
.grouped(20) // batch inserts into groups of 20 .grouped(20) // batch inserts into groups of 20
@ -252,7 +252,7 @@ class PersistenceQueryDocSpec(s: String) extends AkkaSpec(s) {
//#events-by-tag //#events-by-tag
//#events-by-persistent-id //#events-by-persistent-id
readJournal.eventsByPersistenceId("user-us-1337") readJournal.eventsByPersistenceId("user-us-1337", fromSequenceNr = 0L, toSequenceNr = Long.MaxValue)
//#events-by-persistent-id //#events-by-persistent-id
@ -318,7 +318,7 @@ class PersistenceQueryDocSpec(s: String) extends AkkaSpec(s) {
val store: ExampleStore = ??? val store: ExampleStore = ???
readJournal readJournal
.eventsByTag("bid") .eventsByTag("bid", NoOffset)
.mapAsync(1) { e store.save(e) } .mapAsync(1) { e store.save(e) }
.runWith(Sink.ignore) .runWith(Sink.ignore)
//#projection-into-different-store-simple //#projection-into-different-store-simple