Skip to content

Commit fb8ed47

Browse files
committed
incomplete improvements to docs
1 parent b3d59e9 commit fb8ed47

1 file changed

Lines changed: 20 additions & 15 deletions

File tree

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,26 @@ All while maintaining the same interface for the application. Leaving the decisi
1313
Its most notable claass is `DataObjectMap` which functions as a `SQL` queryable `NoSQL` interface. That functions even against an SQL backend.
1414
Followed by `DStack` which faciltates the stacking of data backend provider for devops. Such as a distributed cache with an SQL backend.
1515

16-
# Support Matrix
17-
18-
| backend | status | notes | DataObjectMap | KeyValueMap | KeyLongMap | FileWorkspaceMap |
19-
|---------------|---------------|------------------------------------------------------|---------------|-------------|------------|------------------|
20-
| struct.simple | development | reference implementation, not for used in production | storage | storage | storage | storage |
21-
| struct.cache | development | | storage | | | |
22-
| jsql | in-production | see SQL support table below for details | full | full | full | full |
23-
| hazelcast | development | | storage | storage | | |
24-
| file.simple | development | | | | | development |
25-
| ignite | development | roadmap | | | | |
26-
| cockroachdb | development | roadmap | | | | |
16+
# Provider Support Matrix
17+
18+
| backend | status | notes | DataObjectMap | KeyValueMap | KeyLongMap | FileWorkspaceMap |
19+
|------------------|---------------|------------------------------------------------------|---------------|-------------|------------|------------------|
20+
| struct.simple | in-production | reference implementation, not recommended for use | storage | storage | storage | storage |
21+
| struct.cache | in-production | local instance caching, useful for WORM data | storage | | | |
22+
| jsql | in-production | *with limits: see SQL support notes below | full | full | full | full |
23+
| hazelcast.cache | in-production | | full | full | full | |
24+
| hazelcast.store | in-production | | full | full | full | |
25+
| file.simple | in-production | | | | | storage |
26+
| file.layered | in-production | | | | | storage |
27+
| ignite | development | roadmap | | | | |
28+
| cockroachdb | development | roadmap | | | | |
29+
30+
**Important notes**
31+
32+
- "full", means it has been optimized for both storage, and query operations.
33+
- "storage" means does not support optimization for queries, for large queries, this can have detrimental performance implication, as the apistack will need to iterate a large number of data.
34+
- Hazelcast require a custom build / deployment with the JavaCommons JAR file to support the required functionality
35+
- MySQL connection / db seems to support only up to 16 digits of accuracy
2736

2837
# Data Structures
2938

@@ -35,7 +44,3 @@ Followed by `DStack` which faciltates the stacking of data backend provider for
3544
| FileWorkspaceMap | development | File workspace storage support |
3645
| MessageQueue | road-map | Message queue |
3746
| JobQueue | road-map | Job request, response queue |
38-
39-
# Important known issues
40-
41-
- MySQL connection / db seems to support only up to 16 digits of accuracy

0 commit comments

Comments
 (0)