Package org.geotools.data.duckdb

Class DuckDBDataStore

Object

ForwardingDataStore<JDBCDataStore>

DuckDBDataStore

All Implemented Interfaces:

Wrapper, DataAccess<SimpleFeatureType,SimpleFeature>, DataStore, Wrapper

public class DuckDBDataStore
extends ForwardingDataStore<JDBCDataStore>

Public-facing DuckDB datastore wrapper that avoids exposing the raw JDBC datastore type.

Field Summary

Fields inherited from class ForwardingDataStore

delegate

Constructor Summary

Constructors

Constructor	Description
DuckDBDataStore(JDBCDataStore delegate)
DuckDBDataStore(JDBCDataStore delegate, boolean readOnly)

Method Summary

Modifier and Type	Method	Description
void	createSchema(SimpleFeatureType featureType)	Creates storage for a new featureType.
SimpleFeatureSource	getFeatureSource(String typeName)	Gets a SimpleFeatureSource for features of the specified type.
SimpleFeatureSource	getFeatureSource(Name typeName)	Gets a SimpleFeatureSource for features of the type specified by a qualified name (namespace plus type name).
FeatureWriter<SimpleFeatureType,SimpleFeature>	getFeatureWriter(String typeName, Transaction transaction)	Gets a FeatureWriter to modify features in this DataStore.
FeatureWriter<SimpleFeatureType,SimpleFeature>	getFeatureWriter(String typeName, Filter filter, Transaction transaction)	Gets a FeatureWriter to modify features in this DataStore.
FeatureWriter<SimpleFeatureType,SimpleFeature>	getFeatureWriterAppend(String typeName, Transaction transaction)	Gets a FeatureWriter that can add new features to the DataStore.
boolean	isReadOnly()
void	removeSchema(String typeName)	Used to permanently remove a schema from the underlying storage
void	removeSchema(Name typeName)	Used to permanently remove a schema from the underlying storage
void	updateSchema(String typeName, SimpleFeatureType featureType)	Applies a new schema to the given feature type.
void	updateSchema(Name typeName, SimpleFeatureType featureType)	Used to update a schema in place.

Methods inherited from class ForwardingDataStore

dispose, getFeatureReader, getInfo, getLockingManager, getNames, getSchema, getSchema, getTypeNames, isWrapperFor, unwrap

Methods inherited from class Object

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

Constructor Details

DuckDBDataStore

public DuckDBDataStore(JDBCDataStore delegate)

DuckDBDataStore

public DuckDBDataStore(JDBCDataStore delegate,
 boolean readOnly)

Method Details

isReadOnly

public boolean isReadOnly()

getFeatureSource

public SimpleFeatureSource getFeatureSource(String typeName)
                                     throws IOException

Description copied from interface: DataStore

Gets a SimpleFeatureSource for features of the specified type. SimpleFeatureSource provides a high-level API for feature operations.

The resulting SimpleFeatureSource may implment more functionality as in this example:

 SimpleFeatureSource fsource = dataStore.getFeatureSource("roads");
 if (fsource instanceof SimpleFeatureStore) {
     // we have write access to the feature data
     SimpleFeatureStore fstore = (SimpleFeatureStore) fs;
 }
 else {
     // System.out.println("We do not have write access to roads");
 }
 

Specified by:

getFeatureSource in interface DataStore

Overrides:

getFeatureSource in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - the feature type

Returns:

a SimpleFeatureSource (or possibly a subclass) providing operations for features of the specified type

Throws:

IOException - if data access errors occur

See Also:

• SimpleFeatureSource
• SimpleFeatureStore

getFeatureSource

public SimpleFeatureSource getFeatureSource(Name typeName)
                                     throws IOException

Description copied from interface: DataStore

Gets a SimpleFeatureSource for features of the type specified by a qualified name (namespace plus type name).

Specified by:

getFeatureSource in interface DataAccess<SimpleFeatureType,SimpleFeature>

Specified by:

getFeatureSource in interface DataStore

Overrides:

getFeatureSource in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - the qualified name of the feature type

Returns:

a SimpleFeatureSource (or possibly a subclass) providing operations for features of the specified type

Throws:

IOException - if data access errors occur

See Also:

• DataStore.getFeatureSource(String)
• SimpleFeatureSource
• SimpleFeatureStore

createSchema

public void createSchema(SimpleFeatureType featureType)
                  throws IOException

Description copied from interface: DataAccess

