PostgresOptions class final

Configuration for an owned PostgreSQL connection pool.

Connection details belong in url; timeouts, TLS, and pool size use the typed options here. URL query parameters and fragments are rejected when opening.

Constructors

PostgresOptions({required Uri url, PostgresTls tls = PostgresTls.verifyFull, int maxConnections = 8, Duration connectTimeout = const Duration(seconds: 10), Duration poolTimeout = const Duration(seconds: 30), Duration queryTimeout = const Duration(seconds: 30), String applicationName = 'dart-orm', String? schema})
Creates pool configuration; opening the driver validates its values.
const

Properties

applicationName String
Label exposed by PostgreSQL in connection and activity diagnostics.
final
connectTimeout Duration
Deadline for establishing each new physical connection.
final
hashCode int
The hash code for this object.
no setterinherited
maxConnections int
Maximum simultaneous physical connections; must be at least one.
final
poolTimeout Duration
Driver pool queue limit; separate from opening a new connection.
final
queryTimeout Duration
Default statement deadline, overridable for each execution.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
schema String?
Optional, quoted search path for raw SQL and historical unqualified metadata. PostgreSQL-generated models retain their declared namespace (default public) independently of this setting.
final
tls PostgresTls
Transport policy; server identity verification is enabled by default.
final
url Uri
A postgres:// or postgresql:// URL with one database path segment.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited