DockerApplication-class: Application which serves as a backend for component which...

In keboola/r-docker-application: Interface for Keboola Connection component

Description

Application which serves as a backend for component which runs inside Docker with interface to docker-bundle.

Methods

getAction()

Get action parameter passed to the configuration

Return Value

Action parameter value

getExpectedOutputFiles()

Get files which are supposed to be returned when the application finishes.

Return Value

data.frame with output files

getExpectedOutputTables()

Get tables which are supposed to be returned when the application finishes.

Return Value

data.frame with expected output tables.

getFileManifest(fileName)

Get additional file information stored in file manifest.

Parameters

• fileName Destination file name (without .manifest extension).

Return Value

List with manifest options

getInputFiles()

Get names of input files. Returns fully classified pathnames.

Return Value

List with file names

getInputTables()

Get input tables specified in the configuration file. Tables are identified by their destination (.csv file) or full_path.

Return Value

data.frame with output tables

getParameters()

Get arbitrary parameters specified in the configuration file.

Return Value

List with parameters

getTableManifest(tableName)

Get additional table information stored in table manifest.

Parameters

• tableName Destination table name (name of .csv file).

Return Value

List with manifest options

initialize(debugMode = FALSE)

Constructor.

Parameters

• debugMode Set higher logging level so that debug messages are printed.

readConfig()

Read configuration file. List with parsed configuration file structure is accessible as configData property.

Return Value

TRUE

writeFileManifest(fileName, fileTags = vector(), isPublic = FALSE, isPermanent = TRUE, notify = FALSE)

Write manifest for output file. Manifest is used for the file to be stored in KBC Storage. List with parsed configuration file structure is accessible as configData property.

Parameters

• fileName Local file name of the file to be stored, including path.

• fileTags Vector of file tags.

• isPublic Logical true if the file should be stored as public.

• isPermananet Logical false if the file should be stored only temporarily (for days) otherwise it will be stored until deleted.

• notify Logical TRUE if members of the project should be notified about the file upload.

Return Value

TRUE

writeTableManifest(fileName, destination = NULL, primaryKey = vector(), columns = vector(), incremental = FALSE, metadata = list(), columnMetadata = list(), deleteWhere = list())

Write manifest for output table Manifest is used for the table to be stored in KBC Storage.

Parameters

• fileName Local file name of the CSV with table data.

• destination String name of the table in Storage.

• primaryKey Vector of columns used for primary key.

• columns Vector of columns names for headless CSV file.

• incremental Set to TRUE to enable incremental loading.

• metadata Key value list of table metadata.

• columnMetadata List indexed by column name of key-value list of column metadata.

• deleteWhere List with items 'column', 'values', 'operator' to specify rows to delete.

Return Value

TRUE

keboola/r-docker-application documentation built on May 20, 2019, 8:34 a.m.