dsIsAsync: Asynchronous result support

dsIsAsyncR Documentation

Asynchronous result support

Description

When a DSResult-class object is returned on aggregation or assignment operation, the raw result can be accessed asynchronously, allowing parallelization of DataSHIELD calls over multpile servers. The returned named list of logicals will specify if asynchronicity is supported for: aggregation operation ('aggregate'), table assignment operation ('assignTable'), resource assignment operation ('assignResource') and expression assignment operation ('assignExpr').

\Sexpr[results=rd,stage=render]{DSI:::methods_as_rd("dsIsAsync")}

Usage

dsIsAsync(conn)

Arguments

conn

An object that inherits from DSConnection-class.

See Also

Other DSConnection generics: DSConnection-class, dsAggregate(), dsAssignExpr(), dsAssignResource(), dsAssignTable(), dsDisconnect(), dsGetInfo(), dsHasResource(), dsHasTable(), dsKeepAlive(), dsListMethods(), dsListPackages(), dsListProfiles(), dsListResources(), dsListSymbols(), dsListTables(), dsListWorkspaces(), dsRestoreWorkspace(), dsRmSymbol(), dsRmWorkspace(), dsSaveWorkspace()

Examples

## Not run: 
con <- dsConnect(DSOpal::Opal(), "server1",
  username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")
dsIsAsync(con)
dsDisconnect(con)

## End(Not run)

DSI documentation built on Oct. 6, 2022, 9:06 a.m.