Skip to content

mssql-ts-ffi / RuntimeFFI

Interface: RuntimeFFI ​

Defined in: runtime.ts:16

Methods ​

beginTransaction() ​

beginTransaction(connId, txJson): Promise<string | null>

Defined in: runtime.ts:41

Parameters ​

connId ​

bigint

txJson ​

string

Returns ​

Promise<string | null>


bulkInsert() ​

bulkInsert(connId, reqJson): Promise<string | null>

Defined in: runtime.ts:38

Parameters ​

connId ​

bigint

reqJson ​

string

Returns ​

Promise<string | null>


cancel() ​

cancel(connId): void

Defined in: runtime.ts:46

Parameters ​

connId ​

bigint

Returns ​

void


commit() ​

commit(connId, txId): Promise<string | null>

Defined in: runtime.ts:42

Parameters ​

connId ​

bigint

txId ​

string

Returns ​

Promise<string | null>


connect() ​

connect(configJson): Promise<bigint>

Defined in: runtime.ts:24

Parameters ​

configJson ​

string

Returns ​

Promise<bigint>


diagnosticInfo() ​

diagnosticInfo(): string | null

Defined in: runtime.ts:59

Returns ​

string | null


disconnect() ​

disconnect(connId): void

Defined in: runtime.ts:25

Parameters ​

connId ​

bigint

Returns ​

void


exec() ​

exec(connId, cmdJson): Promise<string | null>

Defined in: runtime.ts:30

Parameters ​

connId ​

bigint

cmdJson ​

string

Returns ​

Promise<string | null>


executeNonquery() ​

executeNonquery(connId, cmdJson): Promise<string | null>

Defined in: runtime.ts:29

Parameters ​

connId ​

bigint

cmdJson ​

string

Returns ​

Promise<string | null>


filestreamAvailable() ​

filestreamAvailable(): boolean

Defined in: runtime.ts:52

Returns ​

boolean


filestreamClose() ​

filestreamClose(fsId): void

Defined in: runtime.ts:56

Parameters ​

fsId ​

bigint

Returns ​

void


filestreamOpen() ​

filestreamOpen(reqJson): bigint

Defined in: runtime.ts:53

Parameters ​

reqJson ​

string

Returns ​

bigint


filestreamRead() ​

filestreamRead(fsId, maxBytes): string | null

Defined in: runtime.ts:54

Parameters ​

fsId ​

bigint

maxBytes ​

bigint

Returns ​

string | null


filestreamWrite() ​

filestreamWrite(fsId, dataBase64): bigint

Defined in: runtime.ts:55

Parameters ​

fsId ​

bigint

dataBase64 ​

string

Returns ​

bigint


lastError() ​

lastError(handleId): string | null

Defined in: runtime.ts:49

Parameters ​

handleId ​

bigint

Returns ​

string | null


poolAcquire() ​

poolAcquire(poolId): Promise<bigint>

Defined in: runtime.ts:19

Parameters ​

poolId ​

bigint

Returns ​

Promise<bigint>


poolClose() ​

poolClose(poolId): void

Defined in: runtime.ts:21

Parameters ​

poolId ​

bigint

Returns ​

void


poolCreate() ​

poolCreate(configJson): Promise<bigint>

Defined in: runtime.ts:18

Parameters ​

configJson ​

string

Returns ​

Promise<bigint>


poolRelease() ​

poolRelease(poolId, connId): void

Defined in: runtime.ts:20

Parameters ​

poolId ​

bigint

connId ​

bigint

Returns ​

void


query() ​

query(connId, cmdJson): Promise<string | null>

Defined in: runtime.ts:28

Parameters ​

connId ​

bigint

cmdJson ​

string

Returns ​

Promise<string | null>


queryStream() ​

queryStream(connId, cmdJson): Promise<bigint>

Defined in: runtime.ts:33

Parameters ​

connId ​

bigint

cmdJson ​

string

Returns ​

Promise<bigint>


rollback() ​

rollback(connId, txId): Promise<string | null>

Defined in: runtime.ts:43

Parameters ​

connId ​

bigint

txId ​

string

Returns ​

Promise<string | null>


setDebug() ​

setDebug(enabled): void

Defined in: runtime.ts:62

Parameters ​

enabled ​

number

Returns ​

void


streamClose() ​

streamClose(cursorId): void

Defined in: runtime.ts:35

Parameters ​

cursorId ​

bigint

Returns ​

void


streamNext() ​

streamNext(cursorId): Promise<string | null>

Defined in: runtime.ts:34

Parameters ​

cursorId ​

bigint

Returns ​

Promise<string | null>