Package org.geotools.data.duckdb

Class AbstractDuckDBDataStoreFactory

Object

JDBCDataStoreFactory

AbstractDuckDBDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

Direct Known Subclasses:

DuckDBDataStoreFactory, GeoParquetDataStoreFactory

public abstract class AbstractDuckDBDataStoreFactory
extends JDBCDataStoreFactory
implements DataStoreFactorySpi

Abstract base class for DuckDB-powered datastores. Handles common DuckDB setup, configuration and initialization.

This factory provides the foundation for creating DataStore implementations that use DuckDB as their underlying database engine. It manages:

• Common parameter definition and handling
• DuckDB JDBC connection setup and configuration
• Extension management
• DataStore configuration (simplification, etc.)

Subclasses like GeoParquetDataStoreFactory extend this to provide format-specific implementation details while inheriting the common DuckDB handling code. This separation allows reuse of the DuckDB infrastructure across multiple datastore implementations.

DuckDB is an embedded analytical database that excels at reading and processing analytical data formats like Parquet, and includes excellent built-in support for spatial operations.

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field	Description
static DataAccessFactory.Param	SCREENMAP
static DataAccessFactory.Param	SIMPLIFY	Enables usage of a simplification function, when the queries contain geometry simplification hints.

Fields inherited from class JDBCDataStoreFactory

BATCH_INSERT_SIZE, CALLBACK_FACTORY, DATABASE, DATASOURCE, DBTYPE, EVICTOR_TESTS_PER_RUN, EXPOSE_PK, FETCHSIZE, HOST, MAX_OPEN_PREPARED_STATEMENTS, MAXCONN, MAXWAIT, MIN_EVICTABLE_TIME, MINCONN, NAMESPACE, PASSWD, PK_METADATA_TABLE, PORT, SCHEMA, SQL_ON_BORROW, SQL_ON_RELEASE, TEST_WHILE_IDLE, TIME_BETWEEN_EVICTOR_RUNS, USER, VALIDATECONN

Constructor Summary

Constructors

Constructor	Description
AbstractDuckDBDataStoreFactory()

Method Summary

Modifier and Type	Method	Description
protected abstract void	addDatabaseSpecificParameters(Map<String,Object> parameters)	Allows subclasses to add their specific parameters
protected BasicDataSource	createDataSource(Map<String,?> params, SQLDialect dialect)	Called by JDBCDataStoreFactory.createDataStore(Map) to set up the JDCB DataSource
protected JDBCDataStore	createDataStoreInternal(JDBCDataStore dataStore, Map<String,?> params)	Subclass hook to do additional initialization of a newly created datastore.
protected String	getDriverClassName()	Returns the fully qualified class name of the jdbc driver.
protected abstract String	getJDBCUrl(Map<String,?> params)	Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup
protected String	getValidationQuery()	Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.
protected abstract JDBCDataStore	setupDataStore(JDBCDataStore dataStore, Map<String,?> params)	Allows subclasses to perform additional setup for their specific datastores
protected void	setupParameters(Map<String,Object> parameters)	Sets up the database connection parameters.

Methods inherited from class JDBCDataStoreFactory

canProcess, checkDBType, checkDBType, createDataSource, createDataStore, createNewDataStore, createSQLDialect, createSQLDialect, getDatabaseID, getDisplayName, getImplementationHints, getParametersInfo, isAvailable

Methods inherited from class Object

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

Methods inherited from interface DataAccessFactory

canProcess, getDescription, getDisplayName, getParametersInfo, isAvailable

Methods inherited from interface DataStoreFactorySpi

createDataStore, createNewDataStore

Methods inherited from interface Factory

getImplementationHints

Field Detail

SCREENMAP

public static final DataAccessFactory.Param SCREENMAP

SIMPLIFY

public static final DataAccessFactory.Param SIMPLIFY

Enables usage of a simplification function, when the queries contain geometry simplification hints. The simplification function used depends on SIMPLIFICATION_METHOD setting, and is ST_Simplify by default.

Constructor Detail

AbstractDuckDBDataStoreFactory

public AbstractDuckDBDataStoreFactory()

Method Detail

addDatabaseSpecificParameters

protected abstract void addDatabaseSpecificParameters(Map<String,Object> parameters)

Allows subclasses to add their specific parameters

getJDBCUrl

protected abstract String getJDBCUrl(Map<String,?> params)
                              throws IOException

Description copied from class: JDBCDataStoreFactory

Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup

Overrides:

getJDBCUrl in class JDBCDataStoreFactory

Throws:

IOException

setupDataStore

protected abstract JDBCDataStore setupDataStore(JDBCDataStore dataStore,
                                                Map<String,?> params)
                                         throws IOException

Allows subclasses to perform additional setup for their specific datastores

Throws:

IOException

setupParameters

protected void setupParameters(Map<String,Object> parameters)

Description copied from class: JDBCDataStoreFactory

Sets up the database connection parameters.

Subclasses may extend, but should not override. This implementation registers the following parameters.

• JDBCDataStoreFactory.HOST
• JDBCDataStoreFactory.PORT
• JDBCDataStoreFactory.DATABASE
• JDBCDataStoreFactory.SCHEMA
• JDBCDataStoreFactory.USER
• JDBCDataStoreFactory.PASSWD

Subclass implementation may remove any parameters from the map, or may overrwrite any parameters in the map.

Overrides:

setupParameters in class JDBCDataStoreFactory

Parameters:

parameters - Map of DataAccessFactory.Param objects.

getDriverClassName

protected final String getDriverClassName()

Description copied from class: JDBCDataStoreFactory

Returns the fully qualified class name of the jdbc driver.

For example: org.postgresql.Driver

Specified by:

getDriverClassName in class JDBCDataStoreFactory

createDataSource

protected BasicDataSource createDataSource(Map<String,?> params,
                                           SQLDialect dialect)
                                    throws IOException

Called by JDBCDataStoreFactory.createDataStore(Map) to set up the JDCB DataSource

Overrides:

createDataSource in class JDBCDataStoreFactory

Parameters:

params - the connection parameters

dialect - the DuckDBDialect from JDBCDataStoreFactory.createSQLDialect(JDBCDataStore, Map)

Throws:

IOException

createDataStoreInternal

protected JDBCDataStore createDataStoreInternal(JDBCDataStore dataStore,
                                                Map<String,?> params)
                                         throws IOException

Description copied from class: JDBCDataStoreFactory

Subclass hook to do additional initialization of a newly created datastore.

Typically subclasses will want to override this method in the case where they provide additional datastore parameters, those should be processed here.

This method is provided with an instance of the datastore. In some cases subclasses may wish to create a new instance of the datastore, for instance in order to wrap the original instance. This is supported but the new datastore must be returned from this method. If not is such the case this method should still return the original passed in.

Overrides:

createDataStoreInternal in class JDBCDataStoreFactory

Parameters:

dataStore - The newly created datastore.

params - THe datastore parameters.

Throws:

IOException

getValidationQuery

protected String getValidationQuery()

Description copied from class: JDBCDataStoreFactory

Override this to return a good validation query (a very quick one, such as one that asks the database what time is it) or return null if the factory does not support validation.

Specified by:

getValidationQuery in class JDBCDataStoreFactory