VSCP Helper Libraries

User Tools

Site Tools

Trace: • helper_lib_api_tables

Sidebar

VSCP Helper Library

Using the C++ classes directly

The CANAL helper libray

Other documentation

helper_lib_api_tables

Table of Contents

VSCP Helper library API - Table handling

tableCreate

    int tableCreate( const unsigned char *pTableData );

Create table from XML data.

pTableData

Pointer to string containing UTF8 XML definition of table.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableDelete

    int tableDelete( const unsigned char *pName, int bDeleteFile );

Delete named table.

tblName

Name of an existing table.

bDeleteFile

If TRUE (!=0) the database file also should be deleted. If not it will be reused if a table with the same name is created later.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableList

    int tableList( unsigned char **pLists );

Get a list of all defined tables.

pLists

List of null terminated strings that will get filled with table names. The list is allocated on the heap and must be freed by the user. If no result is returned set to a NULL pointer.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableListInfo

    int tableListInfo( const unsigned char *pName, 
                            unsigned char *pTableInfo, 
                            int bXML );

Delete named table.

tblName

Name of an existing table.

pTableInfo

Pointer to string that contain information about the table. The list is allocated on the heap and must be freed by the user. If no result is returned set to a NULL pointer.

bXML

If TREU (!=0) info will be returned as BASE64 encoded XML data.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGet

    int tableGet( const unsigned char *pName, 
                                const char *pFrom, 
                                const char *pTo,
                                unsigned char **pResultArray,
                                BOOL bFull );

Get data from a named table in a range to-from. One can fetch all columns of the table (bFull) or just datetime and value (default).

tblName

Name of an existing table.

from

Datetime from which data should be fetched. Should be given on ISO 8601 format YY-MM-DDTHH:MM:SS.

to

Datetime up to which data is fetched. Should be given on ISO 8601 format YY-MM-DDTHH:MM:SS.

pResultArray

List of null terminated strings that will get filled with rows (if any) from the table. The list is allocated on the heap and must be freed by the user. If no result is returned set to a NULL pointer. 

YY-MM-DDTHH:MM:SSsss, value1[,other fields]<CR><LF>
YY-MM-DDTHH:MM:SSsss, value2[,other fields]<CR><LF>
YY-MM-DDTHH:MM:SSsss, value3[,other fields]<CR><LF>
...
YY-MM-DDTHH:MM:SS, valuen[,other fields]<CR><LF>
bFull

If TREU (!=0) all fields of a table row is returned (other fields above) in a comma separated list. Note that datetime is always listed first followed by value regardless of how the columns of the table is arranged.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetRaw

    int tableGetRaw( const unsigned char *pName, 
                         const char *pFrom, 
                         const char *pTo,
                         unsigned char **pResultArray );

Get data from a named table in a range to-from. All columns of the table is always returned.

tblName

Name of an existing table.

from

Datetime from which data should be fetched. Should be given on ISO 8601 format YY-MM-DDTHH:MM:SS.

to

Datetime up to which data is fetched. Should be given on ISO 8601 format YY-MM-DDTHH:MM:SS.

resultArray

List of null terminated strings that will get filled with rows (if any) from the table. The list is allocated on the heap and must be freed by the user. If no result is returned set to a NULL pointer. 

comma separated row of database columns<CR><LF>
comma separated row of database columns<CR><LF>
comma separated row of database columns<CR><LF>
...
comma separated row of database columns<CR><LF>
Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableLog

    int tableLog( const unsigned char *pName, 
                        double value, 
                        char *pdt );

Log a value, date/time pair to a table.

tblName

Name of an existing table.

value

Value to log.

pdt

Pointer to date/time value. Can be NULL (or empty) and in which case the current date/time is used.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableLogSQL

    int tableLogSQL( const unsigned char *pName, 
                        const unsigned char *psql );

Log data to with a SQL expression.

tblName

Name of an existing table.

psql

Pointer to string that contain SQL expression used to log data.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetNumRecords

    int tableGetNumRecords( const unsigned char *pName, 
                                const char *pFrom, 
                                const char *pTo,
                                size_t *pRecords );

Get number of records for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pRecords

size_t that will get number of records in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetFirstDate

    int tableGetFirstDate( const unsigned char pName, 
                                const char *pFrom, 
                                const char *pTo,
                                char *pFirst );

Get the first data/time for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pFirst

A string buffer that will get the first date/time in the interval on success. The buffer is supposed to hold a ISO formatted date/time value (YYYY-MM-DDTHH:MM:SS) so it should be able to hold at least twenty characters.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetLastDate

    int tableGetLastDate( const unsigned char *pName, 
                                const char *pFrom, 
                                const char *pTo,
                                char *pLast );

Get the last data/time for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pLast

A string buffer that will get the last date/time in the interval on success. The buffer is supposed to hold a ISO formatted date/time value (YYYY-MM-DDTHH:MM:SS) so it should be able to hold at least twenty characters.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetSum

    int tableGetSum( const unsigned char *pName, 
                        const char *pFrom, 
                        const char *pTo,
                        double *pSum );

Get the sum of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pSum

Pointer to a double that will get the sum of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetMin

    int tableGetMin( const unsigned char *pName, 
                        const char *pFrom, 
                        const char *pTo,
                        double *pMin );

Get the minimum of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pMin

Pointer to a double that will get the minimum of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetMax

    int tableGetMax( const unsigned char *pName, 
                        const char *pFrom, 
                        const char *pTo,
                        double *pMax );

Get the maximum of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pMax

Pointer to a double that will get the maximum of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetAverage

    int tableGetAverage( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pAverage );

Get the average of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pAverage

Pointer to a double that will get the average of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetMedian

    int tableGetMedian( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pMedian );

Get the median (middle/second quartile) of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pMedian

Pointer to a double that will get the median of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetStdDev

    int tableGetStdDev( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pStdDev );

Get the standard deviation of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pStdDev

Pointer to a double that will get the standard deviation of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetVariance

    int tableGetVariance( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pVariance );

Get the variance of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pVariance

Pointer to a double that will get the variance of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetMode

    int tableGetMode( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pMode );

Get the mode of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pMode

Pointer to a double that will get the mode of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetLowerQ

    int tableGetLowerQ( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pLowerQ );

Get the lower/first quartile of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pLowerQ

Pointer to a double that will get the lower quartile of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableGetUpperQ

    int tableGetUpperQ( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo,
                            double *pUpperQ );

Get the upper/third quartile of all values for an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

pUpperQ

Pointer to a double that will get the upper quartile of all values in the interval on success.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.

tableClear

    int tableClear( const unsigned char *pName, 
                            const char *pFrom, 
                            const char *pTo );

Remove all records in an interval in a named table.

tblName

Name of an existing table.

from

Date/time from which resulting data should be fetched. Set to “0000-01-01T00:00:00” for beginning of time.

to

Date/time to which resulting data should be fetched. Set to “9999-12-31T23:59:59” for end of time.

Return Value

CANAL_ERROR_SUCCESS on success or an error code on failure.


Copyright © 2000-2017 Åke Hedman, Paradise of the Frog / Grodans Paradis AB

helper_lib_api_tables.txt · Last modified: 2017/05/24 18:14 by admin

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki