Class: PlanetScaleAdapter

Defined in: src/adapters/PlanetScaleAdapter.ts:19

PlanetScale serverless MySQL adapter using @planetscale/database. Communicates with PlanetScale over HTTP with low latency.

Implements

• IDbAdapter

Constructors

Constructor

new PlanetScaleAdapter(config): PlanetScaleAdapter

Defined in: src/adapters/PlanetScaleAdapter.ts:24

Parameters

Parameter	Type
config	string | PlanetScaleAdapterConfig

Returns

PlanetScaleAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/adapters/PlanetScaleAdapter.ts:26

Returns

Promise<void>

Implementation of

IDbAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/adapters/PlanetScaleAdapter.ts:40

Returns

Promise<void>

Implementation of

IDbAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/adapters/PlanetScaleAdapter.ts:45

Returns

Promise<boolean>

Implementation of

IDbAdapter.ping

---

executeQuery()

executeQuery<T>(sql, params?, transaction?): Promise<T[]>

Defined in: src/adapters/PlanetScaleAdapter.ts:55

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<T[]>

Implementation of

IDbAdapter.executeQuery

---

executeNonQuery()

executeNonQuery(sql, params?, transaction?): Promise<{ rowsAffected: number; insertId?: unknown; }>

Defined in: src/adapters/PlanetScaleAdapter.ts:76

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<{ rowsAffected: number; insertId?: unknown; }>

Implementation of

IDbAdapter.executeNonQuery

---

executeScalar()

executeScalar<T>(sql, params?, transaction?): Promise<T>

Defined in: src/adapters/PlanetScaleAdapter.ts:100

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<T>

Implementation of

IDbAdapter.executeScalar

---

executeProcedure()

executeProcedure<T>(name, params, _timeoutMs?, transaction?): Promise<StoredProcedureResult<T[]>>

Defined in: src/adapters/PlanetScaleAdapter.ts:112

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
params	AdapterParam[]
_timeoutMs?	number
transaction?	DbTransaction

Returns

Promise<StoredProcedureResult<T[]>>

Implementation of

IDbAdapter.executeProcedure

---

executeProcedureMultiple()

executeProcedureMultiple<T>(name, params, timeoutMs?, transaction?): Promise<StoredProcedureResult<T>>

Defined in: src/adapters/PlanetScaleAdapter.ts:136

Type Parameters

Type Parameter	Default type
T extends unknown[]	unknown[]

Parameters

Parameter	Type
name	string
params	AdapterParam[]
timeoutMs?	number
transaction?	DbTransaction

Returns

Promise<StoredProcedureResult<T>>

Implementation of

IDbAdapter.executeProcedureMultiple

---

beginTransaction()

beginTransaction(isolationLevel?): Promise<DbTransaction>

Defined in: src/adapters/PlanetScaleAdapter.ts:151

Parameters

Parameter	Type	Default value
isolationLevel	IsolationLevel	IsolationLevel.ReadCommitted

Returns

Promise<DbTransaction>

Implementation of

IDbAdapter.beginTransaction

---

escapeIdentifier()

escapeIdentifier(name): string

Defined in: src/adapters/PlanetScaleAdapter.ts:189

Parameters

Parameter	Type
name	string

Returns

string

Implementation of

IDbAdapter.escapeIdentifier

---

formatParameterPlaceholder()

formatParameterPlaceholder(_paramName, _index): string

Defined in: src/adapters/PlanetScaleAdapter.ts:193

Parameters

Parameter	Type
_paramName	string
_index	number

Returns

string

Implementation of

IDbAdapter.formatParameterPlaceholder

Properties

provider

readonly provider: DbProvider = 'planetscale'

Defined in: src/adapters/PlanetScaleAdapter.ts:20

Implementation of

IDbAdapter.provider