Interface HyperdriveDynamicConfig

Parameters identifying the database that a dynamically-provisioned Hyperdrive connection should target.

interface HyperdriveDynamicConfig {
    cachingEnabled?: boolean;
    connectionString: string;
    dynamicHyperdriveConnectionString: string;
    maxConnections?: number;
    targetRegion: string;
}

Properties

cachingEnabled?: boolean

Whether Hyperdrive should cache query results for this connection.

connectionString: string

Connection string for the origin database Hyperdrive should connect to. Contains credentials, so treat it as a secret.

The scheme selects the database engine. PostgreSQL origins are supported.

dynamicHyperdriveConnectionString: string

Generated connection string to pass into the dynamic worker.

maxConnections?: number

Maximum number of connections the pool may open to the origin database. Defaults to 60.

targetRegion: string

Region in which to place the connection pool. See the Hyperdrive documentation for the set of supported regions.