Skip to main content

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

Constructors

constructor

new HttpDataSource<T>(s, clsName?)

Constructs

HttpDataSource

Type parameters

Name
T

Parameters

NameType
sany
clsName?null | string

Defined in

src/dapi.ts:249

Properties

clsName

clsName: string

Defined in

src/dapi.ts:246


dart

dart: any

Defined in

src/dapi.ts:245

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:302


by

by(i): HttpDataSource<T>

Parameters

NameType
inumber

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:307


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:272


delete

delete(e): Promise<void>

Deletes an entity.

Parameters

NameType
eEntity

Returns

Promise<void>

Defined in

src/dapi.ts:297


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

NameType
wstring

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:333


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

NameTypeDescription
idstringGUID of the corresponding object

Returns

Promise<T>

{Promise<object>} - entity.

Defined in

src/dapi.ts:287


first

first(): Promise<T>

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

Returns

Promise<T>

Promise<object>

Defined in

src/dapi.ts:278


include

include(include): HttpDataSource<T>

Includes entity in the result

Parameters

NameType
includestring

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:350


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

NameType
optionsObject
options.filter?string
options.order?string
options.pageNumber?number
options.pageSize?number

Returns

Promise<T[]>

Defined in

src/dapi.ts:257


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:322


order

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

Instructs data source to return results in the specified order.

Parameters

NameTypeDefault value
fieldNamestringundefined
descbooleanfalse

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:342


page

page(i): HttpDataSource<T>

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

Parameters

NameType
inumber

Returns

HttpDataSource<T>

Defined in

src/dapi.ts:313


save

save(e): Promise<T>

Saves an entity.

Parameters

NameType
eEntity

Returns

Promise<T>

Defined in

src/dapi.ts:292