Package io.tiledb.cloud

Class TileDBUDF

java.lang.Object

io.tiledb.cloud.TileDBUDF

public class TileDBUDF
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
TileDBUDF(TileDBClient tileDBClient, java.lang.String namespace)

Method Summary

Modifier and Type	Method	Description
java.lang.String	executeGeneric(GenericUDF genericUDF)	Executes a generic-UDF.
java.lang.String	executeGeneric(GenericUDF genericUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a generic-UDF.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeGenericArrow(GenericUDF genericUDF)	Executes a generic-UDF.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeGenericArrow(GenericUDF genericUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a generic-UDF.
org.json.JSONObject	executeGenericJSON(GenericUDF genericUDF)	Executes a generic-UDF.
org.json.JSONObject	executeGenericJSON(GenericUDF genericUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a generic-UDF.
org.json.JSONArray	executeGenericJSONArray(GenericUDF genericUDF)	Executes a generic-UDF.
org.json.JSONArray	executeGenericJSONArray(GenericUDF genericUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a generic-UDF.
java.lang.String	executeMultiArray(MultiArrayUDF multiArrayUDF)	Executes a multi-array-UDF.
java.lang.String	executeMultiArray(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a multi-array-UDF.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeMultiArrayArrow(MultiArrayUDF multiArrayUDF)	Executes a multi-array-UDF.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeMultiArrayArrow(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a multi-array-UDF.
org.json.JSONObject	executeMultiArrayJSON(MultiArrayUDF multiArrayUDF)	Executes a multi-array-UDF.
org.json.JSONObject	executeMultiArrayJSON(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a multi-array-UDF.
org.json.JSONArray	executeMultiArrayJSONArray(MultiArrayUDF multiArrayUDF)	Executes a multi-array-UDF.
org.json.JSONArray	executeMultiArrayJSONArray(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments)	Executes a multi-array-UDF.
java.lang.String	executeSingleArray(GenericUDF genericUDF, UDFArrayDetails array, QueryRanges queryRanges, java.lang.String xPayer)	Executes an array-UDF.
java.lang.String	executeSingleArray(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments, java.lang.String arrayURI, java.lang.String xPayer)	Deprecated.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeSingleArrayArrow(GenericUDF genericUDF, UDFArrayDetails array, QueryRanges queryRanges, java.lang.String xPayer)	Executes an array-UDF.
Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer>	executeSingleArrayArrow(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments, java.lang.String arrayURI, java.lang.String xPayer)	Deprecated.
org.json.JSONObject	executeSingleArrayJSON(GenericUDF genericUDF, UDFArrayDetails array, QueryRanges queryRanges, java.lang.String xPayer)	Executes an array-UDF.
org.json.JSONObject	executeSingleArrayJSON(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments, java.lang.String arrayURI, java.lang.String xPayer)	Deprecated.
org.json.JSONArray	executeSingleArrayJSONArray(GenericUDF genericUDF, UDFArrayDetails array, QueryRanges queryRanges, java.lang.String xPayer)	Executes an array-UDF.
org.json.JSONArray	executeSingleArrayJSONArray(MultiArrayUDF multiArrayUDF, java.util.HashMap<java.lang.String,java.lang.Object> arguments, java.lang.String arrayURI, java.lang.String xPayer)	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TileDBUDF

public TileDBUDF(TileDBClient tileDBClient,
                 java.lang.String namespace)

Method Detail

executeGeneric

public java.lang.String executeGeneric(GenericUDF genericUDF,
                                       java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

arguments - The UDF arguments

Returns:

The result in String format

executeGeneric

public java.lang.String executeGeneric(GenericUDF genericUDF)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

Returns:

The result in String format

executeGenericJSON

public org.json.JSONObject executeGenericJSON(GenericUDF genericUDF,
                                              java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

arguments - The UDF arguments

Returns:

The result as a JSON object

executeGenericJSON

public org.json.JSONObject executeGenericJSON(GenericUDF genericUDF)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

Returns:

The result as a JSON object

executeGenericJSONArray

public org.json.JSONArray executeGenericJSONArray(GenericUDF genericUDF,
                                                  java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

arguments - The UDF arguments

Returns:

The result as a JSON array object

executeGenericJSONArray

public org.json.JSONArray executeGenericJSONArray(GenericUDF genericUDF)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

Returns:

The result as a JSON array object

executeGenericArrow

public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeGenericArrow(GenericUDF genericUDF,
                                                                                                                  java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

arguments - The UDF arguments

Returns:

A pair that consists of an ArrayList of all valueVectors and the number of batches read.

executeGenericArrow

public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeGenericArrow(GenericUDF genericUDF)

Executes a generic-UDF. A generic-UDF is a UDF that is not using a TIleDB array.

Parameters:

genericUDF - The generic UDF definition

Returns:

A pair that consists of an ArrayList of all valueVectors and the number of batches read.

executeSingleArray

@Deprecated
public java.lang.String executeSingleArray(MultiArrayUDF multiArrayUDF,
                                           java.util.HashMap<java.lang.String,java.lang.Object> arguments,
                                           java.lang.String arrayURI,
                                           java.lang.String xPayer)

Deprecated.

executeSingleArray

public java.lang.String executeSingleArray(GenericUDF genericUDF,
                                           UDFArrayDetails array,
                                           QueryRanges queryRanges,
                                           java.lang.String xPayer)

Executes an array-UDF. An array-UDF is a UDF applied to a TileDB array

Parameters:

genericUDF - The UDF to run

array - The Array to run the UDF on

queryRanges - the Query ranges

xPayer - Name of organization or user who should be charged for this request

Returns:

The results as a String

executeSingleArrayJSON

@Deprecated
public org.json.JSONObject executeSingleArrayJSON(MultiArrayUDF multiArrayUDF,
                                                  java.util.HashMap<java.lang.String,java.lang.Object> arguments,
                                                  java.lang.String arrayURI,
                                                  java.lang.String xPayer)

Deprecated.

executeSingleArrayJSON

public org.json.JSONObject executeSingleArrayJSON(GenericUDF genericUDF,
                                                  UDFArrayDetails array,
                                                  QueryRanges queryRanges,
                                                  java.lang.String xPayer)

Executes an array-UDF. An array-UDF is a UDF applied to a TileDB array

Parameters:

genericUDF - The UDF to run

array - The Array to run the UDF on

queryRanges - the Query ranges

xPayer - Name of organization or user who should be charged for this request

Returns:

The results as a JSON Object

executeSingleArrayJSONArray

@Deprecated
public org.json.JSONArray executeSingleArrayJSONArray(MultiArrayUDF multiArrayUDF,
                                                      java.util.HashMap<java.lang.String,java.lang.Object> arguments,
                                                      java.lang.String arrayURI,
                                                      java.lang.String xPayer)

Deprecated.

executeSingleArrayJSONArray

public org.json.JSONArray executeSingleArrayJSONArray(GenericUDF genericUDF,
                                                      UDFArrayDetails array,
                                                      QueryRanges queryRanges,
                                                      java.lang.String xPayer)

Executes an array-UDF. An array-UDF is a UDF applied to a TileDB array

Parameters:

genericUDF - The UDF to run

array - The Array to run the UDF on

queryRanges - the Query ranges

xPayer - Name of organization or user who should be charged for this request

Returns:

The results as a JSON Object

executeSingleArrayArrow

@Deprecated
public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeSingleArrayArrow(MultiArrayUDF multiArrayUDF,
                                                                                                                      java.util.HashMap<java.lang.String,java.lang.Object> arguments,
                                                                                                                      java.lang.String arrayURI,
                                                                                                                      java.lang.String xPayer)

Deprecated.

executeSingleArrayArrow

public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeSingleArrayArrow(GenericUDF genericUDF,
                                                                                                                      UDFArrayDetails array,
                                                                                                                      QueryRanges queryRanges,
                                                                                                                      java.lang.String xPayer)

Executes an array-UDF. An array-UDF is a UDF applied to a TileDB array

Parameters:

genericUDF - The UDF to run

array - The Array to run the UDF on

queryRanges - the Query ranges

xPayer - Name of organization or user who should be charged for this request

Returns:

The results in arrow format

executeMultiArray

public java.lang.String executeMultiArray(MultiArrayUDF multiArrayUDF,
                                          java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

arguments - The arguments

Returns:

The results as a String

executeMultiArray

public java.lang.String executeMultiArray(MultiArrayUDF multiArrayUDF)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

Returns:

The results as a String

executeMultiArrayJSON

public org.json.JSONObject executeMultiArrayJSON(MultiArrayUDF multiArrayUDF,
                                                 java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

arguments - The arguments

Returns:

The results as JSON object

executeMultiArrayJSON

public org.json.JSONObject executeMultiArrayJSON(MultiArrayUDF multiArrayUDF)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

Returns:

The results as JSON object

executeMultiArrayJSONArray

public org.json.JSONArray executeMultiArrayJSONArray(MultiArrayUDF multiArrayUDF,
                                                     java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

arguments - The arguments

Returns:

The results as JSON Array

executeMultiArrayJSONArray

public org.json.JSONArray executeMultiArrayJSONArray(MultiArrayUDF multiArrayUDF)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

Returns:

The results as JSON Array

executeMultiArrayArrow

public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeMultiArrayArrow(MultiArrayUDF multiArrayUDF,
                                                                                                                     java.util.HashMap<java.lang.String,java.lang.Object> arguments)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

arguments - The arguments

Returns:

The results in arrow format

executeMultiArrayArrow

public Pair<java.util.ArrayList<org.apache.arrow.vector.ValueVector>,java.lang.Integer> executeMultiArrayArrow(MultiArrayUDF multiArrayUDF)

Executes a multi-array-UDF. A multi- array-UDF is a UDF applied to multiple TileDB arrays

Parameters:

multiArrayUDF - The multiArrayUDF input object

Returns:

The results in arrow format