fdb-record-layer-core 4.8.12.0 API
A record-oriented layer built for the FoundationDB key-value store.
This layer is designed to extend the FoundationDB key-value store by adding a record-oriented data model. Though this layer does not attempt to implement SQL, it does provide relational semantics (broadly defined). In particular, it attempts to provide solutions to:
- Schema management
- Index maintenance
- Query planning and optimization
The basic unit of data is the "record". This corresponds to a "row" in a traditional relational system or to a "document" in a document database. Records are grouped together into "record stores", which are somewhat analogous to a "database" in a traditional relational database, and each record also has a "type" which is somewhat (but not quite) analogous to a "table". (See, however, "Are record types tables?" in the FAQ for an explanation of the differences between the two concepts.)
For a more complete overview of the features and goals of the Record Layer, consult the Record Layer overview.
Packages
Package
Description
A record layer for FoundationDB based on Protocol Buffers.
Cursor implementation classes.
Cursor implementation classes.
Implement locking to be used in
RecordCursors and
various IndexMaintainers for controlling concurrency in
read/write data paths.Helper classes for logging.
Record meta-data structures.
Record keys used in indexes and the primary storage.
Support classes that do not depend on FoundationDB.
Support classes for text indexing.
Classes for FoundationDB record storage.
Classes for interacting with system key client logs in record layer terms.
Record cursors that depend on having access to an actual record store.
Index maintainer classes.
Classes used during index builds.
A directory-like symbolic layout of keys in FoundationDB.
A layer for mapping potentially long strings to and from more compact tuple elements.
Maintain leaderboard as multiple time-windowed ranked sets (so that old scores fall off).
Classes for a property mechanism that supports server-side configuration for Record Layer by its adopter.
Classes for validating and repairing records in the DB.
Classes for running blocks of asynchronous code with-or-without retries.
Throttled iterator: Iterator that cam handle resource constraints and retry on failures.
Classes for caching
RecordStoreState information.Extends the
com.apple.foundationdb.synchronizedsession package to support running operations in
synchronized sessions with FDBDatabaseRunners
and FDBRecordContexts.Classes for querying records.
Utility package to hold general-purpose algorithms used by the Cascades planner.
Classes implementing logical query expression.
Query planner classes.
Classes relating to bitmap operations over
BITMAP_VALUE index entries.This will contain design docs for the Cascades planner at some point.
Stub for planner debugger.
This package implements a visualization of a
RelationalExpression
as a graph for both internal debugging purposes and for consumption by end-users.A variety of planner-specific
RelationalExpression implementations
which will never be used outside of the planner.This package contains everything related to graph matching.
Classes related to the Cascades matcher system and its implementation.
A package for all implementations of the
QueryPredicate.A package for all simplification rules defined over
QueryPredicates.A package for planner properties (in the sense that Cascades uses them).
A package containing the rules used by the planner.
Code to create dynamic messages from structured
Types using protobuf.A package for all implementations of the
Value.Package to contain logic to simplify a tree of
Values.A package for
Value translation algorithms.Classes supporting plan explains.
Support classes for query planning.
Classes implementing executable query plan elements.
Classes related to plan serialization/deserialization.
Classes relating to plan execution with in-memory / file sorting.
Classes relating to hooking up join index synthetic records to the query planner.
A package of classes in the visitor pattern that perform substitutions on a tree of
RecordQueryPlans.Implement sorting for
RecordCursor for use in queries without a sorting index.Miscellaneous record layer support classes.
Classes used for utility classes for handling pairs of elements.
contains implementation of graph network that have stable iteration order over the edges.
Ability to support zero copy byte[] wrapping to ByteString.