org.wso2.carbon.analytics.api

Interface AnalyticsDataAPI

All Known Implementing Classes:

CarbonAnalyticsAPI

public interface AnalyticsDataAPI

This is the interface which expose the operations to perform on the Analytics. The operations can be analytics data manipulation in non-secured and secured manner.

Method Summary

Modifier and Type	Method and Description
void	clearIndexData(int tenantId, String tableName) Clears the index data of the table.
void	clearIndexData(String username, String tableName) Clears the index data of the table.
void	createTable(int tenantId, String tableName) The primary record store is used to create the table.
void	createTable(int tenantId, String recordStoreName, String tableName) Creates a table, if not already there in the given record store, or else, it will re-create the table in the given record store, and also, the columns are not defined here, but can contain any arbitrary number of columns when data is added.
void	createTable(String username, String tableName) Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added.
void	createTable(String username, String recordStoreName, String tableName) Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added.
void	createTableIfNotExists(int tenantId, String recordStoreName, String tableName) Creates the table if it does not already exist in the system.
void	createTableIfNotExists(String username, String recordStoreName, String tableName) Creates the table if it does not already exist in the system.
void	delete(int tenantId, String tableName, List<String> ids) Delete data in a table with given ids.
void	delete(int tenantId, String tableName, long timeFrom, long timeTo) Deletes a set of records in the table.
void	delete(String username, String tableName, List<String> ids) Delete data in a table with given ids.
void	delete(String username, String tableName, long timeFrom, long timeTo) Deletes a set of records in the table.
void	deleteTable(int tenantId, String tableName) Deletes the table with the given category and name if a table exists already.
void	deleteTable(String username, String tableName) Deletes the table with the given category and name if a table exists already.
void	destroy() Destroys and frees any resources taken up by the analytics data service implementation.
org.wso2.carbon.analytics.dataservice.commons.SubCategories	drillDownCategories(int tenantId, org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest) Returns the subcategories of a facet field, given CategoryDrillDownRequest
org.wso2.carbon.analytics.dataservice.commons.SubCategories	drillDownCategories(String username, org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest) Returns the subcategories of a facet field, given CategoryDrillDownRequest
List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange>	drillDownRangeCount(int tenantId, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns a list of range buckets of a specific field with the total score for each bucket.
List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange>	drillDownRangeCount(String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns a list of range buckets of a specific field with the total score for each bucket.
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	drillDownSearch(int tenantId, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns the drill down results of a search query, given AnalyticsDrillDownRequest
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	drillDownSearch(String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns the drill down results of a search query, given AnalyticsDrillDownRequest
double	drillDownSearchCount(int tenantId, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns the count of results of a search query, given AnalyticsDrillDownRequest
double	drillDownSearchCount(String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest) Returns the count of results of a search query, given AnalyticsDrillDownRequest
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	get(int tenantId, String tableName, int numPartitionsHint, List<String> columns, List<String> ids) Retrieves data from a table with given ids.
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	get(int tenantId, String tableName, int numPartitionsHint, List<String> columns, long timeFrom, long timeTo, int recordsFrom, int recordsCount) Retrieves data from a table, with a given range.
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	get(String username, String tableName, int numPartitionsHint, List<String> columns, List<String> ids) Retrieves data from a table with given ids.
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	get(String username, String tableName, int numPartitionsHint, List<String> columns, long timeFrom, long timeTo, int recordsFrom, int recordsCount) Retrieves data from a table, with a given range.
long	getRecordCount(int tenantId, String tableName, long timeFrom, long timeTo) sear Returns the number of records in the table with the given category and name.
long	getRecordCount(String username, String tableName, long timeFrom, long timeTo) Returns the number of records in the table with the given category and name.
String	getRecordStoreNameByTable(int tenantId, String tableName) Returns the record store name given the table information.
String	getRecordStoreNameByTable(String username, String tableName) Returns the record store name given the table information.
org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema	getTableSchema(int tenantId, String tableName) Retrieves the table schema for the given table.
org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema	getTableSchema(String username, String tableName) Retrieves the table schema for the given table.
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	getWithKeyValues(int tenantId, String tableName, int numPartitionsHint, List<String> columns, List<Map<String,Object>> valuesBatch) Retrieves data from a table with the values for all the given primary key value composites.
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	getWithKeyValues(String username, String tableName, int numPartitionsHint, List<String> columns, List<Map<String,Object>> valuesBatch) Retrieves data from a table with the values for all the given primary key value composites.
boolean	isPaginationSupported(String recordStoreName) Checks whether or not pagination (i.e.
boolean	isRecordCountSupported(String recordStoreName) Checks whether or not record count operation is supported by the given record store implementation.
List<String>	listRecordStoreNames() Lists all the record stores available in the system.
List<String>	listTables(int tenantId) Lists all the current tables with the given category.
List<String>	listTables(String username) Lists all the current tables with the given category.
void	put(List<org.wso2.carbon.analytics.datasource.commons.Record> records) Adds a new record to the table.
void	put(String username, List<org.wso2.carbon.analytics.datasource.commons.Record> records) Adds a new record to the table.
org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>	readRecords(String recordStoreName, org.wso2.carbon.analytics.datasource.commons.RecordGroup recordGroup) Reads in the records from a given record group at a given record store, the records will be streamed in.
void	reIndex(int tenantId, String tableName, long startTime, long endTime) Given the start time and end time, this method will re-index the records of a table.
void	reIndex(String username, String tableName, long startTime, long endTime) Given the start time and end time, this method will re-index the records of a table.
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	search(int tenantId, String tableName, String query, int start, int count) Searches the data with a given search query.
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	search(int tenantId, String tableName, String query, int start, int count, List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields) Searches the data with a given search query with sorted by given fields.
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	search(String username, String tableName, String query, int start, int count) Searches the data with a given search query.
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	search(String username, String tableName, String query, int start, int count, List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields) Searches the data with a given search query.
int	searchCount(int tenantId, String tableName, String query) Returns the search count of results of a given search query.
int	searchCount(String username, String tableName, String query) Returns the search count of results of a given search query.
org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>	searchWithAggregates(int tenantId, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest) Returns an iterator of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.
List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>>	searchWithAggregates(int tenantId, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests) Returns an iterator of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.
org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>	searchWithAggregates(String username, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest) Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.
List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>>	searchWithAggregates(String username, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests) Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.
void	setTableSchema(int tenantId, String tableName, org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema) Sets the schema for the target analytics table, if there is already one assigned, it will be overwritten.
void	setTableSchema(String username, String tableName, org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema) Sets the schema for the target analytics table, if there is already one assigned, it will be overwritten.
boolean	tableExists(int tenantId, String tableName) Checks if the specified table with the given category and name exists.
boolean	tableExists(String username, String tableName) Checks if the specified table with the given category and name exists.
void	waitForIndexing(int tenantId, String tableName, long maxWait) This method waits until the current indexing operations for a specific table is done.
void	waitForIndexing(long maxWait) This method waits until the current indexing operations for the system is done.
void	waitForIndexing(String username, String tableName, long maxWait) This method waits until the current indexing operations for a specific table is done.

Method Detail

listRecordStoreNames

List<String> listRecordStoreNames()

Lists all the record stores available in the system.

Returns:

The list of record store names

createTable

void createTable(int tenantId,
                 String recordStoreName,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates a table, if not already there in the given record store, or else, it will re-create the table in the given record store, and also, the columns are not defined here, but can contain any arbitrary number of columns when data is added. The table names are not case sensitive.

Parameters:

tenantId - The tenant which this table belongs to

recordStoreName - The name of the target record store to store the table at

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createTable

void createTable(int tenantId,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

The primary record store is used to create the table.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createTableIfNotExists

void createTableIfNotExists(int tenantId,
                            String recordStoreName,
                            String tableName)
                     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates the table if it does not already exist in the system.

Parameters:

tenantId - The tenant which this table belongs to

recordStoreName - The name of the target record store to store the table at

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordStoreNameByTable

String getRecordStoreNameByTable(int tenantId,
                                 String tableName)
                          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the record store name given the table information.

Parameters:

tenantId - The tenant id

tableName - The table name

Returns:

The record store name

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

clearIndexData

void clearIndexData(int tenantId,
                    String tableName)
             throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Clears the index data of the table. This will delete all the index information up to the current moment.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to clear the index data from

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

setTableSchema

void setTableSchema(int tenantId,
                    String tableName,
                    org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Sets the schema for the target analytics table, if there is already one assigned, it will be overwritten.

Parameters:

tenantId - The tenant id

tableName - The table name

schema - The schema to be applied to the table

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getTableSchema

org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema getTableSchema(int tenantId,
                                                                            String tableName)
                                                                     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves the table schema for the given table.

Parameters:

tenantId - The tenant id

tableName - The table name

Returns:

The schema of the table

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

tableExists

boolean tableExists(int tenantId,
                    String tableName)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Checks if the specified table with the given category and name exists.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The table name

Returns:

true if the table exists, false otherwise

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

deleteTable

void deleteTable(int tenantId,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Deletes the table with the given category and name if a table exists already. This will not throw an error if the table is not there.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to be dropped

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

listTables

List<String> listTables(int tenantId)
                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Lists all the current tables with the given category.

Parameters:

tenantId - The tenant which this table belongs to

Returns:

The list of table names

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordCount

long getRecordCount(int tenantId,
                    String tableName,
                    long timeFrom,
                    long timeTo)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

sear Returns the number of records in the table with the given category and name.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to get the count from

timeFrom - The starting time to consider the count from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to consider the count to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

Returns:

The record count

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

put

void put(List<org.wso2.carbon.analytics.datasource.commons.Record> records)
  throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Adds a new record to the table. If the record id is mentioned, it will be used to do the insert, or else, it will check the table's schema to check for the existence of primary keys, if there are any, the primary keys will be used to derive the id, or else the insert will be done with a randomly generated id. If the record already exists, it updates the record store with the given records, matches by its record id, this will be a full replace of the record, where the older record is effectively deleted and the new one is added, there will not be a merge of older record's field's with the new one.

Parameters:

records - The list of records to be inserted

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

get

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse get(int tenantId,
                                                                        String tableName,
                                                                        int numPartitionsHint,
                                                                        List<String> columns,
                                                                        long timeFrom,
                                                                        long timeTo,
                                                                        int recordsFrom,
                                                                        int recordsCount)
                                                                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table, with a given range.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

timeFrom - The starting time to get records from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to get records to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

recordsFrom - The paginated index from value, zero based, inclusive

recordsCount - The paginated records count to be read, -1 for infinity

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

get

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse get(int tenantId,
                                                                        String tableName,
                                                                        int numPartitionsHint,
                                                                        List<String> columns,
                                                                        List<String> ids)
                                                                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table with given ids.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

ids - The list of ids of the records to be read

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

getWithKeyValues

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse getWithKeyValues(int tenantId,
                                                                                     String tableName,
                                                                                     int numPartitionsHint,
                                                                                     List<String> columns,
                                                                                     List<Map<String,Object>> valuesBatch)
                                                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table with the values for all the given primary key value composites.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

valuesBatch - A batch of key/values which contains the primary keys values to match the data in the table

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

delete

void delete(int tenantId,
            String tableName,
            long timeFrom,
            long timeTo)
     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Deletes a set of records in the table.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

timeFrom - The starting time to get records from for deletion

timeTo - The ending time to get records to for deletion

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

delete

void delete(int tenantId,
            String tableName,
            List<String> ids)
     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Delete data in a table with given ids.

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

ids - The list of ids of the records to be deleted

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

search

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> search(int tenantId,
                                                                             String tableName,
                                                                             String query,
                                                                             int start,
                                                                             int count)
                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Searches the data with a given search query.

Parameters:

tenantId - The tenant id

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

Returns:

A list of SearchResultEntrys

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

search

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> search(int tenantId,
                                                                             String tableName,
                                                                             String query,
                                                                             int start,
                                                                             int count,
                                                                             List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields)
                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Searches the data with a given search query with sorted by given fields.

Parameters:

tenantId - The tenant id

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

sortByFields - List of Fields by which the records needed to be sorted.

Returns:

A list of SearchResultEntrys

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchCount

int searchCount(int tenantId,
                String tableName,
                String query)
         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the search count of results of a given search query.

Parameters:

tenantId - The tenant id

tableName - The table name

query - The search query

Returns:

The count of results

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownSearch

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> drillDownSearch(int tenantId,
                                                                                      org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                                                                               throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the drill down results of a search query, given AnalyticsDrillDownRequest

Parameters:

tenantId - The tenant id

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

the results containing the ids which match the drilldown query.

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownSearchCount

double drillDownSearchCount(int tenantId,
                            org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                     throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the count of results of a search query, given AnalyticsDrillDownRequest

Parameters:

tenantId - The tenant id

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

the count of the records which match the drilldown query

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownCategories

org.wso2.carbon.analytics.dataservice.commons.SubCategories drillDownCategories(int tenantId,
                                                                                org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest)
                                                                         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the subcategories of a facet field, given CategoryDrillDownRequest

Parameters:

tenantId - The tenant id

drillDownRequest - The category drilldown object which contains the category drilldown information

Returns:

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownRangeCount

List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange> drillDownRangeCount(int tenantId,
                                                                                                org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                                                                                         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns a list of range buckets of a specific field with the total score for each bucket.

Parameters:

tenantId - The tenant id

drillDownRequest - The drilldown request which contains all query information

Returns:

A list of AnalyticsDrillDownRange with score property not-null

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

searchWithAggregates

org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record> searchWithAggregates(int tenantId,
                                                                                                                                         org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest)
                                                                                                                                  throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns an iterator of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.

Parameters:

tenantId - The tenant Id

aggregateRequest - The inputs required for performing aggregation. groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

iterator of records of which the record values will be the aggregate values of the given fields

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchWithAggregates

List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>> searchWithAggregates(int tenantId,
                                                                                                                                               org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests)
                                                                                                                                        throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns an iterator of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.

Parameters:

tenantId - The tenant Id

aggregateRequests - The array of aggregateRequests representing different tables groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

Iterator of records of which the record values will be the aggregate values of the given fields

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

reIndex

void reIndex(int tenantId,
             String tableName,
             long startTime,
             long endTime)
      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Given the start time and end time, this method will re-index the records of a table.

Parameters:

tenantId - tenant id

tableName - the table name of which the records are being re-indexed.

startTime - lowerbound of the timestamp range of records

endTime - upperbound of the timestamp range of records

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

waitForIndexing

void waitForIndexing(int tenantId,
                     String tableName,
                     long maxWait)
              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

This method waits until the current indexing operations for a specific table is done.

Parameters:

tenantId - The tenant id

tableName - The table name

maxWait - Maximum amount of time in milliseconds, if the time is reached, an AnalyticsTimeoutException will be thrown, -1 for infinity

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTimeoutException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createTable

void createTable(String username,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added. The table names are not case sensitive.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

clearIndexData

void clearIndexData(String username,
                    String tableName)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Clears the index data of the table. This will delete all the index information up to the current moment.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to clear the index data from

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

setTableSchema

void setTableSchema(String username,
                    String tableName,
                    org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Sets the schema for the target analytics table, if there is already one assigned, it will be overwritten.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

schema - The schema to be applied to the table

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getTableSchema

org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema getTableSchema(String username,
                                                                            String tableName)
                                                                     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves the table schema for the given table.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

Returns:

The schema of the table

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

tableExists

boolean tableExists(String username,
                    String tableName)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Checks if the specified table with the given category and name exists.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

Returns:

true if the table exists, false otherwise

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

deleteTable

void deleteTable(String username,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Deletes the table with the given category and name if a table exists already. This will not throw an error if the table is not there.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to be dropped

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

listTables

List<String> listTables(String username)
                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Lists all the current tables with the given category.

Parameters:

username - The username of the user that invoke this method

Returns:

The list of table names

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordCount

long getRecordCount(String username,
                    String tableName,
                    long timeFrom,
                    long timeTo)
             throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the number of records in the table with the given category and name.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to get the count from

timeFrom - The starting time to consider the count from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to consider the count to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

Returns:

The record count

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

put

void put(String username,
         List<org.wso2.carbon.analytics.datasource.commons.Record> records)
  throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Adds a new record to the table. If the record id is mentioned, it will be used to do the insert, or else, it will check the table's schema to check for the existence of primary keys, if there are any, the primary keys will be used to derive the id, or else the insert will be done with a randomly generated id. If the record already exists, it updates the record store with the given records, matches by its record id, this will be a full replace of the record, where the older record is effectively deleted and the new one is added, there will not be a merge of older record's field's with the new one.

Parameters:

username - The username of the user that invoke this method

records - The list of records to be inserted

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

get

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse get(String username,
                                                                        String tableName,
                                                                        int numPartitionsHint,
                                                                        List<String> columns,
                                                                        long timeFrom,
                                                                        long timeTo,
                                                                        int recordsFrom,
                                                                        int recordsCount)
                                                                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table, with a given range.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

timeFrom - The starting time to get records from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to get records to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

recordsFrom - The paginated index from value, zero based, inclusive

recordsCount - The paginated records count to be read, -1 for infinity

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

get

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse get(String username,
                                                                        String tableName,
                                                                        int numPartitionsHint,
                                                                        List<String> columns,
                                                                        List<String> ids)
                                                                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table with given ids.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

ids - The list of ids of the records to be read

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

getWithKeyValues

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse getWithKeyValues(String username,
                                                                                     String tableName,
                                                                                     int numPartitionsHint,
                                                                                     List<String> columns,
                                                                                     List<Map<String,Object>> valuesBatch)
                                                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Retrieves data from a table with the values for all the given primary key value composites.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

valuesBatch - A batch of key/values which contains the primary keys values to match the data in the table

Returns:

The analytics data response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

readRecords

org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record> readRecords(String recordStoreName,
                                                                                                                                org.wso2.carbon.analytics.datasource.commons.RecordGroup recordGroup)
                                                                                                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Reads in the records from a given record group at a given record store, the records will be streamed in.

Parameters:

recordStoreName - The record store name

recordGroup - The record group which represents the local data set

Returns:

An iterator of type Record in the local record group

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

isPaginationSupported

boolean isPaginationSupported(String recordStoreName)
                       throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Checks whether or not pagination (i.e. jumping to record n and then retrieving k further records) is supported by the underlying record store implementation. Also returns false if the total record count in a table cannot be determined.

Parameters:

recordStoreName - The record store name

Returns:

Pagination/row-count support

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

isRecordCountSupported

boolean isRecordCountSupported(String recordStoreName)
                        throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Checks whether or not record count operation is supported by the given record store implementation.

Parameters:

recordStoreName - The record store name

Returns:

Record count support

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

delete

void delete(String username,
            String tableName,
            long timeFrom,
            long timeTo)
     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Deletes a set of records in the table.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to search on

timeFrom - The starting time to get records from for deletion

timeTo - The ending time to get records to for deletion

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

delete

void delete(String username,
            String tableName,
            List<String> ids)
     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Delete data in a table with given ids.

Parameters:

username - The username of the user that invoke this method

tableName - The name of the table to search on

ids - The list of ids of the records to be deleted

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException

search

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> search(String username,
                                                                             String tableName,
                                                                             String query,
                                                                             int start,
                                                                             int count,
                                                                             List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields)
                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Searches the data with a given search query.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

sortByFields - List of Fields by which the records needed to be sorted.

Returns:

A list of SearchResultEntrys

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

search

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> search(String username,
                                                                             String tableName,
                                                                             String query,
                                                                             int start,
                                                                             int count)
                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Searches the data with a given search query.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

Returns:

A list of SearchResultEntrys

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchCount

int searchCount(String username,
                String tableName,
                String query)
         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the search count of results of a given search query.

Parameters:

username - The username of the user that invoke this method

tableName - The table name

query - The search query

Returns:

The count of results

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

waitForIndexing

void waitForIndexing(long maxWait)
              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

This method waits until the current indexing operations for the system is done.

Parameters:

maxWait - Maximum amount of time in milliseconds, if the time is reached, an AnalyticsTimeoutException will be thrown, -1 for infinity

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTimeoutException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

waitForIndexing

void waitForIndexing(String username,
                     String tableName,
                     long maxWait)
              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

This method waits until the current indexing operations for a specific table is done.

Parameters:

username - The username

tableName - The table name

maxWait - Maximum amount of time in milliseconds, if the time is reached, an AnalyticsTimeoutException will be thrown, -1 for infinity

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTimeoutException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

drillDownSearch

List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> drillDownSearch(String username,
                                                                                      org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                                                                               throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the drill down results of a search query, given AnalyticsDrillDownRequest

Parameters:

username - The username

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

the results containing the ids which match the drilldown query.

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownSearchCount

double drillDownSearchCount(String username,
                            org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                     throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the count of results of a search query, given AnalyticsDrillDownRequest

Parameters:

username - The username

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

the count of the records which match the drilldown query

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownCategories

org.wso2.carbon.analytics.dataservice.commons.SubCategories drillDownCategories(String username,
                                                                                org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest)
                                                                         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns the subcategories of a facet field, given CategoryDrillDownRequest

Parameters:

username - The username

drillDownRequest - The category drilldown object which contains the category drilldown information

Returns:

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

drillDownRangeCount

List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange> drillDownRangeCount(String username,
                                                                                                org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest)
                                                                                         throws org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

Returns a list of range buckets of a specific field with the total score for each bucket.

Parameters:

username - The username

drillDownRequest - The drilldown request which contains all query information

Returns:

A list of AnalyticsDrillDownRange with score property not-null

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

searchWithAggregates

org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record> searchWithAggregates(String username,
                                                                                                                                         org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest)
                                                                                                                                  throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.

Parameters:

username - The username

aggregateRequest - Inputs required for performing aggregation. groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

Iterator of records of which the record values will be the aggregate values of the given fields

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchWithAggregates

List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>> searchWithAggregates(String username,
                                                                                                                                               org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests)
                                                                                                                                        throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.

Parameters:

username - The username

aggregateRequests - The array of aggregateRequests which represents different tables groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

Iterator of records of which the record values will be the aggregate values of the given fields

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

reIndex

void reIndex(String username,
             String tableName,
             long startTime,
             long endTime)
      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Given the start time and end time, this method will re-index the records of a table.

Parameters:

username - the username

tableName - the table name of which the records are being re-indexed.

startTime - lowerbound of the timestamp range of records

endTime - upperbound of the timestamp range of records

Throws:

org.wso2.carbon.analytics.dataservice.commons.exception.AnalyticsIndexException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

destroy

void destroy()
      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Destroys and frees any resources taken up by the analytics data service implementation.

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createTable

void createTable(String username,
                 String recordStoreName,
                 String tableName)
          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added. The table names are not case sensitive.

Parameters:

username - The username

recordStoreName - The name of the target record store to store the table at

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createTableIfNotExists

void createTableIfNotExists(String username,
                            String recordStoreName,
                            String tableName)
                     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates the table if it does not already exist in the system.

Parameters:

username - The username

recordStoreName - The name of the target record store to store the table at

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordStoreNameByTable

String getRecordStoreNameByTable(String username,
                                 String tableName)
                          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the record store name given the table information.

Parameters:

username - The username

tableName - The table name

Returns:

The record store name

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsTableNotAvailableException