idaListAccelerators, idaSetAccelerator, idaGetAccelerator, idaGetAcceleratorDetails {ibmdbR}

Show and set accelerator settings

Description

Use these functions for DB2 for z/OS connections to retrieve the list of available accelerators and to set and get the current accelerator settings.

Usage

idaListAccelerators()
idaSetAccelerator(acceleratorName, queryAcceleration="ENABLE")
idaGetAccelerator()
idaGetAcceleratorDetails()

Arguments

acceleratorName

The name of the accelerator where the analytics functions (like idaKMeans or idaTree) are executed.

queryAcceleration

The value which the DB2 for z/OS register CURRENT QUERY ACCELERATION is set to. Possible values are "NONE", ENABLE", "ENABLE WITH FALLBACK", "ELIGIBLE" and "ALL"

Value

idaListAccelerators returns a data frame that contains a list of the accelerators available for the current DB2 for z/OS connection.

idaSetAccelerator sets the accelerator to be used for the subsequent calls of the analytics functions.

idaGetAccelerator retrieves the name of the accelerator.

idaGetAcceleratorDetails retrieves the name of accelerator together with the encoding (like UNICODE or EBCDIC) of its data and the value for query acceleration (like ENABLE or ELIGIBLE) and returns these values in a list object with elements "Accelerator", "Encoding" and "QueryAcceleration".

Examples

## Not run: 
#Get a list of all accelerators
q <- idaListAccelerators();

#Set accelerator to "MYACCEL"
idaSetAccelerator("MYACCEL");

#Get name of current accelerator"
idaGetAccelerator();

#Get name of current accelerator together with its encoding and query acceleration"
idaGetAcceleratorDetails();

#Get encoding of current acccelerator
idaGetAcceleratorDetails()$Encoding

## End(Not run)