Class: DockerContainersDataSource
dg.DockerContainersDataSource
Functionality to work with Docker containers. See help: https://datagrok.ai/help/develop/how-to/docker_containers.
Hierarchy
HttpDataSource<DockerContainer>↳
DockerContainersDataSource
Constructors
constructor
• new DockerContainersDataSource(s)
Parameters
| Name | Type |
|---|---|
s | any |
Overrides
Defined in
Properties
clsName
• clsName: string
Inherited from
Defined in
dart
• dart: any
Inherited from
Defined in
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
Defined in
by
▸ by(i): HttpDataSource<DockerContainer>
Parameters
| Name | Type |
|---|---|
i | number |
Returns
HttpDataSource<DockerContainer>
Inherited from
Defined in
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
Defined in
delete
▸ delete(e): Promise<void>
Deletes an entity.
Parameters
| Name | Type |
|---|---|
e | Entity |
Returns
Promise<void>
Inherited from
Defined in
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
| Name | 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.
Defined in
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/smart-search
Parameters
| Name | Type |
|---|---|
w | string |
Returns
HttpDataSource<DockerContainer>
Inherited from
Defined in
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
| Name | Type | Description |
|---|---|---|
id | string | GUID of the corresponding object |
Returns
Promise<DockerContainer>
{Promise<object>} - entity.
Inherited from
Defined in
first
▸ first(): Promise<DockerContainer>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise<DockerContainer>
Promise<object>
Inherited from
Defined in
getContainerLogs
▸ getContainerLogs(containerId, limit?): Promise<null | string>
Returns container's logs or throws Exception with the cause.
Parameters
| Name | 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.
Defined in
include
▸ include(include): HttpDataSource<DockerContainer>
Includes entity in the result
Parameters
| Name | Type |
|---|---|
include | string |
Returns
HttpDataSource<DockerContainer>
Inherited from
Defined in
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
| Name | Type |
|---|---|
options | Object |
options.filter? | string |
options.order? | string |
options.pageNumber? | number |
options.pageSize? | number |
Returns
Promise<DockerContainer[]>
Inherited from
Defined in
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
Defined in
order
▸ order(fieldName, desc?): HttpDataSource<DockerContainer>
Instructs data source to return results in the specified order.
Parameters
| Name | Type | Default value |
|---|---|---|
fieldName | string | undefined |
desc | boolean | false |
Returns
HttpDataSource<DockerContainer>
Inherited from
Defined in
page
▸ page(i): HttpDataSource<DockerContainer>
Restricts results to the specified page number. See also nextPage.
Parameters
| Name | Type |
|---|---|
i | number |
Returns
HttpDataSource<DockerContainer>
Inherited from
Defined in
request
▸ request(id, path, params): Promise<null | string>
Deprecated
The method will be removed soon. Use fetchProxy.
Parameters
| Name | Type |
|---|---|
id | string |
path | string |
params | ResponseInit |
Returns
Promise<null | string>
Defined in
run
▸ run(containerId, awaitStart?): Promise<void>
Runs container.
Parameters
| Name | 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.
Defined in
save
▸ save(e): Promise<DockerContainer>
Saves an entity.
Parameters
| Name | Type |
|---|---|
e | Entity |
Returns
Promise<DockerContainer>
Inherited from
Defined in
stop
▸ stop(containerId, awaitStop?): Promise<void>
Stops container.
Parameters
| Name | 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.