import { BaseResourceAPI, CDFHttpClient, CursorAndAsyncIterator, MetadataMap } from '@cognite/sdk-core'; import { ListRawDatabases, ListRawRows, ListRawTables, RawDB, RawDBName, RawDBRow, RawDBRowInsert, RawDBRowKey, RawDBTable, RawDBTableName } from '../../types'; export declare class RawAPI extends BaseResourceAPI { private rawTablesApi; private rawRowsApi; /** @hidden */ constructor(resourcePath: string, httpClient: CDFHttpClient, map: MetadataMap); /** * [Create databases](https://doc.cognitedata.com/api/v1/#operation/createDBs) * * ```js * const databases = await client.raw.createDatabases([{ name: 'My company' }]); * ``` */ createDatabases: (items: RawDBName[]) => Promise; /** * [List databases](https://doc.cognitedata.com/api/v1/#operation/getDBs) * * ```js * const databases = await client.raw.listDatabases(); * ``` */ listDatabases: (scope?: ListRawDatabases) => CursorAndAsyncIterator; /** * [Delete databases](https://doc.cognitedata.com/api/v1/#operation/deleteDBs) * * ```js * await client.raw.deleteDatabases([{ name: 'My company' }]); * ``` */ deleteDatabases: (items: RawDBName[], params?: RawDatabaseDeleteParams) => Promise<{}>; /** * [Create tables in a database](https://doc.cognitedata.com/api/v1/#operation/createTables) * * ```js * const tables = await client.raw.createTables('My company', [{ name: 'Customers' }]); * ``` */ createTables: (databaseName: string, items: RawDBTableName[], ensureParent?: boolean) => Promise; /** * [List tables in database](https://doc.cognitedata.com/api/v1/#operation/getTables) * * ```js * const tables = await client.raw.listTables('My company'); * ``` */ listTables: (databaseName: string, scope?: ListRawTables) => CursorAndAsyncIterator; /** * [Delete tables in a database](https://doc.cognitedata.com/api/v1/#operation/deleteTables) * * ```js * await client.raw.deleteTables('My company', [{ name: 'Customers' }]); * ``` */ deleteTables: (databaseName: string, items: RawDBTableName[]) => Promise; /** * [Insert rows into a table](https://doc.cognitedata.com/api/v1/#operation/postRows) * * ```js * await client.raw.insertRows('My company', 'Customers', [{ key: 'customer1', columns: { 'First name': 'Steve', 'Last name': 'Jobs' } }]); * ``` */ insertRows: (databaseName: string, tableName: string, items: RawDBRowInsert[], ensureParent?: boolean) => Promise; /** * [List rows in a table](https://doc.cognitedata.com/api/v1/#operation/getRows) * * ```js * await client.raw.listRows('My company', 'Employees', { columns: ['last_name'] }); * ``` */ listRows: (databaseName: string, tableName: string, query?: ListRawRows) => CursorAndAsyncIterator; /** * [Retrieve a single row from a table](https://doc.cognitedata.com/api/v1/#operation/getRow) * * ```js * await client.raw.retrieveRow('My company', 'Customers', 'customer1'); * ``` */ retrieveRow: (databaseName: string, tableName: string, rowKey: string) => Promise; /** * [Delete rows in a table](https://doc.cognitedata.com/api/v1/#operation/deleteRows) * * ```js * await client.raw.deleteRows('My company', 'Customers', [{key: 'customer1'}]); * ``` */ deleteRows: (databaseName: string, tableName: string, items: RawDBRowKey[]) => Promise; } export interface RawDatabaseDeleteParams { recursive?: boolean; }