Class RawAPI

Hierarchy

BaseResourceAPI<RawDB>
- RawAPI

Index

Methods

Methods

createDatabases

createDatabases(items: RawDBName[]): Promise<RawDB[]>

- Defined in packages/stable/src/api/raw/rawApi.ts:45
Create databases
```
const databases = await client.raw.createDatabases([{ name: 'My company' }]);
```
Parameters
- items: RawDBName[]
Returns Promise<RawDB[]>

createTables

createTables(databaseName: string, items: RawDBTableName[], ensureParent?: boolean): Promise<RawDBTable[]>

- Defined in packages/stable/src/api/raw/rawApi.ts:86
Create tables in a database
```
const tables = await client.raw.createTables('My company', [{ name: 'Customers' }]);
```
Parameters
- databaseName: string
- items: RawDBTableName[]
- Default value ensureParent: boolean = false
Returns Promise<RawDBTable[]>

deleteDatabases

deleteDatabases(items: RawDBName[], params?: RawDatabaseDeleteParams): Promise<{}>

- Defined in packages/stable/src/api/raw/rawApi.ts:69
Delete databases
```
await client.raw.deleteDatabases([{ name: 'My company' }]);
```
Parameters
- items: RawDBName[]
- Optional params: RawDatabaseDeleteParams
Returns Promise<{}>

deleteRows

deleteRows(databaseName: string, tableName: string, items: RawDBRowKey[]): Promise<object>

- Defined in packages/stable/src/api/raw/rawApi.ts:175
Delete rows in a table
```
await client.raw.deleteRows('My company', 'Customers', [{key: 'customer1'}]);
```
Parameters
- databaseName: string
- tableName: string
- items: RawDBRowKey[]
Returns Promise<object>

deleteTables

deleteTables(databaseName: string, items: RawDBTableName[]): Promise<object>

- Defined in packages/stable/src/api/raw/rawApi.ts:115
Delete tables in a database
```
await client.raw.deleteTables('My company', [{ name: 'Customers' }]);
```
Parameters
- databaseName: string
- items: RawDBTableName[]
Returns Promise<object>

insertRows

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

- Defined in packages/stable/src/api/raw/rawApi.ts:129
Insert rows into a table
```
await client.raw.insertRows('My company', 'Customers', [{ key: 'customer1', columns: { 'First name': 'Steve', 'Last name': 'Jobs' } }]);
```
Parameters
- databaseName: string
- tableName: string
- items: RawDBRowInsert[]
- Default value ensureParent: boolean = false
Returns Promise<object>

listDatabases

listDatabases(scope?: ListRawDatabases): CursorAndAsyncIterator<RawDB>

- Defined in packages/stable/src/api/raw/rawApi.ts:56
List databases
```
const databases = await client.raw.listDatabases();
```
Parameters
- Optional scope: ListRawDatabases
Returns CursorAndAsyncIterator<RawDB>

listRows

listRows(databaseName: string, tableName: string, query?: ListRawRows): CursorAndAsyncIterator<RawDBRow>

- Defined in packages/stable/src/api/raw/rawApi.ts:145
List rows in a table
```
await client.raw.listRows('My company', 'Employees', { columns: ['last_name'] });
```
Parameters
- databaseName: string
- tableName: string
- Optional query: ListRawRows
Returns CursorAndAsyncIterator<RawDBRow>

listTables

listTables(databaseName: string, scope?: ListRawTables): CursorAndAsyncIterator<RawDBTable>

- Defined in packages/stable/src/api/raw/rawApi.ts:101
List tables in database
```
const tables = await client.raw.listTables('My company');
```
Parameters
- databaseName: string
- Optional scope: ListRawTables
Returns CursorAndAsyncIterator<RawDBTable>

retrieveRow

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

- Defined in packages/stable/src/api/raw/rawApi.ts:160
Retrieve a single row from a table
```
await client.raw.retrieveRow('My company', 'Customers', 'customer1');
```
Parameters
- databaseName: string
- tableName: string
- rowKey: string
Returns Promise<RawDBRow>