-
Notifications
You must be signed in to change notification settings - Fork 161
/
Session.scala
695 lines (590 loc) · 27.5 KB
/
Session.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
// Copyright (c) 2018-2021 by Rob Norris
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT
package skunk
import cats._
import cats.data.Kleisli
import cats.effect._
import cats.effect.std.Console
import cats.syntax.all._
import fs2.concurrent.Signal
import fs2.io.net.{ Network, SocketGroup, SocketOption }
import fs2.Pipe
import fs2.Stream
import org.typelevel.otel4s.trace.Tracer
import skunk.codec.all.bool
import skunk.data._
import skunk.net.Protocol
import skunk.util._
import skunk.util.Typer.Strategy.{ BuiltinsOnly, SearchPath }
import skunk.net.SSLNegotiation
import skunk.data.TransactionIsolationLevel
import skunk.data.TransactionAccessMode
import skunk.net.protocol.Describe
import scala.concurrent.duration.Duration
import skunk.net.protocol.Parse
/**
* Represents a live connection to a Postgres database. Operations provided here are safe to use
* concurrently. Note that this is a lifetime-managed resource and as such is invalid outside the
* scope of its owning `Resource`, as are any streams constructed here. If you `start` an operation
* be sure to `join` its `Fiber` before releasing the resource.
*
* See the [[skunk.Session companion object]] for information on obtaining a pooled or single-use
* instance.
*
* @groupprio Queries 10
* @groupdesc Queries A query is any SQL statement that returns rows; i.e., any `SELECT` or
* `VALUES` query, or an `INSERT`, `UPDATE`, or `DELETE` command that returns rows via `RETURNING`.
* Parameterized queries must first be prepared, then can be executed many times with different
* arguments. Non-parameterized queries can be executed directly.
* @groupprio Commands 20
* @groupdesc Commands A command is any SQL statement that cannot return rows. Parameterized
* commands must first be prepared, then can be executed many times with different arguments.
* Commands without parameters can be executed directly.
*
* @groupprio Transactions 25
* @groupdesc Transactions Users can manipulate transactions directly via commands like `BEGIN` and
* `COMMIT`, but dealing with cancellation and error conditions can be complicated and repetitive.
* Skunk provides managed transaction blocks to make this easier.
*
* @groupprio Channels 30
*
* @groupprio Environment 30
* @groupname Environment Session Environment
* @groupdesc Environment The Postgres session has a dynamic environment that includes a
* configuration map with keys like `TimeZone` and `server_version`, as well as a current
* `TransactionStatus`. These can change asynchronously and are exposed as `Signal`s. Note that
* any `Stream` based on these signals is only valid for the lifetime of the `Session`.
*
* @group Session
*/
trait Session[F[_]] {
/**
* Signal representing the current state of all Postgres configuration variables announced to this
* session. These are sent after authentication and are updated asynchronously if the runtime
* environment changes. The current keys are as follows (with example values), but these may
* change with future releases so you should be prepared to handle unexpected ones.
*
* {{{
* Map(
* "application_name" -> "",
* "client_encoding" -> "UTF8",
* "DateStyle" -> "ISO, MDY",
* "integer_datetimes" -> "on", // cannot change after startup
* "IntervalStyle" -> "postgres",
* "is_superuser" -> "on",
* "server_encoding" -> "UTF8", // cannot change after startup
* "server_version" -> "9.5.3", // cannot change after startup
* "session_authorization" -> "postgres",
* "standard_conforming_strings" -> "on",
* "TimeZone" -> "US/Pacific",
* )
* }}}
* @group Environment
*/
def parameters: Signal[F, Map[String, String]]
/**
* Stream (possibly empty) of discrete values for the specified key, via `parameters`.
* @group Environment
*/
def parameter(key: String): Stream[F, String]
/**
* Signal representing the current transaction status.
* @group Environment
*/
def transactionStatus: Signal[F, TransactionStatus]
/**
* Execute a non-parameterized query and yield all results. If you have parameters or wish to limit
* returned rows use `prepare` instead.
* @group Queries
*/
def execute[A](query: Query[Void, A]): F[List[A]]
/**
* Prepare if needed, then execute a parameterized query and yield all results. If you wish to limit
* returned rows use `prepare` instead.
*
* @group Queries
*/
def execute[A, B](query: Query[A, B])(args: A): F[List[B]]
@deprecated("Use execute(query)(args) instead of execute(query, args)", "0.6")
def execute[A, B](query: Query[A, B], args: A)(implicit ev: DummyImplicit): F[List[B]] = execute(query)(args)
/**
* Execute a non-parameterized query and yield exactly one row, raising an exception if there are
* more or fewer. If you have parameters use `prepare` instead.
* @group Queries
*/
def unique[A](query: Query[Void, A]): F[A]
/**
* Prepare if needed, then execute a parameterized query and yield exactly one row, raising an exception if there are
* more or fewer.
*
* @group Queries
*/
def unique[A, B](query: Query[A, B])(args: A): F[B]
@deprecated("Use unique(query)(args) instead of unique(query, args)", "0.6")
def unique[A, B](query: Query[A, B], args: A)(implicit ev: DummyImplicit): F[B] = unique(query)(args)
/**
* Execute a non-parameterized query and yield at most one row, raising an exception if there are
* more. If you have parameters use `prepare` instead.
* @group Queries
*/
def option[A](query: Query[Void, A]): F[Option[A]]
/**
* Prepare if needed, then execute a parameterized query and yield at most one row, raising an exception if there are
* more.
*
* @group Queries
*/
def option[A, B](query: Query[A, B])(args: A): F[Option[B]]
@deprecated("Use option(query)(args) instead of option(query, args)", "0.6")
def option[A, B](query: Query[A, B], args: A)(implicit ev: DummyImplicit): F[Option[B]] = option(query)(args)
/**
* Returns a stream that prepare if needed, then execute a parameterized query
*
* @param chunkSize how many rows must be fetched by page
* @group Commands
*/
def stream[A, B](command: Query[A, B])(args: A, chunkSize: Int): Stream[F, B]
@deprecated("Use stream(query)(args, chunkSize) instead of stream(query, args, chunkSize)", "0.6")
def stream[A, B](query: Query[A, B], args: A, chunkSize: Int)(implicit ev: DummyImplicit): Stream[F, B] = stream(query)(args, chunkSize)
/**
* Prepare if needed, then execute a parameterized query and returns a resource wrapping a cursor in the result set.
*
* @group Queries
*/
def cursor[A, B](query: Query[A, B])(args: A): Resource[F, Cursor[F, B]]
@deprecated("Use cursor(query)(args) instead of cursor(query, args)", "0.6")
def cursor[A, B](query: Query[A, B], args: A)(implicit ev: DummyImplicit): Resource[F, Cursor[F, B]] = cursor(query)(args)
/**
* Execute a non-parameterized command and yield a `Completion`. If you have parameters use
* `prepare` instead.
* @group Commands
*/
def execute(command: Command[Void]): F[Completion]
/**
* Prepare if needed, then execute a parameterized command and yield a `Completion`.
*
* @group Commands
*/
def execute[A](command: Command[A])(args: A): F[Completion]
@deprecated("Use execute(command)(args) instead of execute(command, args)", "0.6")
def execute[A](command: Command[A], args: A)(implicit ev: DummyImplicit): F[Completion] = execute(command)(args)
/**
* Prepares then caches a query, yielding a `PreparedQuery` which can be executed multiple
* times with different arguments.
* @group Queries
*/
def prepare[A, B](query: Query[A, B]): F[PreparedQuery[F, A, B]]
/**
* Prepares then caches an `INSERT`, `UPDATE`, or `DELETE` command that returns no rows. The resulting
* `PreparedCommand` can be executed multiple times with different arguments.
* @group Commands
*/
def prepare[A](command: Command[A]): F[PreparedCommand[F, A]]
/**
* Resource that prepares a query, yielding a `PreparedQuery` which can be executed multiple
* times with different arguments.
*
* Note: this method only exists to ease migration from Skunk 0.3 and prior. Use the
* non-resource variant instead.
*
* @group Queries
*/
def prepareR[A, B](query: Query[A, B]): Resource[F, PreparedQuery[F, A, B]] =
Resource.eval(prepare(query))
/**
* Prepare an `INSERT`, `UPDATE`, or `DELETE` command that returns no rows. The resulting
* `PreparedCommand` can be executed multiple times with different arguments.
*
* Note: this method only exists to ease migration from Skunk 0.3 and prior. Use the
* non-resource variant instead.
*
* @group Commands
*/
def prepareR[A](command: Command[A]): Resource[F, PreparedCommand[F, A]] =
Resource.eval(prepare(command))
/**
* Transform a `Command` into a `Pipe` from inputs to `Completion`s.
* @group Commands
*/
def pipe[A](command: Command[A]): Pipe[F, A, Completion]
/**
* Transform a `Query` into a `Pipe` from inputs to outputs.
*
* @param chunkSize how many rows must be fetched by page
* @group Commands
*/
def pipe[A, B](query: Query[A, B], chunkSize: Int): Pipe[F, A, B]
/**
* A named asynchronous channel that can be used for inter-process communication.
* @group Channels
*/
def channel(name: Identifier): Channel[F, String, String]
/**
* Resource that wraps a transaction block. A transaction is begun before entering the `use`
* block, on success the block is executed, and on exit the following behavior holds.
*
* - If the block exits normally, and the session transaction status is
* - `Active`, then the transaction will be committed.
* - `Idle`, then this means the user terminated the
* transaction explicitly inside the block and there is nothing to be done.
* - `Error` then this means the user encountered and
* handled an error but left the transaction in a failed state, and the transaction will
* be rolled back.
* - If the block exits due to cancellation or an error and the session transaction status is
* not `Idle` then the transaction will be rolled back and any error will be re-raised.
* @group Transactions
*/
def transaction[A]: Resource[F, Transaction[F]]
/**
* Resource that wraps a transaction block.
* It has the ability to specify a non-default isolation level and access mode.
* @see Session#transaction for more information
* @group Transactions
*/
def transaction[A](isolationLevel: TransactionIsolationLevel, accessMode: TransactionAccessMode): Resource[F, Transaction[F]]
def typer: Typer
/**
* Each session has access to the pool-wide cache of all statements that have been checked via the
* `Describe` protocol, which allows us to skip subsequent checks. Users can inspect and clear
* the cache through this accessor.
*/
def describeCache: Describe.Cache[F]
/**
* Each session has access to a cache of all statements that have been parsed by the
* `Parse` protocol, which allows us to skip a network round-trip. Users can inspect and clear
* the cache through this accessor.
*/
def parseCache: Parse.Cache[F]
}
/** @group Companions */
object Session {
/**
* Abstract implementation that use the MonadCancelThrow constraint to implement prepared-if-needed API
*/
abstract class Impl[F[_]: MonadCancelThrow] extends Session[F] {
override def execute[A, B](query: Query[A, B])(args: A): F[List[B]] =
Monad[F].flatMap(prepare(query))(_.cursor(args).use {
_.fetch(Int.MaxValue).map { case (rows, _) => rows }
})
override def unique[A, B](query: Query[A, B])(args: A): F[B] =
Monad[F].flatMap(prepare(query))(_.unique(args))
override def option[A, B](query: Query[A, B])(args: A): F[Option[B]] =
Monad[F].flatMap(prepare(query))(_.option(args))
override def stream[A, B](command: Query[A, B])(args: A, chunkSize: Int): Stream[F, B] =
Stream.eval(prepare(command)).flatMap(_.stream(args, chunkSize)).scope
override def cursor[A, B](query: Query[A, B])(args: A): Resource[F, Cursor[F, B]] =
Resource.eval(prepare(query)).flatMap(_.cursor(args))
override def pipe[A, B](query: Query[A, B], chunkSize: Int): Pipe[F, A, B] = fa =>
Stream.eval(prepare(query)).flatMap(pq => fa.flatMap(a => pq.stream(a, chunkSize))).scope
override def execute[A](command: Command[A])(args: A): F[Completion] =
Monad[F].flatMap(prepare(command))(_.execute(args))
override def pipe[A](command: Command[A]): Pipe[F, A, Completion] = fa =>
Stream.eval(prepare(command)).flatMap(pc => fa.evalMap(pc.execute)).scope
}
val DefaultConnectionParameters: Map[String, String] =
Map(
"client_min_messages" -> "WARNING",
"DateStyle" -> "ISO, MDY",
"IntervalStyle" -> "iso_8601",
"client_encoding" -> "UTF8",
)
val DefaultSocketOptions: List[SocketOption] =
List(SocketOption.noDelay(true))
object Recyclers {
/**
* Ensure the session is idle, then remove all channel listeners and reset all variables to
* system defaults. Note that this is usually more work than you need to do. If your application
* isn't running arbitrary statements then `minimal` might be more efficient.
*/
def full[F[_]: Monad]: Recycler[F, Session[F]] =
ensureIdle[F] <+> unlistenAll <+> resetAll
/**
* Ensure the session is idle, then run a trivial query to ensure the connection is in working
* order. In most cases this check is sufficient.
*/
def minimal[F[_]: Monad]: Recycler[F, Session[F]] =
ensureIdle[F] <+> Recycler(_.unique(Query("VALUES (true)", Origin.unknown, Void.codec, bool)))
/**
* Yield `true` the session is idle (i.e., that there is no ongoing transaction), otherwise
* yield false. This check does not require network IO.
*/
def ensureIdle[F[_]: Monad]: Recycler[F, Session[F]] =
Recycler(_.transactionStatus.get.map(_ == TransactionStatus.Idle))
/** Remove all channel listeners and yield `true`. */
def unlistenAll[F[_]: Functor]: Recycler[F, Session[F]] =
Recycler(_.execute(Command("UNLISTEN *", Origin.unknown, Void.codec)).as(true))
/** Reset all variables to system defaults and yield `true`. */
def resetAll[F[_]: Functor]: Recycler[F, Session[F]] =
Recycler(_.execute(Command("RESET ALL", Origin.unknown, Void.codec)).as(true))
}
/**
* Resource yielding a `SessionPool` managing up to `max` concurrent `Session`s. Typically you
* will `use` this resource once on application startup and pass the resulting
* `Resource[F, Session[F]]` to the rest of your program.
*
* The pool maintains a cache of queries and commands that have been checked against the schema,
* eliminating the need to check them more than once. If your program is changing the schema on
* the fly than you probably don't want this behavior; you can disable it by setting the
* `commandCache` and `queryCache` parameters to zero.
*
* Note that calling `.flatten` on the nested `Resource` returned by this method may seem
* reasonable, but it will result in a resource that allocates a new pool for each session, which
* is probably not what you want.
* @param host Postgres server host
* @param port Postgres port, default 5432
* @param user Postgres user
* @param database Postgres database
* @param max Maximum concurrent sessions
* @param debug
* @param strategy
* @param commandCache Size of the cache for command checking
* @param queryCache Size of the cache for query checking
* @group Constructors
*/
def pooled[F[_]: Temporal: Tracer: Network: Console](
host: String,
port: Int = 5432,
user: String,
database: String,
password: Option[String] = none,
max: Int,
debug: Boolean = false,
strategy: Typer.Strategy = Typer.Strategy.BuiltinsOnly,
ssl: SSL = SSL.None,
parameters: Map[String, String] = Session.DefaultConnectionParameters,
socketOptions: List[SocketOption] = Session.DefaultSocketOptions,
commandCache: Int = 1024,
queryCache: Int = 1024,
parseCache: Int = 1024,
readTimeout: Duration = Duration.Inf,
): Resource[F, Resource[F, Session[F]]] = {
pooledF[F](host, port, user, database, password, max, debug, strategy, ssl, parameters, socketOptions, commandCache, queryCache, parseCache, readTimeout).map(_.apply(Tracer[F]))
}
/**
* Resource yielding a function from Tracer to `SessionPool` managing up to `max` concurrent `Session`s. Typically you
* will `use` this resource once on application startup and pass the resulting
* `Resource[F, Session[F]]` to the rest of your program.
*
* The pool maintains a cache of queries and commands that have been checked against the schema,
* eliminating the need to check them more than once. If your program is changing the schema on
* the fly than you probably don't want this behavior; you can disable it by setting the
* `commandCache` and `queryCache` parameters to zero.
*
* @param host Postgres server host
* @param port Postgres port, default 5432
* @param user Postgres user
* @param database Postgres database
* @param max Maximum concurrent sessions
* @param debug
* @param strategy
* @param commandCache Size of the cache for command checking
* @param queryCache Size of the cache for query checking
* @group Constructors
*/
def pooledF[F[_]: Temporal: Network: Console](
host: String,
port: Int = 5432,
user: String,
database: String,
password: Option[String] = none,
max: Int,
debug: Boolean = false,
strategy: Typer.Strategy = Typer.Strategy.BuiltinsOnly,
ssl: SSL = SSL.None,
parameters: Map[String, String] = Session.DefaultConnectionParameters,
socketOptions: List[SocketOption] = Session.DefaultSocketOptions,
commandCache: Int = 1024,
queryCache: Int = 1024,
parseCache: Int = 1024,
readTimeout: Duration = Duration.Inf,
): Resource[F, Tracer[F] => Resource[F, Session[F]]] = {
def session(socketGroup: SocketGroup[F], sslOp: Option[SSLNegotiation.Options[F]], cache: Describe.Cache[F])(implicit T: Tracer[F]): Resource[F, Session[F]] =
for {
pc <- Resource.eval(Parse.Cache.empty[F](parseCache))
s <- fromSocketGroup[F](socketGroup, host, port, user, database, password, debug, strategy, socketOptions, sslOp, parameters, cache, pc, readTimeout)
} yield s
val logger: String => F[Unit] = s => Console[F].println(s"TLS: $s")
for {
dc <- Resource.eval(Describe.Cache.empty[F](commandCache, queryCache))
sslOp <- ssl.toSSLNegotiationOptions(if (debug) logger.some else none)
pool <- Pool.ofF({implicit T: Tracer[F] => session(Network[F], sslOp, dc)}, max)(Recyclers.full)
} yield pool
}
/**
* Resource yielding logically unpooled sessions. This can be convenient for demonstrations and
* programs that only need a single session. In reality each session is managed by its own
* single-session pool. This method is shorthand for `Session.pooled(..., max = 1, ...).flatten`.
* @see pooled
*/
def single[F[_]: Temporal: Tracer: Network: Console](
host: String,
port: Int = 5432,
user: String,
database: String,
password: Option[String] = none,
debug: Boolean = false,
strategy: Typer.Strategy = Typer.Strategy.BuiltinsOnly,
ssl: SSL = SSL.None,
parameters: Map[String, String] = Session.DefaultConnectionParameters,
commandCache: Int = 1024,
queryCache: Int = 1024,
parseCache: Int = 1024,
readTimeout: Duration = Duration.Inf,
): Resource[F, Session[F]] =
singleF[F](host, port, user, database, password, debug, strategy, ssl, parameters, commandCache, queryCache, parseCache, readTimeout).apply(Tracer[F])
/**
* Resource yielding logically unpooled sessions given a Tracer. This can be convenient for demonstrations and
* programs that only need a single session. In reality each session is managed by its own
* single-session pool.
* @see pooledF
*/
def singleF[F[_]: Temporal: Network: Console](
host: String,
port: Int = 5432,
user: String,
database: String,
password: Option[String] = none,
debug: Boolean = false,
strategy: Typer.Strategy = Typer.Strategy.BuiltinsOnly,
ssl: SSL = SSL.None,
parameters: Map[String, String] = Session.DefaultConnectionParameters,
commandCache: Int = 1024,
queryCache: Int = 1024,
parseCache: Int = 1024,
readTimeout: Duration = Duration.Inf,
): Tracer[F] => Resource[F, Session[F]] =
Kleisli((_: Tracer[F]) => pooledF(
host = host,
port = port,
user = user,
database = database,
password = password,
max = 1,
debug = debug,
strategy = strategy,
ssl = ssl,
parameters = parameters,
commandCache = commandCache,
queryCache = queryCache,
parseCache = parseCache,
readTimeout = readTimeout
)).flatMap(f =>
Kleisli { implicit T: Tracer[F] => f(T) }
).run
def fromSocketGroup[F[_]: Temporal: Tracer: Console](
socketGroup: SocketGroup[F],
host: String,
port: Int = 5432,
user: String,
database: String,
password: Option[String] = none,
debug: Boolean = false,
strategy: Typer.Strategy = Typer.Strategy.BuiltinsOnly,
socketOptions: List[SocketOption],
sslOptions: Option[SSLNegotiation.Options[F]],
parameters: Map[String, String],
describeCache: Describe.Cache[F],
parseCache: Parse.Cache[F],
readTimeout: Duration = Duration.Inf,
): Resource[F, Session[F]] =
for {
namer <- Resource.eval(Namer[F])
proto <- Protocol[F](host, port, debug, namer, socketGroup, socketOptions, sslOptions, describeCache, parseCache, readTimeout)
_ <- Resource.eval(proto.startup(user, database, password, parameters))
sess <- Resource.make(fromProtocol(proto, namer, strategy))(_ => proto.cleanup)
} yield sess
/**
* Construct a `Session` by wrapping an existing `Protocol`, which we assume has already been
* started up.
* @group Constructors
*/
def fromProtocol[F[_]](
proto: Protocol[F],
namer: Namer[F],
strategy: Typer.Strategy
)(implicit ev: MonadCancel[F, Throwable]): F[Session[F]] = {
val ft: F[Typer] =
strategy match {
case BuiltinsOnly => Typer.Static.pure[F]
case SearchPath => Typer.fromProtocol(proto)
}
ft.map { typ =>
new Impl[F] {
override val typer: Typer = typ
override def execute(command: Command[Void]): F[Completion] =
proto.execute(command)
override def channel(name: Identifier): Channel[F, String, String] =
Channel.fromNameAndProtocol(name, proto)
override def parameters: Signal[F, Map[String, String]] =
proto.parameters
override def parameter(key: String): Stream[F, String] =
parameters.discrete.map(_.get(key)).unNone.changes
override def transactionStatus: Signal[F, TransactionStatus] =
proto.transactionStatus
override def execute[A](query: Query[Void, A]): F[List[A]] =
proto.execute(query, typer)
override def unique[A](query: Query[Void, A]): F[A] =
execute(query).flatMap {
case a :: Nil => a.pure[F]
case Nil => ev.raiseError(new RuntimeException("Expected exactly one row, none returned."))
case _ => ev.raiseError(new RuntimeException("Expected exactly one row, more returned."))
}
override def option[A](query: Query[Void, A]): F[Option[A]] =
execute(query).flatMap {
case a :: Nil => a.some.pure[F]
case Nil => none[A].pure[F]
case _ => ev.raiseError(new RuntimeException("Expected at most one row, more returned."))
}
override def prepare[A, B](query: Query[A, B]): F[PreparedQuery[F, A, B]] =
proto.prepare(query, typer).map(PreparedQuery.fromProto(_))
override def prepare[A](command: Command[A]): F[PreparedCommand[F, A]] =
proto.prepare(command, typer).map(PreparedCommand.fromProto(_))
override def transaction[A]: Resource[F, Transaction[F]] =
Transaction.fromSession(this, namer, none, none)
override def transaction[A](isolationLevel: TransactionIsolationLevel, accessMode: TransactionAccessMode): Resource[F, Transaction[F]] =
Transaction.fromSession(this, namer, isolationLevel.some, accessMode.some)
override def describeCache: Describe.Cache[F] =
proto.describeCache
override def parseCache: Parse.Cache[F] =
proto.parseCache
}
}
}
// TODO: upstream
implicit class SignalOps[F[_], A](outer: Signal[F, A]) {
def mapK[G[_]](fk: F ~> G): Signal[G, A] =
new Signal[G, A] {
def continuous: Stream[G,A] = outer.continuous.translate(fk)
def discrete: Stream[G,A] = outer.continuous.translate(fk)
def get: G[A] = fk(outer.get)
}
}
implicit class SessionSyntax[F[_]](outer: Session[F]) {
/**
* Transform this `Session` by a given `FunctionK`.
* @group Transformations
*/
def mapK[G[_]: MonadCancelThrow](fk: F ~> G)(
implicit mcf: MonadCancel[F, _]
): Session[G] =
new Impl[G] {
override val typer: Typer = outer.typer
override def channel(name: Identifier): Channel[G,String,String] = outer.channel(name).mapK(fk)
override def execute(command: Command[Void]): G[Completion] = fk(outer.execute(command))
override def execute[A](query: Query[Void,A]): G[List[A]] = fk(outer.execute(query))
override def option[A](query: Query[Void,A]): G[Option[A]] = fk(outer.option(query))
override def parameter(key: String): Stream[G,String] = outer.parameter(key).translate(fk)
override def parameters: Signal[G,Map[String,String]] = outer.parameters.mapK(fk)
override def prepare[A, B](query: Query[A,B]): G[PreparedQuery[G,A,B]] = fk(outer.prepare(query)).map(_.mapK(fk))
override def prepare[A](command: Command[A]): G[PreparedCommand[G,A]] = fk(outer.prepare(command)).map(_.mapK(fk))
override def transaction[A]: Resource[G,Transaction[G]] = outer.transaction.mapK(fk).map(_.mapK(fk))
override def transaction[A](isolationLevel: TransactionIsolationLevel, accessMode: TransactionAccessMode): Resource[G,Transaction[G]] =
outer.transaction(isolationLevel, accessMode).mapK(fk).map(_.mapK(fk))
override def transactionStatus: Signal[G,TransactionStatus] = outer.transactionStatus.mapK(fk)
override def unique[A](query: Query[Void,A]): G[A] = fk(outer.unique(query))
override def describeCache: Describe.Cache[G] = outer.describeCache.mapK(fk)
override def parseCache: Parse.Cache[G] = outer.parseCache.mapK(fk)
}
}
}