API reference

• 1: C++ SDK
• 2: Java SDK
• 3: R SDK
• 3.1: Main function
• 3.2: Factory function
• 3.3: Outtypecallback function
• 3.4: Parametertypecallback function
• 4: Python SDK
• 5: JDBC API

1 - C++ SDK

2 - Java SDK

3 - R SDK

Welcome to the Vertica R SDK API Documentation. This documentation covers all of the functions that make up the R SDK. Using this API, you can create User Defined Extensions (UDxs) that integrate your own features into the Vertica Analytics Platform.

To learn how UDxs work and how to develop, compile, and deploy them, see Developing user-defined extensions (UDxs).

3.1 - Main function

The first function called when Vertica runs an R user-defined extension (UDx). It must return a data frame and is defined by the name parameter of the factory function.

Example

FunctionName <- function(input_data_frame, parameters_data_frame) {
  # Each column from Vertica is turned into a column in the input data frame.
  # This is a brief example of multiplying two columns of the input data frame.
  output_data_frame <- data.frame(input_data_frame[, 1] * input_data_frame[, 2])
  # The function must return a data frame.
  return(output_data_frame)
}

Arguments

Description

The main function takes as input one data frame as the first argument, and if your UDx accepts parameters, a parameter data frame as the second argument. The main function must return a data frame. The factory function converts the intype argument into a data frame for the main function. For example, intype=c("float","float") is converted by the factory function into a two-dimensional matrix.

The function can call other functions defined in your R UDx library file.

3.2 - Factory function

The factory function consists of an R list which specifies the parameters of your R user-defined extension (UDx).

Example

FunctionNameFactory <- function() {
  list(name                  = MainFunctionName,
       udxtype               = c("scalar"),
       intype                = c("float","int", ...),
       outtype               = c("float", ...),
       outtypecallback       = MyReturnTypeFunc,
       parametertypecallback = MyParamReturnFunc,
       volatility            = c("volatile"),
       strictness            = c("called_on_null_input") )
}

Arguments

Description

User-defined functions in R (R UDx) require a factory function for each main R function that you want to call from within Vertica. The factory function encapsulates all the information required by Vertica to load the R UDx.

3.3 - Outtypecallback function

Function to define the column names, output data types, length/precision, and scale of the data being returned to Vertica.

Example

SalesTaxReturnTypes <- function(arguments.data.frame, parameters.data.frame) {
  output.return.type <- data.frame(datatype = rep(NA, 2),
                                   length   = rep(NA, 2),
                                   scale    = rep(NA, 2),
                                   name     = rep(NA, 2))
  output.return.type$datatype <- c("float", "float")
  output.return.type$name <- c("Sales Tax Rate", "Item Cost with Tax")
  return(output.return.type)
}

Arguments

Description

When creating the outtypecallback function, define one row for each value returned. Use the same order as in the outtype defined in the factory function. If any columns are left blank or the outtypecallback function is omitted, then Vertica uses default values.

datatype = c("long varchar")

3.4 - Parametertypecallback function

Function to define the output data type(s), length/precision, and scale of the parameters sent to the main function.

Example

FunctionNameParameterTypes <- function() {
  parameters <- list(datatype = c("int", "varchar"),
                     length   = c("NA", "100"),
                     scale    = c("NA", "NA"),
                     name     = c("k", "algorithm"))
  return(parameters)
}

Arguments

Description

When creating the parametertypecallback function, you define one row for each parameter being sent to the function. You must specify a parametertypecallback function if your UDx uses parameters.

The parametertypecallback does not accept any input arguments.

4 - Python SDK

5 - JDBC API