Skip to main content

Class: DataConnectionsDataSource

dg.DataConnectionsDataSource

Functionality for handling connections collection from server and working with credentials remote endpoint Allows to manage DataConnection See also: https://datagrok.ai/help/govern/security

Hierarchy

Constructors

constructor

new DataConnectionsDataSource(s)

Constructs

DataConnectionsDataSource

Parameters

NameType
sany

Overrides

HttpDataSource.constructor

Defined in

src/dapi.ts:600

Properties

clsName

clsName: string

Inherited from

HttpDataSource.clsName

Defined in

src/dapi.ts:249


dart

dart: any

Inherited from

HttpDataSource.dart

Defined in

src/dapi.ts:248

Methods

allPackageVersions

allPackageVersions(): HttpDataSource<DataConnection>

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

Returns

HttpDataSource<DataConnection>

Inherited from

HttpDataSource.allPackageVersions

Defined in

src/dapi.ts:305


by

by(i): HttpDataSource<DataConnection>

Parameters

NameType
inumber

Returns

HttpDataSource<DataConnection>

Inherited from

HttpDataSource.by

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>

Inherited from

HttpDataSource.count

Defined in

src/dapi.ts:275


delete

delete(e): Promise<void>

Deletes an entity.

Parameters

NameType
eEntity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

Defined in

src/dapi.ts:300


filter

filter(w): HttpDataSource<DataConnection>

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<DataConnection>

Inherited from

HttpDataSource.filter

Defined in

src/dapi.ts:336


find

find(id): Promise<DataConnection>

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<DataConnection>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

Defined in

src/dapi.ts:290


first

first(): Promise<DataConnection>

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

Returns

Promise<DataConnection>

Promise<object>

Inherited from

HttpDataSource.first

Defined in

src/dapi.ts:281


include

include(include): HttpDataSource<DataConnection>

Includes entity in the result

Parameters

NameType
includestring

Returns

HttpDataSource<DataConnection>

Inherited from

HttpDataSource.include

Defined in

src/dapi.ts:353


list

list(options?): Promise<DataConnection[]>

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<DataConnection[]>

Inherited from

HttpDataSource.list

Defined in

src/dapi.ts:260


nextPage

nextPage(): HttpDataSource<DataConnection>

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<DataConnection>

Inherited from

HttpDataSource.nextPage

Defined in

src/dapi.ts:325


order

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

Instructs data source to return results in the specified order.

Parameters

NameTypeDefault value
fieldNamestringundefined
descbooleanfalse

Returns

HttpDataSource<DataConnection>

Inherited from

HttpDataSource.order

Defined in

src/dapi.ts:345


page

page(i): HttpDataSource<DataConnection>

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

Parameters

NameType
inumber

Returns

HttpDataSource<DataConnection>

Inherited from

HttpDataSource.page

Defined in

src/dapi.ts:316


save

save(e, options?): Promise<DataConnection>

Saves the Connections

Parameters

NameType
eDataConnection
options?Object
options.saveCredentials?boolean

Returns

Promise<DataConnection>

Overrides

HttpDataSource.save

Defined in

src/dapi.ts:605


shareFolder

shareFolder(e, path): Promise<DataConnection>

Creates connection to the subdirectory of connection

Parameters

NameType
eDataConnection
pathstring

Returns

Promise<DataConnection>

Defined in

src/dapi.ts:612