improve docs; add deprecation to a factory method

Author: Z1kkurat

persistence-cassandra/src/main/scala/com/evolutiongaming/kafka/flow/cassandra/CassandraPersistence.scala

@@ -17,7 +17,11 @@ import scala.util.Try
 trait CassandraPersistence[F[_], S] extends PersistenceModule[F, S]
 object CassandraPersistence {
 
-  /** Creates schema in Cassandra if not there yet. */
+  /** Creates schema in Cassandra if not there yet. Uses default names for all Cassandra tables:
+    *   - for keys see [[com.evolutiongaming.kafka.flow.key.CassandraKeys.DefaultTableName]]
+    *   - for snapshots see [[com.evolutiongaming.kafka.flow.snapshot.CassandraSnapshots.DefaultTableName]]
+    *   - for journals see [[com.evolutiongaming.kafka.flow.journal.CassandraJournals.DefaultTableName]]
+    */
   def withSchemaF[F[_]: Async, S](
     session: scassandra.CassandraSession[F],
     sync: CassandraSync[F],
@@ -33,7 +37,10 @@ object CassandraPersistence {
     def snapshots = _snapshots
   }
 
-  /** Creates schema in Cassandra if not there yet
+  /** Creates schema in Cassandra if not there yet. Uses default names for all Cassandra tables:
+    *   - for keys see [[com.evolutiongaming.kafka.flow.key.CassandraKeys.DefaultTableName]]
+    *   - for snapshots see [[com.evolutiongaming.kafka.flow.snapshot.CassandraSnapshots.DefaultTableName]]
+    *   - for journals see [[com.evolutiongaming.kafka.flow.journal.CassandraJournals.DefaultTableName]]
     *
     * This method uses the same `JsonCodec[Try]` as `JournalParser` does to simplify defining the basic application. if
     * \@consistencyConfig is present then applies ConsistencyConfig.Read for all read queries and
@@ -51,12 +58,16 @@ object CassandraPersistence {
     withSchemaF(session, sync, consistencyOverrides, keysSegments)
   }
 
-  /** Deletes all data in Cassandra */
+  /** Deletes all data in Cassandra. Uses default names for all Cassandra tables:
+    *   - for keys see [[com.evolutiongaming.kafka.flow.key.CassandraKeys.DefaultTableName]]
+    *   - for snapshots see [[com.evolutiongaming.kafka.flow.snapshot.CassandraSnapshots.DefaultTableName]]
+    *   - for journals see [[com.evolutiongaming.kafka.flow.journal.CassandraJournals.DefaultTableName]]
+    */
   def truncate[F[_]: Monad](
     session: scassandra.CassandraSession[F],
     sync: CassandraSync[F]
   ): F[Unit] =
     CassandraKeys.truncate(session, sync, CassandraKeys.DefaultTableName) *>
-      CassandraJournals.truncate(session, sync) *>
+      CassandraJournals.truncate(session, sync, CassandraJournals.DefaultTableName) *>
       CassandraSnapshots.truncate(session, sync, CassandraSnapshots.DefaultTableName)
 }

persistence-cassandra/src/main/scala/com/evolutiongaming/kafka/flow/journal/CassandraJournals.scala

@@ -85,16 +85,20 @@ object CassandraJournals {
   ): F[JournalDatabase[F, KafkaKey, ConsumerRecord[String, ByteVector]]] =
     withSchema(session, sync, ConsistencyOverrides.none, DefaultTableName)
 
+  @deprecated(
+    "Use the version with an explicit table name. This exists to preserve binary compatibility until the next major release",
+    since = "6.1.3"
+  )
   def truncate[F[_]: Monad](
     session: CassandraSession[F],
     sync: CassandraSync[F],
-    tableName: String,
-  ): F[Unit] = JournalSchema.of(session, sync, tableName).truncate
+  ): F[Unit] = truncate(session, sync, DefaultTableName)
 
   def truncate[F[_]: Monad](
     session: CassandraSession[F],
     sync: CassandraSync[F],
-  ): F[Unit] = truncate(session, sync, DefaultTableName)
+    tableName: String = DefaultTableName,
+  ): F[Unit] = JournalSchema.of(session, sync, tableName).truncate
 
   // we cannot use DecodeRow here because TupleToHeader is effectful
   protected def decode[F[_]: MonadThrow](key: KafkaKey, row: Row): F[ConsumerRecord[String, ByteVector]] = {