AppLib

Overview

This page is an index for the Eigenbase application library (applib), a collection of commonly needed application routines packaged with LucidDB and other Eigenbase sub-projects. For LucidDB system-management routines (some of which may also be useful for application purposes), see LucidDbSystemProcedures.

Numeric Routines

• RAND

String Routines

• CHAR_REPLACE
• CONTAINS_NUMBER
• INSTR
• LEFTN
• REPEATER
• RIGHTN
• STR_REPLACE

Date/Time Routines

• ADD_DAYS
• ADD_HOURS
• ADJUST_TIMESTAMP (Only from 0.9.4 on)
• CALENDAR_QUARTER
• CHAR_TO_DATE
• CHAR_TO_TIME
• CHAR_TO_TIMESTAMP
• CONVERT_DATE
• CURRENT_DATE_IN_JULIAN
• DATE_TO_CHAR
• DAY_FROM_JULIAN_START
• DAY_IN_YEAR
• DAY_NUMBER_OVERALL
• DAYS_DIFF
• DERIVE_EFFECTIVE_TO_TIMESTAMP
• EXTRACT_TIMESTAMP (Only from 0.9.4 on)
• FISCAL_MONTH
• FISCAL_TIME_DIMENSION
• FISCAL_QUARTER
• FISCAL_YEAR
• HOURS_DIFF
• JULIAN_DAY_TO_DATE
• JULIAN_DAY_TO_TIMESTAMP
• PADWEEKNUMBER
• TIME_DIMENSION
• TIME_TO_CHAR
• TIMESTAMP_TO_CHAR
• TRUNCATE_TIMESTAMP (Only from 0.9.4 on)

Phone Number Routines

Purpose

Standardizes the format for telephone numbers.

Functions

• CLEAN_PHONE
• CLEAN_PHONE_INTERNATIONAL

Security-Related Routines

• GRANT_SELECT_FOR_SCHEMA

ANALYZE Routines

Purpose

Causes LucidDB to create statistical information for optimizing performance of queries.

Recommended use

Use after ETL or other updates to tables.

Functions

• COMPUTE_STATISTICS_FOR_SCHEMA

Executes 'analyze table' with 'compute statistics for all columns' for all tables in a schema.

• ESTIMATE_STATISTICS_FOR_SCHEMA

Row/Column Transformations

• COLLAPSE_ROWS
• CONTIGUOUS_VALUE_INTERVALS
• FLATTEN_RECURSIVE_HIERARCHY
• FLATTEN_RECURSIVE_HIERARCHY_ALL_LEVELS
• GENERATE_CRC
• GENERATE_SEQUENCE (Only available starting with LucidDB 0.9.4.)
• GENERATE_SEQUENCE_PARTITIONED (Only available starting with LucidDB 0.9.4.)
• PENULTIMATE_VALUES
• PIVOT_COLUMNS_TO_ROWS
• SPLIT_STRINGS
• TOPN

General Utility Routines

• CREATE_VAR
• DELETE_VAR
• DO_FOR_ENTIRE_SCHEMA
• DROP_SCHEMA_IF_EXISTS
• ENFORCE_ROW_CONSTRAINTS
• EXEC_SQL_IF_NO_ROWS
• FLUSH_VAR
• GET_VAR
• SET_VAR
• CLEAR_PENTAHO_MONDRIAN_CACHE
• SHOW_IDX_CANDIDATES (Only available starting with LucidDB 0.9.4.)
• CREATE_INDEXES (Only available starting with LucidDB 0.9.4.)

Data Loading Utility Routines

• REPLICATE_MONDRIAN

Replication will copy both metadata and data from your source DBMS into LucidDB (guided by your Mondrian schema .xml file), creating a logically identical structure.

• CREATE_TABLE_FROM_SOURCE_TABLE

Creates a table with the same structure as the source table, optionally adding a few additional columns

• CREATE_TABLE_AS

Creates a table with the same structure as the SQL statement passed in. It optionally loads the table after creating the table.

• READ_ROWS_FROM_FILE

Allow serialized rows to be read from a file and output in a table function.

• WRITE_ROWS_TO_FILE
• REMOTE_ROWS

Allow serialized rows to be streamed via HTTP from remote Java applications (PDI / Talend).

Scripting Routines

Note: These are only available starting with LucidDB 0.9.4.

• EXECUTE_SCRIPT
• GET_SCRIPTING_ENGINES
• EXECUTE_FUNCTION
• EXECUTE_METHOD
• EXECUTE_TRANSFORM
• MAKE_SCRIPT_UDF

Get the code

We are sorry documentation for this library is sparse in some areas.
The source code in this library can be acquired using GIT.
It should be easy to derive the purpose and parameters for functions in this library by looking at the code.
Documentation will be a focus during this 4th Quarter of 2011.

https://github.com/dynamobi/dynamobi/tree/master/extensions/applib/src/org/eigenbase/applib