Package io.revealbi.core.data

Class RVDuckDBDataSource

java.lang.Object

io.revealbi.core.data.RVDashboardDataSource

io.revealbi.core.data.RVDuckDBDataSource

All Implemented Interfaces:

IProcessDataOnServerDataSource

public class RVDuckDBDataSource
extends RVDashboardDataSource
implements IProcessDataOnServerDataSource

DuckDB data source.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_KEY

Constructor Summary

Constructors

Constructor	Description
RVDuckDBDataSource()

Method Summary

Modifier and Type	Method	Description
String	getDatabase()	Path of the DuckDB database file.
boolean	getProcessDataOnServerDefaultValue()	Gets the default value for "Process Data on Server" option for this data source.
boolean	getProcessDataOnServerReadOnly()	Gets whether the user is allowed to change the value for "Process Data on Server" option.
String	getProviderKey()
String	getSchema()	Name of the schema to connect to.
void	setDatabase(String database)	Path of the DuckDB database file.
void	setProcessDataOnServerDefaultValue(boolean value)	Sets the default value for "Process Data on Server" option for this data source.
void	setProcessDataOnServerReadOnly(boolean value)	Sets whether the user is allowed to change the value for "Process Data on Server" option.
void	setSchema(String schema)	Name of the schema to connect to.

Methods inherited from class io.revealbi.core.data.RVDashboardDataSource

getDefaultRefreshRate, getId, getSubtitle, getTitle, setDefaultRefreshRate, setId, setSubtitle, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROVIDER_KEY

public static final String PROVIDER_KEY

See Also:

• Constant Field Values

Constructor Details

RVDuckDBDataSource

public RVDuckDBDataSource()

Method Details

getDatabase

public String getDatabase()

Path of the DuckDB database file. Accepts both absolute paths and relative paths. For MotherDuck use "md:databaseName" as the database value.

Returns:

the path of the database to connect to

setDatabase

public void setDatabase(String database)

Path of the DuckDB database file. Accepts both absolute paths and relative paths. For MotherDuck use "md:databaseName" as the database value.

Parameters:

database - the path of the database to connect to

getSchema

public String getSchema()

Name of the schema to connect to.

Returns:

the name of the schema to connect to

setSchema

public void setSchema(String schema)

Name of the schema to connect to.

Parameters:

schema - the name of the schema to connect to

getProcessDataOnServerDefaultValue

public boolean getProcessDataOnServerDefaultValue()

Description copied from interface: IProcessDataOnServerDataSource

Gets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unless IProcessDataOnServerDataSource.getProcessDataOnServerReadOnly() is true.

Specified by:

getProcessDataOnServerDefaultValue in interface IProcessDataOnServerDataSource

Returns:

the default value for the "Process Data on Server" option

setProcessDataOnServerDefaultValue

public void setProcessDataOnServerDefaultValue(boolean value)

Description copied from interface: IProcessDataOnServerDataSource

Sets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unless IProcessDataOnServerDataSource.setProcessDataOnServerReadOnly(boolean) is true.

Specified by:

setProcessDataOnServerDefaultValue in interface IProcessDataOnServerDataSource

Parameters:

value - the default value for the "Process Data on Server" option

getProcessDataOnServerReadOnly

public boolean getProcessDataOnServerReadOnly()

Description copied from interface: IProcessDataOnServerDataSource

Gets whether the user is allowed to change the value for "Process Data on Server" option. When true, the default value will always be used.

Specified by:

getProcessDataOnServerReadOnly in interface IProcessDataOnServerDataSource

Returns:

true if the option is read-only

setProcessDataOnServerReadOnly

public void setProcessDataOnServerReadOnly(boolean value)

Description copied from interface: IProcessDataOnServerDataSource

Sets whether the user is allowed to change the value for "Process Data on Server" option. When set to true, the default value will always be used.

Specified by:

setProcessDataOnServerReadOnly in interface IProcessDataOnServerDataSource

Parameters:

value - true to make the option read-only

getProviderKey

public String getProviderKey()

Specified by:

getProviderKey in class RVDashboardDataSource