HttpDataSource<T>
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)
Extended by
UsersDataSourceGroupsDataSourceEntitiesDataSourceDataConnectionsDataSourceFuncsDataSourceCredentialsDataSourceLayoutsDataSourceViewsDataSourceProjectsDataSourceTablesDataSourceDockerImagesDataSourceDockerContainersDataSourceUserReportsDataSourceUserReportsRulesDataSource
Type parameters
| Type parameter |
|---|
T |
Constructors
new HttpDataSource()
new HttpDataSource<
T>(s,clsName?):HttpDataSource<T>
Parameters
| Parameter | Type |
|---|---|
s | any |
clsName? | null | string |
Returns
Constructs
HttpDataSource
Source
Properties
| Property | Type |
|---|---|
clsName | string |
dart | any |
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
Source
by()
by(
i):HttpDataSource<T>
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
Source
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>
Source
delete()
delete(
e):Promise<void>
Deletes an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise<void>
Source
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
| Parameter | Type | Description |
|---|---|---|
w | string |
Returns
Source
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
| Parameter | Type | Description |
|---|---|---|
id | string | GUID of the corresponding object |
Returns
Promise<T>
{Promise<object>} - entity.
Source
first()
first():
Promise<T>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise<T>
Promise<object>
Source
include()
include(
include):HttpDataSource<T>
Includes entity in the result
Parameters
| Parameter | Type | Description |
|---|---|---|
include | string |
Returns
Source
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
| Parameter | Type |
|---|---|
options | object |
options.filter? | string |
options.order? | string |
options.pageNumber? | number |
options.pageSize? | number |
Returns
Promise<T[]>
Source
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
Source
order()
order(
fieldName,desc):HttpDataSource<T>
Instructs data source to return results in the specified order.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
fieldName | string | undefined | |
desc | boolean | false |
Returns
Source
page()
page(
i):HttpDataSource<T>
Restricts results to the specified page number. See also nextPage.
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
Source
save()
save(
e):Promise<T>
Saves an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise<T>