Creates storage for a new featureType.

The provided featureType we be accessable by the typeName provided by featureType.getTypeName().

Specified by:

createSchema in interface DataAccess<SimpleFeatureType,SimpleFeature>

Overrides:

createSchema in class ForwardingDataStore<JDBCDataStore>

Parameters:

featureType - FetureType to add to DataStore

Throws:

IOException - If featureType cannot be created

updateSchema

public void updateSchema(String typeName,
 SimpleFeatureType featureType)
                  throws IOException

Description copied from interface: DataStore

Applies a new schema to the given feature type. This can be used to add or remove properties. The resulting update will be persistent.

Specified by:

updateSchema in interface DataStore

Overrides:

updateSchema in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - name of the feature type to update

featureType - the new schema to apply

Throws:

IOException - on error

updateSchema

public void updateSchema(Name typeName,
 SimpleFeatureType featureType)
                  throws IOException

Description copied from interface: DataAccess

Used to update a schema in place.

This functionality is similar to an "alter table" statement in SQL. Implementation is optional; it may not be supported by all servers or files.

Specified by:

updateSchema in interface DataAccess<SimpleFeatureType,SimpleFeature>

Overrides:

updateSchema in class ForwardingDataStore<JDBCDataStore>

Throws:

IOException - if the operation failed

removeSchema

public void removeSchema(Name typeName)
                  throws IOException

Description copied from interface: DataAccess

Used to permanently remove a schema from the underlying storage

This functionality is similar to an "drop table" statement in SQL. Implementation is optional; it may not be supported by all servers or files.

Specified by:

removeSchema in interface DataAccess<SimpleFeatureType,SimpleFeature>

Overrides:

removeSchema in class ForwardingDataStore<JDBCDataStore>

Throws:

IOException - if the operation failed

removeSchema

public void removeSchema(String typeName)
                  throws IOException

Description copied from interface: DataStore

Used to permanently remove a schema from the underlying storage

This functionality is similar to an "drop table" statement in SQL. Implementation is optional; it may not be supported by all servers or files.

Specified by:

removeSchema in interface DataStore

Overrides:

removeSchema in class ForwardingDataStore<JDBCDataStore>

Throws:

IOException - if the operation failed

getFeatureWriter

public FeatureWriter<SimpleFeatureType,SimpleFeature> getFeatureWriter(String typeName,
 Filter filter,
 Transaction transaction)
                                                                throws IOException

Description copied from interface: DataStore

Gets a FeatureWriter to modify features in this DataStore. FeatureWriter provides an iterator style API to features.

The returned writer does not allow features to be added.

Specified by:

getFeatureWriter in interface DataStore

Overrides:

getFeatureWriter in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - the type name for features that will be accessible

filter - defines additional constraints on the features that will be accessible

transaction - the transaction that the returned writer operates against

Returns:

an instance of FeatureWriter

Throws:

IOException - if data access errors occur

See Also:

• DataStore.getFeatureWriterAppend(String, Transaction)

getFeatureWriter

public FeatureWriter<SimpleFeatureType,SimpleFeature> getFeatureWriter(String typeName,
 Transaction transaction)
                                                                throws IOException

Description copied from interface: DataStore

Gets a FeatureWriter to modify features in this DataStore. FeatureWriter provides an iterator style API to features.

The returned writer does not allow features to be added.

Specified by:

getFeatureWriter in interface DataStore

Overrides:

getFeatureWriter in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - the type name for features that will be accessible

transaction - the transaction that the returned writer operates against

Returns:

an instance of FeatureWriter

Throws:

IOException - if data access errors occur

See Also:

• DataStore.getFeatureWriterAppend(String, Transaction)

getFeatureWriterAppend

public FeatureWriter<SimpleFeatureType,SimpleFeature> getFeatureWriterAppend(String typeName,
 Transaction transaction)
                                                                      throws IOException

Description copied from interface: DataStore

Gets a FeatureWriter that can add new features to the DataStore.

The FeatureWriter will return false when its hasNext() method is called, but next() can be used to acquire new features.

Specified by:

getFeatureWriterAppend in interface DataStore

Overrides:

getFeatureWriterAppend in class ForwardingDataStore<JDBCDataStore>

Parameters:

typeName - name of the feature type for which features will be added

transaction - the transaction to operate against

Returns:

an instance of FeatureWriter that can only be used to append new features

Throws:

IOException - if data access errors occur