database/mariadb-columnstore-engine
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-columnstore-engine.git synced 2025-12-24 14:20:59 +03:00
Code Activity

MCOL-1201 Modify docs. Fix group concat bug

Browse Source
This commit is contained in:
David Hall
2018-05-15 13:15:45 -05:00
parent 06e9772310
commit c8c3b23e32
13 changed files with 75 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
utils/udfsdk/docs/source/usage/cmakelists.rst
View File

@@ -3,7 +3,7 @@
CMakeLists.txt
==============
For Columnstore 1.1, you compile your function by including it in the CMakeLists.txt file for the udfsdk.
For Columnstore 1.2, you compile your function by including it in the CMakeLists.txt file for the udfsdk.
You need only add the new .cpp files to the udfsdk_LIB_SRCS target list::

2
utils/udfsdk/docs/source/usage/compile.rst
View File

@@ -3,7 +3,7 @@
Compile
=======
To compile your function for Columnstore 1.1, simple recompile the udfsdk directory::
To compile your function for Columnstore 1.2, simply recompile the udfsdk directory::
cd utils/usdsdk
cmake .

6
utils/udfsdk/docs/source/usage/headerfile.rst
View File

@@ -5,7 +5,7 @@ Header file
Usually, each UDA(n)F function will have one .h and one .cpp file plus code for the mariadb UDAF plugin which may or may not be in a separate file. It is acceptable to put a set of related functions in the same files or use separate files for each.
The easiest way to create these files is to copy them an example closest to the type of function you intend to create.
The easiest way to create these files is to copy them from an example closest to the type of function you intend to create.
Your header file must have a class defined that will implement your function. This class must be derived from mcsv1_UDAF and be in the mcsv1sdk namespace. The following examples use the "allnull" UDAF.
@@ -29,9 +29,9 @@ allnull uses the Simple Data Model. See :ref:`complexdatamodel` to see how that
allnull() : mcsv1_UDAF(){};
virtual ~allnull(){};
virtual ReturnCode init(mcsv1Context* context, COL_TYPES& colTypes);
virtual ReturnCode init(mcsv1Context* context, ColumnDatum* colTypes);
virtual ReturnCode reset(mcsv1Context* context);
virtual ReturnCode nextValue(mcsv1Context* context, std::vector<ColumnDatum>& valsIn);
virtual ReturnCode nextValue(mcsv1Context* context, ColumnDatum* valsIn);
virtual ReturnCode subEvaluate(mcsv1Context* context, const UserData* userDataIn);
virtual ReturnCode evaluate(mcsv1Context* context, static_any::any& valOut);
};

4
utils/udfsdk/docs/source/usage/introduction.rst
View File

@@ -3,7 +3,7 @@ mcsv1_udaf Introduction
mcsv1_udaf is a C++ API for writing User Defined Aggregate Functions (UDAF) and User Defined Analytic Functions (UDAnF) for the MariaDB Columstore engine.
In Columnstore 1.1.0, functions written using this API must be compiled into the udfsdk and udf_mysql libraries of the Columnstore code branch.
In Columnstore 1.2, functions written using this API must be compiled into the udfsdk and udf_mysql libraries of the Columnstore code branch.
The API has a number of features. The general theme is, there is a class that represents the function, there is a context under which the function operates, and there is a data store for intermediate values.
@@ -18,5 +18,5 @@ The steps required to create a function are:
* :ref:`Compile udfsdk <compile>`.
* :ref:`Copy the compiled libraries <copylibs>` to the working directories.
In 1.1.0, Columnstore does not have a plugin framework, so the functions have to be compiled into the libraries that Columnstore already loads.
In 1.2, Columnstore does not have a plugin framework, so the functions have to be compiled into the libraries that Columnstore already loads.

29
utils/udfsdk/docs/source/usage/sourcefile.rst
View File

