DockerContainersDataSource
Functionality to work with Docker containers. See help: https://datagrok.ai/help/develop/how-to/docker_containers.
Extends
Constructors
new DockerContainersDataSource()
new DockerContainersDataSource(
s):DockerContainersDataSource
Parameters
| Parameter | Type |
|---|---|
s | any |
Returns
Overrides
Source
Properties
| Property | Type | Inherited from |
|---|---|---|
clsName | string | HttpDataSource.clsName |
dart | any | HttpDataSource.dart |
Methods
allPackageVersions()
allPackageVersions():
HttpDataSource<DockerContainer>
Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *
Returns
HttpDataSource <DockerContainer>
Inherited from
HttpDataSource . allPackageVersions
Source
by()
by(
i):HttpDataSource<DockerContainer>
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
HttpDataSource <DockerContainer>
Inherited from
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>
Inherited from
Source
delete()
delete(
e):Promise<void>
Deletes an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise<void>
Inherited from
Source
fetchProxy()
fetchProxy(
containerId,path,params?):Promise<Response>
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.
Source
filter()
filter(
w):HttpDataSource<DockerContainer>
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/navigation/views/browse#entity-search
Parameters
| Parameter | Type | Description |
|---|---|---|
w | string |
Returns
HttpDataSource <DockerContainer>
Inherited from
Source
find()
find(
id):Promise<DockerContainer>
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
Source
first()
first():
Promise<DockerContainer>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise <DockerContainer>
Promise<object>
Inherited from
Source
getContainerLogs()
getContainerLogs(
containerId,limit):Promise<null|string>
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<null | string>
string - container logs or null if there are no logs.
Source
include()
include(
include):HttpDataSource<DockerContainer>
Includes entity in the result
Parameters
| Parameter | Type | Description |
|---|---|---|
include | string |
Returns
HttpDataSource <DockerContainer>
Inherited from
Source
list()
list(
options):Promise<DockerContainer[]>
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 <DockerContainer[]>
Inherited from
Source
nextPage()
nextPage():
HttpDataSource<DockerContainer>
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 <DockerContainer>
Inherited from
Source
order()
order(
fieldName,desc):HttpDataSource<DockerContainer>
Instructs data source to return results in the specified order.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
fieldName | string | undefined | |
desc | boolean | false |
Returns
HttpDataSource <DockerContainer>
Inherited from
Source
page()
page(
i):HttpDataSource<DockerContainer>
Restricts results to the specified page number. See also nextPage.
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
HttpDataSource <DockerContainer>
Inherited from
Source
run()
run(
containerId,awaitStart):Promise<void>
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.
Source
save()
save(
e):Promise<DockerContainer>
Saves an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise <DockerContainer>
Inherited from
Source
stop()
stop(
containerId,awaitStop):Promise<void>
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.
Source
webSocketProxy()
webSocketProxy(
containerId,path,timeout):Promise<WebSocket>
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>
Source
webSocketProxySync()
webSocketProxySync(
containerId,path,timeout):WebSocket
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