Skip to main content

Class: D1Adapter

Defined in: src/adapters/D1Adapter.ts:34

Cloudflare D1 serverless SQLite adapter. Runs directly on Cloudflare Workers / Pages using the environment D1 binding.

Implements​

Constructors​

Constructor​

new D1Adapter(config): D1Adapter

Defined in: src/adapters/D1Adapter.ts:38

Parameters​

ParameterType
configD1DatabaseLike | D1AdapterConfig

Returns​

D1Adapter

Methods​

connect()​

connect(): Promise<void>

Defined in: src/adapters/D1Adapter.ts:48

Returns​

Promise<void>

Implementation of​

IDbAdapter.connect


disconnect()​

disconnect(): Promise<void>

Defined in: src/adapters/D1Adapter.ts:52

Returns​

Promise<void>

Implementation of​

IDbAdapter.disconnect


ping()​

ping(): Promise<boolean>

Defined in: src/adapters/D1Adapter.ts:56

Returns​

Promise<boolean>

Implementation of​

IDbAdapter.ping


executeQuery()​

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

Defined in: src/adapters/D1Adapter.ts:66

Type Parameters​

Type ParameterDefault type
Tunknown

Parameters​

ParameterType
sqlstring
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/D1Adapter.ts:81

Parameters​

ParameterType
sqlstring
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/D1Adapter.ts:103

Type Parameters​

Type ParameterDefault type
Tunknown

Parameters​

ParameterType
sqlstring
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/D1Adapter.ts:115

Type Parameters​

Type ParameterDefault type
Tunknown

Parameters​

ParameterType
namestring
paramsAdapterParam[]
_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/D1Adapter.ts:138

Type Parameters​

Type ParameterDefault type
T extends unknown[]unknown[]

Parameters​

ParameterType
namestring
paramsAdapterParam[]
timeoutMs?number
transaction?DbTransaction

Returns​

Promise<StoredProcedureResult<T>>

Implementation of​

IDbAdapter.executeProcedureMultiple


beginTransaction()​

beginTransaction(isolationLevel?): Promise<DbTransaction>

Defined in: src/adapters/D1Adapter.ts:153

Parameters​

ParameterTypeDefault value
isolationLevelIsolationLevelIsolationLevel.ReadCommitted

Returns​

Promise<DbTransaction>

Implementation of​

IDbAdapter.beginTransaction


escapeIdentifier()​

escapeIdentifier(name): string

Defined in: src/adapters/D1Adapter.ts:173

Parameters​

ParameterType
namestring

Returns​

string

Implementation of​

IDbAdapter.escapeIdentifier


formatParameterPlaceholder()​

formatParameterPlaceholder(_paramName, _index): string

Defined in: src/adapters/D1Adapter.ts:177

Parameters​

ParameterType
_paramNamestring
_indexnumber

Returns​

string

Implementation of​

IDbAdapter.formatParameterPlaceholder

Properties​

provider​

readonly provider: DbProvider = 'd1'

Defined in: src/adapters/D1Adapter.ts:35

Implementation of​

IDbAdapter.provider