DockerContainersDataSource

Defined in: js-api/src/dapi.ts:2069

Functionality to work with Docker containers. See help: https://datagrok.ai/help/develop/how-to/docker_containers.

Extends

• HttpDataSource<DockerContainer>

Constructors

Constructor

new DockerContainersDataSource(s): DockerContainersDataSource

Defined in: js-api/src/dapi.ts:2070

Parameters

Parameter	Type
s	any

Returns

DockerContainersDataSource

Overrides

HttpDataSource.constructor

Properties

Property	Type	Inherited from	Defined in
clsName	string	HttpDataSource.clsName	js-api/src/dapi.ts:323
dart	any	HttpDataSource.dart	js-api/src/dapi.ts:322

Methods

allPackageVersions()

allPackageVersions(): this

Defined in: js-api/src/dapi.ts:404

A source without package version isolation: entities of all package versions, not only the current one.

Returns

this

Inherited from

HttpDataSource.allPackageVersions

---

by()

by(i): this

Defined in: js-api/src/dapi.ts:409

A source that returns at most [i] entities per page. See also page.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

Defined in: js-api/src/dapi.ts:375

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

---

delete()

delete(e): Promise<void>

Defined in: js-api/src/dapi.ts:399

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

fetchProxy()

fetchProxy(containerId, path, params?): Promise<Response>

Defined in: js-api/src/dapi.ts:2104

Proxies URL requests to Docker containers via Datagrok server with the same interface as fetch. Returns response from the containers as it is. If an error occurs on the server side returns a response with "application/json" Content-Type and JSON body with field "datagrok-error" that describes the cause. If container status is incorrect for performing requests returns a response with a 400 status code. If something goes wrong in the server workflow, it returns a response with a 500 status code. Any other cases are the result of direct requests to the container itself.

Parameters

Parameter	Type	Description
containerId	string	ID of the DockerContainer to which the http request should be sent.
path	string	URI without scheme and authority component.
params?	RequestInit	parameters of the request.

Returns

Promise<Response>

promise that resolves with Response.

---

filter()

filter(w): this

Defined in: js-api/src/dapi.ts:429

A source filtered by [w]; replaces the filter of this source, if any. 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/concepts/objects#entity-search

Parameters

Parameter	Type
w	string

Returns

this

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<DockerContainer>

Defined in: js-api/src/dapi.ts:389

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

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

---

first()

first(): Promise<DockerContainer>

Defined in: js-api/src/dapi.ts:380

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

Returns

Promise<DockerContainer>

Inherited from

HttpDataSource.first

---

getContainerLogs()

getContainerLogs(containerId, limit?): Promise<string | null>

Defined in: js-api/src/dapi.ts:2222

Returns container's logs or throws Exception with the cause.

Parameters

Parameter	Type	Default value	Description
containerId	string	undefined	ID of the DockerContainer whose logs is to be obtained.
limit	number	10000	maximum line count of logs.

Returns

Promise<string | null>

string - container logs or null if there are no logs.

---

include()

include(include): this

Defined in: js-api/src/dapi.ts:439

A source that also loads the [include]d properties of every entity (adds to this source's includes).

Parameters

Parameter	Type
include	string

Returns

this

Inherited from

HttpDataSource.include

---

list()

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

Defined in: js-api/src/dapi.ts:359

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	{ filter?: string; order?: string; pageNumber?: number; pageSize?: number; }
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<DockerContainer[]>

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

Defined in: js-api/src/dapi.ts:421

A source for the page after this one (the first call gives page 1). Reassign to advance: source = source.nextPage(). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

this

Inherited from

HttpDataSource.nextPage

---

order()

order(fieldName, desc?): this

Defined in: js-api/src/dapi.ts:434

A source ordered by [fieldName]; replaces the order of this source, if any.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

this

Inherited from

HttpDataSource.order

---

page()

page(i): this

Defined in: js-api/src/dapi.ts:414

A source restricted to page [i]. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

run()

run(containerId, awaitStart?): Promise<void>

Defined in: js-api/src/dapi.ts:2080

Runs container.

Parameters

Parameter	Type	Default value	Description
containerId	string	undefined	ID of the DockerContainer to be run.
awaitStart	boolean	false	if [true] promise will not be resolved until the container is started, otherwise, it doesn't wait for start and resolves immediately after the container is queued for start.

Returns

Promise<void>

promise that resolves with void or throws Exception if something went wrong.

---

save()

save(e): Promise<DockerContainer>

Defined in: js-api/src/dapi.ts:394

Saves an entity; the saved copy comes back with this source's includes loaded.

Parameters

Parameter	Type
e	Entity

Returns

Promise<DockerContainer>

Inherited from

HttpDataSource.save

---

stop()

stop(containerId, awaitStop?): Promise<void>

Defined in: js-api/src/dapi.ts:2090

Stops container.

Parameters

Parameter	Type	Default value	Description
containerId	string	undefined	ID of the DockerContainer to be stopped.
awaitStop	boolean	false	if [true] promise will not be resolved until the container is stopped, otherwise, it doesn't wait for a stop and resolves immediately after the container is queued for a stop.

Returns

Promise<void>

or throws Exception if something went wrong.

---

webSocketProxy()

webSocketProxy(containerId, path, timeout?): Promise<WebSocket>

Defined in: js-api/src/dapi.ts:2120

Proxies WebSocket connection to Docker containers via Datagrok server. Returns ready WebSocket that is connected through the server to the Docker container WebSocket endpoint. If container status is incorrect or there is error while establishing WebSocket connection to Docker container, caller will receive an error. After the WebSocket is returned, caller can do anything with it and should take care of reconnection. After the caller closes the connection, server will close proxied Docker WebSocket connection.

Parameters

Parameter	Type	Default value	Description
containerId	string	undefined	ID of the DockerContainer to which the WebSocket connection will be established.
path	string	undefined	URI without scheme and authority component that points to endpoint inside the Docker container
timeout	number	60000	Timeout in ms for initial connection establishment. Set it to higher values if you are using container with on_demand configuration set to true.

Returns

Promise<WebSocket>

---

webSocketProxySync()

webSocketProxySync(containerId, path, timeout?): WebSocket

Defined in: js-api/src/dapi.ts:2174

This is the synchronous version of the function webSocketProxy. Note that the container won't be ready to accept messages immediately after this function returns. If your application logic requires sending a message right away, consider using the asynchronous version.

Parameters

Parameter	Type	Default value	Description
containerId	string	undefined	ID of the DockerContainer to which the WebSocket connection will be established.
path	string	undefined	URI without scheme and authority component that points to endpoint inside the Docker container
timeout	number	60000	Timeout in ms for initial connection establishment. Set it to higher values if you are using container with on_demand configuration set to true.

Returns

WebSocket

---

with()

protected with(patch): this

Defined in: js-api/src/dapi.ts:334

A copy of this source whose query has [patch] applied. The Dart handle is shared; its state is rebuilt from the query right before every request, so the copies never observe each other.

Parameters

Parameter	Type
patch	Partial<DataSourceQuery>

Returns

this

Inherited from

HttpDataSource.with