- 
                Notifications
    
You must be signed in to change notification settings  - Fork 6.6k
 
RocksJava API TODO
This page sets out the known TODO items for the RocksJava API, it also shows who is thinking/working on a particular topic; Through this mechanism hopefully we can avoid duplicating effort.
- 
Fix locking issues with
Slice/DirectSlicefromComparator. Move to thread-local storage of cached slice objects rather than singleSlicelocking with mutex. @adamretter - 
Perhaps decide weather to use only
SliceorDirectSliceto simplify overall API implementation, probablyDirectSliceis more memory efficient. - 
Use the Slice class in other Java classes where
byte[]was previously used, so that we better align with C++ API, e.g.RocksIterator. - 
Rework
WBWIIteratorto use bothSliceandDirectSlice(see above). - 
Introducefinalon variables/members everywhere they are immutable. - 
Implement
ldbfor Java. For example, the ability to specify the Comparator which implemented in Java. @adamretter - 
Custom merge operator for Java. At the moment it is only possible to use merge operators which are available in C++ but not implementing custom functionality solely in Java. @fyrz
 - 
Expose an AbstractLogger. RocksDB C++ api allows to provide a custom Logger. This shall also be possible from Java side and allows to attach RocksDB logging to application logging facilities. @fyrz
 - 
Port remaining functionality in
db.hto RocksJava. @fyrz - 
Update Statistics/HistogramData to 3.10 @fyrz
 - 
Build isolation. Building Java API should not require building RocksDB. You should be able to use a Java API build with a separate existing RocksDB installation. The Java API native aspect will instead indirectly depend on a shared or static RocksDB lib. @adamretter
 
- 
Move on to Java-8, especially because Java-7 is EOL this year.
 - 
Restructure the package layout within the Java part.
 - 
Implement ARM (Automatic Resource Management) e.g.
try-with-resourcesJava 7 use viaCloseable/AutoCloseablefor iterators, db, write batches etc. - 
Consider converting callbacks to lambda expressions
 
Contents
- RocksDB Wiki
 - Overview
 - RocksDB FAQ
 - Terminology
 - Requirements
 - Contributors' Guide
 - Release Methodology
 - RocksDB Users and Use Cases
 - RocksDB Public Communication and Information Channels
 - 
Basic Operations
- Iterator
 - Prefix seek
 - SeekForPrev
 - Tailing Iterator
 - Compaction Filter
 - Multi Column Family Iterator
 - Read-Modify-Write (Merge) Operator
 - Column Families
 - Creating and Ingesting SST files
 - Single Delete
 - SST Partitioner
 - Low Priority Write
 - Time to Live (TTL) Support
 - Transactions
 - Snapshot
 - DeleteRange
 - Atomic flush
 - Read-only and Secondary instances
 - Approximate Size
 - User-defined Timestamp
 - Wide Columns
 - BlobDB
 - Online Verification
 
 - Options
 - MemTable
 - Journal
 - Cache
 - Write Buffer Manager
 - Compaction
 - SST File Formats
 - IO
 - Compression
 - Full File Checksum and Checksum Handoff
 - Background Error Handling
 - Huge Page TLB Support
 - Tiered Storage (Experimental)
 - Logging and Monitoring
 - Known Issues
 - Troubleshooting Guide
 - Tests
 - Tools / Utilities
 - 
Implementation Details
- Delete Stale Files
 - Partitioned Index/Filters
 - WritePrepared-Transactions
 - WriteUnprepared-Transactions
 - How we keep track of live SST files
 - How we index SST
 - Merge Operator Implementation
 - RocksDB Repairer
 - Write Batch With Index
 - Two Phase Commit
 - Iterator's Implementation
 - Simulation Cache
 - [To Be Deprecated] Persistent Read Cache
 - DeleteRange Implementation
 - unordered_write
 
 - Extending RocksDB
 - RocksJava
 - Lua
 - Performance
 - Projects Being Developed
 - Misc