Class: HttpDataSource<T>

dg.HttpDataSource

Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource)

Type parameters

Name
T

Hierarchy

• HttpDataSource

  ↳ UsersDataSource

  ↳ GroupsDataSource

  ↳ EntitiesDataSource

  ↳ DataConnectionsDataSource

  ↳ FuncsDataSource

  ↳ CredentialsDataSource

  ↳ LayoutsDataSource

  ↳ ViewsDataSource

  ↳ ProjectsDataSource

  ↳ TablesDataSource

  ↳ DockerImagesDataSource

  ↳ DockerContainersDataSource

Constructors

constructor

• new HttpDataSource<T>(s, clsName?)

Constructs

HttpDataSource

Type parameters

Name
T

Parameters

Name	Type
s	any
clsName?	null | string

Defined in

src/dapi.ts:252

Properties

clsName

• clsName: string

Defined in

src/dapi.ts:249

---

dart

• dart: any

Defined in

src/dapi.ts:248

Methods

allPackageVersions

▸ allPackageVersions(): HttpDataSource<T>

Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:305

---

by

▸ by(i): HttpDataSource<T>

Parameters

Name	Type
i	number

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:310

---

count

▸ count(): Promise<number>

Counts entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Returns

Promise<number>

Defined in

src/dapi.ts:275

---

delete

▸ delete(e): Promise<void>

Deletes an entity.

Parameters

Name	Type
e	Entity

Returns

Promise<void>

Defined in

src/dapi.ts:300

---

filter

▸ filter(w): HttpDataSource<T>

Applies filter to current request. Also can be set with list method "options" parameter See example: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Parameters

Name	Type
w	string

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:336

---

find

▸ find(id): Promise<T>

Returns an entity with the specified id. Throws an exception if an entity does not exist, or is not accessible in the current context. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Name	Type	Description
id	string	GUID of the corresponding object

Returns

Promise<T>

{Promise<object>} - entity.

Defined in

src/dapi.ts:290

---

first

▸ first(): Promise<T>

Returns fist entity that satisfies the filtering criteria (see filter).

Returns

Promise<T>

Promise<object>

Defined in

src/dapi.ts:281

---

include

▸ include(include): HttpDataSource<T>

Includes entity in the result

Parameters

Name	Type
include	string

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:353

---

list

▸ list(options?): Promise<T[]>

Returns all entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Parameters

Name	Type
options	Object
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<T[]>

Defined in

src/dapi.ts:260

---

nextPage

▸ nextPage(): HttpDataSource<T>

Returns next page of all entities that satisfy the filtering criteria (see filter). Works only if pageSize was set during previous list() call See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:325

---

order

▸ order(fieldName, desc?): HttpDataSource<T>

Instructs data source to return results in the specified order.

Parameters

Name	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:345

---

page

▸ page(i): HttpDataSource<T>

Restricts results to the specified page number. See also nextPage.

Parameters

Name	Type
i	number

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:316

---

save

▸ save(e): Promise<T>

Saves an entity.

Parameters

Name	Type
e	Entity

Returns

Promise<T>

Defined in

src/dapi.ts:295