@@ -34,21 +34,17 @@ Or, if using the :ref:`complexdatamodel`, type cast the UserData to your UserDat
init()
------
.. c:function:: ReturnCode init(mcsv1Context* context, COL_TYPES& colTypes);
.. c:function:: ReturnCode init(mcsv1Context* context, ColumnDatum* colTypes);
:param context: The context object for this call.
:param colTypes: A list of the column types of the parameters.
:param colTypes: A list of the ColumnDatum used to access column types of the parameters. In init(), the columnData member is invalid.
COL_TYPES is defined as::
typedef std::vector<std::pair<std::string, CalpontSystemCatalog::ColDataType> >COL_TYPES;
see :ref:`ColDataTypes <coldatatype>`. In Columnstore 1.1, only one column is supported, so colTyoes will be of length one.
see :ref:`ColumnDatum`. In Columnstore 1.2, An arbitrary number of parameters is supported.
:returns: ReturnCode::ERROR or ReturnCode::SUCCESS
The init() method is where you sanity check the input, set the output type and set any run flags for this instance. init() is called one time from the mysqld process. All settings you do here are propagated through the system.
The init() method is where you sanity check the input datatypes, set the output type and set any run flags for this instance. init() is called one time from the mysqld process. All settings you do here are propagated through the system.
init() is the exception to type casting the UserData member of context. UserData has not been created when init() is called, so you shouldn't use it here.
@@ -60,13 +56,14 @@ If you're using :ref:`simpledatamodel`, you need to set the size of the structur
.. rubric:: Check parameter count and type
Each function expects a certain number of columns to entered as parameters in the SQL query. For columnstore 1.1, the number of parameters is limited to one.
Each function expects a certain number of columns to be entered as parameters in the SQL query. It is possible to create a UDAF that accepts a variable number of parameters. You can discover which ones were actually used in init(), and modify your function's behavior accordingly.
colTypes is a vector of each parameter name and type. The name is the colum name from the SQL query. You can use this information to sanity check for compatible type(s) and also to modify your functions behavior based on type. To do this, add members to your data struct to be tested in the other Methods. Set these members based on colDataTypes (:ref:`ColDataTypes <coldatatype>`).
colTypes is an array of ColumnData from which can be gleaned the type and name. The name is the column name from the SQL query. You can use this information to sanity check for compatible type(s) and also to modify your functions behavior based on type. To do this, add members to your data struct to be tested in the other Methods. Set these members based on colDataTypes (:ref:`ColDataTypes <coldatatype>`).
The actual number of paramters passed can be gotten from context->getParameterCount().
::
if (colTypes.size() < 1)
if (context->getParameterCount() < 1)
{
// The error message will be prepended with
// "The storage engine for the table doesn't support "
@@ -84,7 +81,7 @@ When you create your function using the SQL CREATE FUNCTION command, you must in
.. rubric:: Set width and scale
If you have secial requirements, especially if you might be dealing with decimal types::
If you have special requirements, especially if you might be dealing with decimal types::
context->setColWidth(8);
context->setScale(context->getScale()*2);
@@ -117,13 +114,11 @@ This function may be called multiple times from both the UM and the PM. Make no
nextValue()
-----------
.. c:function:: ReturnCode nextValue(mcsv1Context* context, std::vector<ColumnDatum>& valsIn);
.. c:function:: ReturnCode nextValue(mcsv1Context* context, ColumnDatum* valsIn);
:param context: The context object for this call
:param valsIn: a vector representing the values to be added for each parameter for this row.
In Columnstore 1.1, this will be a vector of length one.
:param valsIn: an array representing the values to be added for each parameter for this row.
:returns: ReturnCode::ERROR or ReturnCode::SUCCESS
@@ -208,7 +203,7 @@ For AVG, you might see::
dropValue
---------
.. c:function:: ReturnCode dropValue(mcsv1Context* context, std::vector<ColumnDatum>& valsDropped);
.. c:function:: ReturnCode dropValue(mcsv1Context* context, ColumnDatum* valsDropped);
:param context: The context object for this call