Package org.geotools.data.geoparquet

Class GeoParquetDataStoreFactory

Object

JDBCDataStoreFactory

AbstractDuckDBDataStoreFactory

GeoParquetDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

public class GeoParquetDataStoreFactory
extends AbstractDuckDBDataStoreFactory
implements DataStoreFactorySpi

DataStoreFactory for GeoParquet files, powered by DuckDB.

This factory creates DataStore instances that can read and query GeoParquet format files, both local and remote. GeoParquet is an open format for geospatial data that builds on the Apache Parquet columnar storage format, providing efficient access to large geospatial datasets.

The implementation uses DuckDB and its extensions (spatial, parquet, httpfs) to handle the heavy lifting of reading and querying Parquet files. This provides excellent performance and compatibility with various storage backends including local files, HTTP/HTTPS, and S3.

Usage example:

 Map<String, Object> params = new HashMap<>();
 params.put("dbtype", "geoparquet");
 params.put("uri", "file:/path/to/data.parquet");

 DataStore store = DataStoreFinder.getDataStore(params);
 

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field	Description
static DataAccessFactory.Param	DBTYPE	Parameter for database type.
static DataAccessFactory.Param	URI_PARAM	Parameter for GeoParquet URI.

Fields inherited from class AbstractDuckDBDataStoreFactory

SCREENMAP, SIMPLIFY

Fields inherited from class JDBCDataStoreFactory

BATCH_INSERT_SIZE, CALLBACK_FACTORY, DATABASE, DATASOURCE, 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
GeoParquetDataStoreFactory()

Method Summary

Modifier and Type	Method	Description
protected void	addDatabaseSpecificParameters(Map<String,Object> parameters)	Allows subclasses to add their specific parameters
protected SQLDialect	createSQLDialect(JDBCDataStore dataStore)	Unused, we override createSQLDialect(JDBCDataStore, Map) instead
protected GeoParquetDialect	createSQLDialect(JDBCDataStore dataStore, Map<String,?> params)	Creates the dialect that the datastore uses for communication with the underlying database.
protected String	getDatabaseID()	Returns a string to identify the type of the database.
String	getDescription()	Describe the nature of the datasource constructed by this factory.
String	getDisplayName()	Name suitable for display to end user.
protected String	getJDBCUrl(Map<String,?> params)	Builds up the JDBC url in a jdbc:://:/ Override if you need a different setup
protected JDBCDataStore	setupDataStore(JDBCDataStore dataStore, Map<String,?> params)	Allows subclasses to perform additional setup for their specific datastores

Methods inherited from class AbstractDuckDBDataStoreFactory

createDataSource, createDataStoreInternal, getDriverClassName, getValidationQuery, setupParameters

Methods inherited from class JDBCDataStoreFactory

canProcess, checkDBType, checkDBType, createDataSource, createDataStore, createNewDataStore, 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, getParametersInfo, isAvailable

Methods inherited from interface DataStoreFactorySpi

createDataStore, createNewDataStore

Methods inherited from interface Factory

getImplementationHints

Field Detail

DBTYPE

public static final DataAccessFactory.Param DBTYPE

Parameter for database type.

Must be "geoparquet" for this DataStore.

URI_PARAM

public static final DataAccessFactory.Param URI_PARAM

Parameter for GeoParquet URI.

Must be a valid URI pointing to a GeoParquet file or directory. Supported schemes:

• file:// - for local files and directories
• https:// - for remote files
• s3:// - for files in S3 storage (requires credentials)

For S3 URIs, additional parameters can be included in the query string:

 s3://bucket/path/to/file.parquet?region=us-west-2&access_key=ACCESS_KEY&secret_key=SECRET_KEY
 

Constructor Detail

GeoParquetDataStoreFactory

public GeoParquetDataStoreFactory()

Method Detail

getDatabaseID

protected String getDatabaseID()

Description copied from class: JDBCDataStoreFactory

Returns a string to identify the type of the database.

Example: 'postgis'.

Specified by:

getDatabaseID in class JDBCDataStoreFactory

getDisplayName

public String getDisplayName()

Description copied from interface: DataAccessFactory

Name suitable for display to end user.

A non localized display name for this data store type.

Specified by:

getDisplayName in interface DataAccessFactory

Overrides:

getDisplayName in class JDBCDataStoreFactory

Returns:

A short name suitable for display in a user interface.

getDescription

public String getDescription()

Description copied from interface: DataAccessFactory

Describe the nature of the datasource constructed by this factory.

A non localized description of this data store type.

Specified by:

getDescription in interface DataAccessFactory

Returns:

A human readable description that is suitable for inclusion in a list of available datasources.

addDatabaseSpecificParameters

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

Description copied from class: AbstractDuckDBDataStoreFactory

Allows subclasses to add their specific parameters

Specified by:

addDatabaseSpecificParameters in class AbstractDuckDBDataStoreFactory

createSQLDialect

protected GeoParquetDialect createSQLDialect(JDBCDataStore dataStore,
                                             Map<String,?> params)

Description copied from class: JDBCDataStoreFactory

Creates the dialect that the datastore uses for communication with the underlying database.

Overrides:

createSQLDialect in class JDBCDataStoreFactory

Parameters:

dataStore - The datastore.

params - The connection parameters

createSQLDialect

protected SQLDialect createSQLDialect(JDBCDataStore dataStore)

Unused, we override createSQLDialect(JDBCDataStore, Map) instead

Specified by:

createSQLDialect in class JDBCDataStoreFactory

Parameters:

dataStore - The datastore.

setupDataStore

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

Description copied from class: AbstractDuckDBDataStoreFactory

Allows subclasses to perform additional setup for their specific datastores

Specified by:

setupDataStore in class AbstractDuckDBDataStoreFactory

Throws:

IOException

getJDBCUrl

protected 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

Specified by:

getJDBCUrl in class AbstractDuckDBDataStoreFactory

Throws:

IOException