Class RawRowsAPI

Hierarchy

BaseResourceAPI<RawDBRow>
- RawRowsAPI

Index

Methods

Methods

delete

delete(databaseName: string, tableName: string, items: RawDBRowKey[]): Promise<{}>

- Defined in packages/stable/src/api/raw/rawRowsApi.ts:77
Parameters
- databaseName: string
- tableName: string
- items: RawDBRowKey[]
Returns Promise<{}>

insert

insert(databaseName: string, tableName: string, items: RawDBRowInsert[], ensureParent?: boolean): Promise<object>

- Defined in packages/stable/src/api/raw/rawRowsApi.ts:24
Parameters
- databaseName: string
- tableName: string
- items: RawDBRowInsert[]
- Default value ensureParent: boolean = false
Returns Promise<object>

list

list(databaseName: string, tableName: string, scope?: ListRawRows): CursorAndAsyncIterator<RawDBRow>

- Defined in packages/stable/src/api/raw/rawRowsApi.ts:40
Parameters
- databaseName: string
- tableName: string
- Default value scope: ListRawRows = {}
Returns CursorAndAsyncIterator<RawDBRow>

retrieve

retrieve(databaseName: string, tableName: string, rowKey: string): Promise<RawDBRow>

- Defined in packages/stable/src/api/raw/rawRowsApi.ts:64
Parameters
- databaseName: string
- tableName: string
- rowKey: string
Returns Promise<RawDBRow>