PoolOptions class

Optional eviction/timeout knobs for a connection pool created via odbc_pool_create_with_options (NEW v3.0).

Mirror of the Rust pool::PoolOptions struct. Every field is null by default; the native side falls back to the engine defaults (connection_timeout = 30s, no idle_timeout, no max_lifetime, session_reset_on_checkout = true unless DSN/env overrides).

Constructors

PoolOptions({Duration? idleTimeout, Duration? maxLifetime, Duration? connectionTimeout, bool? sessionResetOnCheckout})

const

PoolOptions.fromUsageProfile(OdbcUsageProfile profile)

factory

Properties

connectionTimeout → Duration?

Maximum time acquire will wait for an available connection. null falls back to the engine default (30 s).

final

hasAnyOption → bool

true iff at least one option is set.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

idleTimeout → Duration?

Connections idle for longer than this are closed by the background reaper. null disables idle eviction.

final

maxLifetime → Duration?

A connection is closed when it exceeds this lifetime (checked on return to the pool). null disables lifetime eviction.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sessionResetOnCheckout → bool?

When false, skip pool_session_reset on checkout (trusted pool). null defers to DSN Pool_Session_Reset / env ODBC_POOL_SESSION_RESET / default true. Checkin reset remains unconditional.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → String?

Encode as the JSON shape expected by odbc_pool_create_with_options. Returns an empty string when no fields are set (caller may pass null FFI pointer instead, equivalent meaning).

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited