API reference

This page provides an auto-generated summary of RBC’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation and check the Notebooks folder in the main repository.

Top-level functions

ctools
external	Low-level intrinsics to expose external functions
heavydb
remotejit	RemoteJIT client/server config functions
targetinfo	TargetInfo class specific

HeavyDB Backend

The table below contains the data structures available for the HeavyDB backend. It should be noticed that the following types are not regular Python types but Numba types.

The set of types below are only materialize inside the HeavyDB SQL Engine. Thus, one cannot create and use them inside the REPL, for instance.

Array Types

heavydb.Array(size, dtype)

RBC Array<T> type that corresponds to HeavyDB ARRAY

Column Types

heavydb.Column()	RBC Column<T> type that corresponds to HeavyDB COLUMN
heavydb.ColumnArray()	RBC Column<Array<T>> type that corresponds to HeavyDB COLUMN<ARRAY<T>>
heavydb.ColumnListArray()	RBC ColumnList<Array<T>> type that corresponds to HeavyDB COLUMN LIST of arrays.
heavydb.ColumnList()	RBC ColumnList<T> type that corresponds to HeavyDB COLUMN LIST
heavydb.ColumnGeoPoint()	RBC Column<GeoPoint> type that corresponds to HeavyDB COLUMN<POINT>
heavydb.ColumnGeoMultiPoint()	RBC Column<GeoMultiPoint> type that corresponds to HeavyDB COLUMN<MULTIPOINT>
heavydb.ColumnGeoLineString()	RBC Column<GeoLineString> type that corresponds to HeavyDB COLUMN<LINESTRING>
heavydb.ColumnGeoMultiLineString()	RBC Column<GeoMultiLineString> type that corresponds to HeavyDB COLUMN<MULTILINESTRING>
heavydb.ColumnGeoPolygon()	RBC Column<GeoPolygon> type that corresponds to HeavyDB COLUMN<POLYGON>
heavydb.ColumnGeoMultiPolygon()	RBC Column<GeoMultiPolygon> type that corresponds to HeavyDB COLUMN<MULTIPOLYGON>
heavydb.ColumnTextEncodingNone()	RBC Column<TextEncodingNone> type that corresponds to HeavyDB COLUMN<TEXT_ENCODING_NONE>

Geo Types

heavydb.GeoLineString()	RBC GeoLineString type that corresponds to HeavyDB type LINESTRING.
heavydb.GeoMultiPoint()	RBC GeoMultiPoint type that corresponds to HeavyDB type MULTIPOINT.
heavydb.GeoMultiLineString()	RBC GeoMultiLineString type that corresponds to HeavyDB type MULTILINESTRING.
heavydb.GeoMultiPolygon()	RBC GeoMultiPolygon type that corresponds to HeavyDB type MULTIPOLYGON.
heavydb.GeoPoint()	RBC GeoPoint type that corresponds to HeavyDB type POINT.
heavydb.GeoPolygon()	RBC GeoPolygon type that corresponds to HeavyDB type POLYGON.

Text-related Types

heavydb.TextEncodingDict()	RBC TextEncodingDict type that corresponds to HeavyDB type TEXT ENCODED DICT.
heavydb.StringDictionaryProxy()
heavydb.TextEncodingNone(size)	RBC TextEncodingNone type that corresponds to HeavyDB type TEXT ENCODED NONE.

Row/Table Function Manager

heavydb.RowFunctionManager()	TableFunctionManager is available in HeavyDB 6.2 or newer
heavydb.TableFunctionManager()	TableFunctionManager is available in HeavyDB 5.9 or newer

Time-related Types

heavydb.DayTimeInterval(timeval)	RBC DayTimeInterval type.
heavydb.Timestamp(time)	RBC Timestamp type that corresponds to HeavyDB type TIMESTAMP.
heavydb.YearMonthTimeInterval(timeval)	RBC YearMonthTimeInterval type.

Array API

stdlib.constants	Array API specification for creation functions.
stdlib.creation_functions	Array API specification for creation functions.
stdlib.datatypes	Array API specification for data types.
stdlib.data_type_functions	Array API specification for data type functions.
stdlib.elementwise_functions	Array API specification for element-wise functions.
stdlib.linear_algebra_functions	Array API specification for linear algebra functions.
stdlib.manipulation_functions	Array API specification for manipulation functions.
stdlib.searching_functions	Array API specification for searching functions.
stdlib.set_functions	Array API specification for set functions.
stdlib.sorting_functions	Array API specification for sorting functions.
stdlib.statistical_functions	Array API specification for statistical functions.
stdlib.utility_functions	Array API specification for utility functions.

Externals

externals.cmath	https://en.cppreference.com/w/c/numeric/math
externals.libdevice	https://docs.nvidia.com/cuda/libdevice-users-guide/index.html
externals.macros	This module provides the following tools:
externals.heavydb	External functions defined by the HeavyDB server
externals.stdio	https://en.cppreference.com/w/c/io