Class Sql

Hierarchy

APIResource
- Sql

Index

Constructors

Properties

Methods

Constructors

constructor

new Sql(client: Runloop): Runloop.Axons.Sql
Parameters
- client: Runloop
Returns Runloop.Axons.Sql
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

batch

batch(
    id: string,
    body: Runloop.Axons.SqlBatchParams,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.Axons.SqlBatchResultView>
[Beta] Execute multiple SQL statements atomically within a single transaction against an axon's SQLite database.
Parameters
- id: string
- body: Runloop.Axons.SqlBatchParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.Axons.SqlBatchResultView>
- Defined in src/resources/axons/sql.ts:11

query

query(
    id: string,
    body: Runloop.Axons.SqlQueryParams,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.Axons.SqlQueryResultView>
[Beta] Execute a single parameterized SQL statement against an axon's SQLite database.
Parameters
- id: string
- body: Runloop.Axons.SqlQueryParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.Axons.SqlQueryResultView>
- Defined in src/resources/axons/sql.ts:23