mirror of
https://github.com/OpenHFT/Chronicle-Map.git
synced 2021-09-13 01:26:12 +00:00
Merge remote-tracking branch 'origin/doco_refresh' into doco_refresh
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
= Chronicle Map
|
||||
|
||||
Chronicle Map is a super-fast, in-memory, key-value store, designed for low-latency, and/or multi-process applications such as trading and financial market applications.
|
||||
|
||||
Chronicle Map is a super-fast, in-memory, non-blocking, key-value store, designed for low-latency, and/or multi-process
|
||||
applications such as trading and financial market applications.
|
||||
See <<docs/CM_Features.adoc#,Features doc>> for more information.
|
||||
@@ -8,6 +10,13 @@ The size of a Chronicle Map is not limited by memory (RAM), but rather by the av
|
||||
|
||||
image::docs\images\CM_Overview.jpg[]
|
||||
|
||||
== Prerequisites
|
||||
|
||||
To run Chronicle Map, please ensure you have first installed:
|
||||
|
||||
* Java (1.8.0_91 or later)
|
||||
* Apache Maven (3.2.3 or later)
|
||||
|
||||
=== Use cases
|
||||
Chronicle Map is used in production around the
|
||||
world for:
|
||||
|
||||
@@ -8,12 +8,15 @@ Neil Clifford
|
||||
|
||||
toc::[]
|
||||
|
||||
<<<<<<< HEAD
|
||||
=======
|
||||
== Prerequisites
|
||||
|
||||
To run Chronicle Map, please ensure you have first installed:
|
||||
|
||||
* Java (1.8.0_91 or later)
|
||||
* Apache Maven (3.2.3 or later)
|
||||
>>>>>>> origin/doco_refresh
|
||||
|
||||
== License
|
||||
|
||||
|
||||
@@ -18,7 +18,11 @@ applications, such as trading and financial market applications.
|
||||
- **High concurrency**: Write queries scale well up to the number of hardware execution threads in
|
||||
the server. Read queries never block each other.
|
||||
- **Persistence to disk** - (Optional)
|
||||
<<<<<<< HEAD
|
||||
- **Multi-key queries** - (Optional, closed-source) - Eventually-consistent, fully-redundant, asynchronous replication across
|
||||
=======
|
||||
- **Multi-master replication** - (Optional, commercial functionality) - Eventually-consistent, fully-redundant, asynchronous replication across
|
||||
>>>>>>> origin/doco_refresh
|
||||
servers, "last write wins" strategy by default, allows to implement custom https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type[state-based CRDT] strategy.
|
||||
|
||||
== Unique features
|
||||
@@ -31,6 +35,9 @@ applications, such as trading and financial market applications.
|
||||
NOTE: Chronicle Map Replication is a Chronicle Map (Enterprise Edition) feature. +
|
||||
For more information on Chronicle Map (Enterprise Edition), please contact mailto:sales@chronicle.software[sales@chronicle.software].
|
||||
|
||||
NOTE: Chronicle Map Replication is a Chronicle Map (Enterprise Edition) feature. +
|
||||
For more information on Chronicle Map (Enterprise Edition), please contact mailto:sales@chronicle.software[sales@chronicle.software].
|
||||
|
||||
NOTE: See <<CM_Replication.adoc#,Chronicle Map Replication>> for more information.
|
||||
|
||||
**Chronicle Map** has two meanings:
|
||||
|
||||
@@ -173,6 +173,23 @@ The following example uses a basic `yaml` configuration file to define defaults
|
||||
[source, yaml]
|
||||
....
|
||||
!ReplicatedMapCfg {
|
||||
<<<<<<< HEAD
|
||||
|
||||
hostId: 1, # host id must be unique within the cluster
|
||||
listenAddressHostPort: "localhost:9301", # address on which to listen for inbound replication requests
|
||||
entries: 10000, # entries hint suggesting the initial size of the map
|
||||
keyClass: !type long, # class of the key type
|
||||
valueClass: !type long, # class of the value type
|
||||
exampleKey: 17, # an example key (used to size the map)
|
||||
exampleValue: 37, # an example value (used to size the map)
|
||||
name: testLongToLongMap, # a name for the map (used to determine filename)
|
||||
locator: "csp://localhost:9301/map/test", # a locator, used for discovery
|
||||
mapFileDataDirectory: target/mapData, # directory where map file should be stored
|
||||
mapLogDirectory: target/mapReplicationLogs, # directory where replication events should be recorded
|
||||
keysAreConstantSize: true, # determines how keys are serialised
|
||||
valuesAreConstantSize: true # determines how values are serialised
|
||||
|
||||
=======
|
||||
hostId: 1, # host id must be unique within the cluster
|
||||
listenAddressHostPort: "localhost:9301", # address on which to listen for inbound replication requests
|
||||
entries: 10000, # entries hint suggesting the initial size of the map
|
||||
@@ -186,6 +203,7 @@ The following example uses a basic `yaml` configuration file to define defaults
|
||||
mapLogDirectory: target/mapReplicationLogs, # directory where replication events should be recorded
|
||||
keysAreConstantSize: true, # determines how keys are serialised
|
||||
valuesAreConstantSize: true # determines how values are serialised
|
||||
>>>>>>> origin/doco_refresh
|
||||
}
|
||||
....
|
||||
|
||||
|
||||
Reference in New Issue
Block a user