Class: CockroachDbAdapter

Defined in: src/adapters/CockroachDbAdapter.ts:10

CockroachDB distributed database adapter. Extends PostgresAdapter with CockroachDB-specific provider identity and PostgreSQL wire compatibility.

Extends

• PostgresAdapter

Constructors

Constructor

new CockroachDbAdapter(config): CockroachDbAdapter

Defined in: src/adapters/CockroachDbAdapter.ts:13

Parameters

Parameter	Type
config	string | CockroachDbAdapterConfig

Returns

CockroachDbAdapter

Overrides

PostgresAdapter.constructor

Methods

connect()

connect(): Promise<void>

Defined in: src/adapters/PostgresAdapter.ts:39

Returns

Promise<void>

Inherited from

PostgresAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/adapters/PostgresAdapter.ts:54

Returns

Promise<void>

Inherited from

PostgresAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/adapters/PostgresAdapter.ts:61

Returns

Promise<boolean>

Inherited from

PostgresAdapter.ping

---

executeQuery()

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

Defined in: src/adapters/PostgresAdapter.ts:79

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

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

Returns

Promise<T[]>

Inherited from

PostgresAdapter.executeQuery

---

executeNonQuery()

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

Defined in: src/adapters/PostgresAdapter.ts:107

Parameters

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

Returns

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

Inherited from

PostgresAdapter.executeNonQuery

---

executeScalar()

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

Defined in: src/adapters/PostgresAdapter.ts:167

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

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

Returns

Promise<T>

Inherited from

PostgresAdapter.executeScalar

---

executeProcedure()

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

Defined in: src/adapters/PostgresAdapter.ts:179

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

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

Returns

Promise<StoredProcedureResult<T[]>>

Inherited from

PostgresAdapter.executeProcedure

---

executeProcedureMultiple()

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

Defined in: src/adapters/PostgresAdapter.ts:248

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>>

Inherited from

PostgresAdapter.executeProcedureMultiple

---

beginTransaction()

beginTransaction(isolationLevel?): Promise<DbTransaction>

Defined in: src/adapters/PostgresAdapter.ts:263

Parameters

Parameter	Type	Default value
isolationLevel	IsolationLevel	IsolationLevel.ReadCommitted

Returns

Promise<DbTransaction>

Inherited from

PostgresAdapter.beginTransaction

---

escapeIdentifier()

escapeIdentifier(name): string

Defined in: src/adapters/PostgresAdapter.ts:297

Parameters

Parameter	Type
name	string

Returns

string

Inherited from

PostgresAdapter.escapeIdentifier

---

formatParameterPlaceholder()

formatParameterPlaceholder(_paramName, index): string

Defined in: src/adapters/PostgresAdapter.ts:301

Parameters

Parameter	Type
_paramName	string
index	number

Returns

string

Inherited from

PostgresAdapter.formatParameterPlaceholder

Properties

provider

readonly provider: DbProvider = 'cockroachdb'

Defined in: src/adapters/CockroachDbAdapter.ts:11

Overrides

PostgresAdapter.provider