Package io.revealbi.core.data
Class RVDuckDBDataSourceItem
java.lang.Object
io.revealbi.core.data.RVDataSourceItem
io.revealbi.core.data.RVDuckDBDataSourceItem
- All Implemented Interfaces:
ICustomQuerySupport,IProcessDataOnServerDataSourceItem
public class RVDuckDBDataSourceItem
extends RVDataSourceItem
implements IProcessDataOnServerDataSourceItem, ICustomQuerySupport
DuckDB data source item.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(Optional) Custom SQL query to use when getting data.(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.Parameters to be passed to the stored procedure, if there is such specified ingetProcedure().booleanConfigures if the "Process Data on Server" option is turned on for this item (table or view).Name of the schema to connect to.getTable()Name of the table (or view) to get data from.voidsetCustomQuery(String customQuery) (Optional) Custom SQL query to use when getting data.voidsetProcedure(String procedure) (Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.voidsetProcedureParameters(HashMap<String, Object> procedureParameters) Parameters to be passed to the stored procedure, if there is such specified ingetProcedure().voidsetProcessDataOnServer(boolean value) Configures if the "Process Data on Server" option is turned on for this item (table or view).voidName of the schema to connect to.voidName of the table (or view) to get data from.Methods inherited from class io.revealbi.core.data.RVDataSourceItem
getDataSource, getDefaultRefreshRate, getDescription, getId, getSubtitle, getTitle, setDataSource, setDefaultRefreshRate, setDescription, setId, setSubtitle, setTitle
-
Constructor Details
-
RVDuckDBDataSourceItem
-
-
Method Details
-
getSchema
Name of the schema to connect to.- Returns:
- the name of the schema to connect to
-
setSchema
Name of the schema to connect to.- Parameters:
schema- the name of the schema to connect to
-
getTable
Name of the table (or view) to get data from.- Returns:
- the name of the table (or view) to get data from
-
setTable
Name of the table (or view) to get data from.- Parameters:
table- the name of the table (or view) to get data from
-
getCustomQuery
(Optional) Custom SQL query to use when getting data.- Specified by:
getCustomQueryin interfaceICustomQuerySupport- Returns:
- the custom SQL query
-
setCustomQuery
(Optional) Custom SQL query to use when getting data.- Specified by:
setCustomQueryin interfaceICustomQuerySupport- Parameters:
customQuery- the custom SQL query
-
getProcedure
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.- Returns:
- the name of the stored procedure
-
setProcedure
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.- Parameters:
procedure- the name of the stored procedure
-
getProcedureParameters
Parameters to be passed to the stored procedure, if there is such specified ingetProcedure().- Returns:
- the procedure parameters
-
setProcedureParameters
Parameters to be passed to the stored procedure, if there is such specified ingetProcedure().- Parameters:
procedureParameters- the procedure parameters
-
getProcessDataOnServer
public boolean getProcessDataOnServer()Description copied from interface:IProcessDataOnServerDataSourceItemConfigures if the "Process Data on Server" option is turned on for this item (table or view).- Specified by:
getProcessDataOnServerin interfaceIProcessDataOnServerDataSourceItem- Returns:
- Configures if the "Process Data on Server" option is turned on for this item (table or view).
-
setProcessDataOnServer
public void setProcessDataOnServer(boolean value) Description copied from interface:IProcessDataOnServerDataSourceItemConfigures if the "Process Data on Server" option is turned on for this item (table or view).- Specified by:
setProcessDataOnServerin interfaceIProcessDataOnServerDataSourceItem- Parameters:
value- Configures if the "Process Data on Server" option is turned on for this item (table or view).
-