add a dispose method to datastore api
-
Motivation: Add a close method to DataStore API
-
Contact: Andrea Aime
The DataStore API is missing a dispose() method that would allow the various datastores holding some kind of resource reference to release it. Notable examples are:
- ArcSDE and JDBC datastores, that hold onto a connection pool
- caching datastore wrappers, that hold onto a in memory or disk based cache
This proposal is ready for discussion.
Voting:
- Andrea Aime +1
- Ian Turton +1
- Justin Deoliveira +1
- Jody Garnett +1
- Martin Desruisseaux +0
- Simone Giannecchini +1
This section is used to make sure your proposal is complete (did you remember documentation?) and has enough paid or volunteer time lined up to be a success
| :white_check_mark: | :no_entry: | :warning: | :negative_squared_cross_mark: |
------------|--------------------|------------|-------------------------|-------------------------------| no progress | done | impeded | lack mandate/funds/time | volunteer needed |
2.4.0-RC1
API changed based on BEFORE / AFTER
Provide an emtpy stub in datastore base classes so that most implementations aren't influenced by the change
Update JDBC data stores so that they close their connection pool
Update ArcSDE data store so that it closes its own connection pool
2.5.0-M1
Forward port above changes
Forward port ArcSDE changes
Update demos/example and user guide
Before datastore users could only release the connection and hope the datastore would clean up after itself somehow (usually letting the garbage collector tear down whatever resource was held into memory):
DataStore myDataStore = ...;
// use datastore
...
myDataStore = null;
System.gc(); System.gc(); System.gc(); // clean up pretty please!!!The proposed change is:
public interface DataStore {
...
/**
* Releases all resources eventually held by this DataStore. The DataStore and all objects
* generated out of it are not supposed to be working anymore after this method is called.
* This call provides no thread safety guarantees, making sure nothing else goes on while
* closing the datastore is a responsibility of the client code.
* Subsequent calls to this method will be treated as no-ops.
*/
public void dispose();
}Sample use:
DataStore myDataStore = null;
try {
myDataStore = ...;
// use data store
...
} finally {
if(myDataStore != null)
myDataStore.dipose();
}Please list the pages effected by this proposal.
Website:
- Update Upgrade to 2.4 instructions
User Guide:
- Update examples to reflect changes to the DataStore API
User Manual:
- Update examples to reflect changes to the DataStore API
Issue Tracker:
- check related issues to see of problems are affected