How olacabs/roadrunner works
RoadRunner is an in-memory geospatial record store and query engine. A client supplies records and searches by radial area or partition/ID, applies typed column filters, combines matching record indexes, then streams, groups, sorts, or retrieves records. The store implementation routes data into partition buckets; buckets maintain record versions and indexes, while searchers select buckets and construct filters. The README documents cleanup, checksum intervals, bucket sizing, and cooloff behavior. The graph omits uncertain internal dispatch links where source excerpts do not establish ownership.
Main entry points: GeoSpatialStoreImpl.java Store engine · GeoSpacialSearcherImpl.java Search engine · filter Filter implementations · PartitionBucket.java Partition buckets
Components 20
Client API
- Store API
src/main/java/com/olacabs/roadrunner/api/GeoSpatialStore.java - Record model
src/main/java/com/olacabs/roadrunner/api/Record.java - Indexable fields
src/main/java/com/olacabs/roadrunner/api/IndexableField.java - Searcher API
src/main/java/com/olacabs/roadrunner/api/GeoSpatialSearcher.java
Store and partitions
- Store engine
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Partition routing
src/main/java/com/olacabs/roadrunner/api/Partitioner.java - Partition buckets
src/main/java/com/olacabs/roadrunner/impl/PartitionBucket.java - Record versions
src/main/java/com/olacabs/roadrunner/impl/RecordHolder.java - Version data
src/main/java/com/olacabs/roadrunner/impl/RecordImplVersion.java - Record indexes
src/main/java/com/olacabs/roadrunner/impl/RecordIndexesImpl.java
Search and filters
- Search engine
src/main/java/com/olacabs/roadrunner/impl/GeoSpacialSearcherImpl.java - Typed filter API
src/main/java/com/olacabs/roadrunner/api/filter/ColumnFilterString.java - Filter implementations
src/main/java/com/olacabs/roadrunner/impl/filter - Bitset operations
src/main/java/com/olacabs/BitSetExposed.java - Bitset cache
src/main/java/com/olacabs/roadrunner/impl/BitsetCache.java - Filter dictionaries
src/main/java/com/olacabs/roadrunner/impl/DictionaryHolder.java - S2 query parsing
src/main/java/com/olacabs/roadrunner/lucene/booleangate/S2QueryParser.java
Monitoring and utilities
- Metric collection
src/main/java/com/olacabs/roadrunner/monitor/RoadRunnerMetricFactory.java - Runtime utilities
src/main/java/com/olacabs/roadrunner/utils/RoadRunnerUtils.java
Other components
- Application
Connections 21
- Application → Store API: configures and writes
- Application → Searcher API: builds searches
src/main/java/com/olacabs/roadrunner/api/GeoSpatialSearcher.java - Store API → Store engine: implemented by
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Store engine → Partition buckets: routes records
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Store engine → Search engine: creates searcher
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Store engine → Partition routing: uses partitioning
- Partition buckets → Record versions: stores records
src/main/java/com/olacabs/roadrunner/impl/PartitionBucket.java - Record versions → Version data: keeps versions
src/main/java/com/olacabs/roadrunner/impl/RecordHolder.java - Store engine → Record model: accepts records
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Store engine → Indexable fields: configures fields
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Search engine → Partition buckets: selects buckets
src/main/java/com/olacabs/roadrunner/impl/GeoSpacialSearcherImpl.java - Search engine → Filter implementations: constructs filters
src/main/java/com/olacabs/roadrunner/impl/GeoSpacialSearcherImpl.java - Filter implementations → Typed filter API: implements operations
src/main/java/com/olacabs/roadrunner/impl/filter/ColumnFilterDoubleUniqueImpl.java - Filter implementations → Bitset cache: leases bitsets
src/main/java/com/olacabs/roadrunner/impl/filter/ColumnFilterDoubleUniqueImpl.java - Filter implementations → Record indexes: produces matches
src/main/java/com/olacabs/roadrunner/impl/filter/ColumnFilterDoubleUniqueImpl.java - Record indexes → Bitset operations: holds match bits
src/main/java/com/olacabs/roadrunner/impl/RecordIndexesImpl.java - Search engine → Filter dictionaries: uses dictionaries
src/main/java/com/olacabs/roadrunner/impl/GeoSpacialSearcherImpl.java - Searcher API → Record indexes: consumes indexes
src/main/java/com/olacabs/roadrunner/api/GeoSpatialSearcher.java - Store engine → Metric collection: reports metrics
src/main/java/com/olacabs/roadrunner/impl/GeoSpatialStoreImpl.java - Runtime utilities → Metric collection: records invalid inputs
src/main/java/com/olacabs/roadrunner/utils/RoadRunnerUtils.java - Application → S2 query parsing: parses S2 queries