Chronicle-Map icon indicating copy to clipboard operation
Chronicle-Map copied to clipboard

Replicate your Key Value Store across your network, with consistency, persistance and performance.

= Chronicle Map Chronicle Software :css-signature: demo :toc: macro :toclevels: 2 :icons: font

image:https://maven-badges.herokuapp.com/maven-central/net.openhft/chronicle-map/badge.svg[caption="",link=https://maven-badges.herokuapp.com/maven-central/net.openhft/chronicle-map] image:https://javadoc.io/badge2/net.openhft/chronicle-map/javadoc.svg[link="https://www.javadoc.io/doc/net.openhft/chronicle-map/latest/index.html"] //image:https://javadoc-badge.appspot.com/net.openhft/chronicle-map.svg?label=javadoc[JavaDoc, link=https://www.javadoc.io/doc/net.openhft/chronicle-map] image:https://img.shields.io/github/license/OpenHFT/Chronicle-Map[GitHub] image:https://img.shields.io/badge/release%20notes-subscribe-brightgreen[link="https://chronicle.software/release-notes/"] image:https://sonarcloud.io/api/project_badges/measure?project=OpenHFT_Chronicle-Map&metric=alert_status[link="https://sonarcloud.io/dashboard?id=OpenHFT_Chronicle-Map"]

image::docs/images/Map_line.png[width=20%]

toc::[]

== About

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.

The size of a Chronicle Map is not limited by memory (RAM), but rather by the available disk capacity.

.Overview image::docs\images\Image1_.png[750,650]

=== Use cases Chronicle Map is used in production around the world for:

real-time trading systems. Chronicle Map provides in-memory access speeds, and supports ultra-low garbage collection. Chronicle Map can support the most demanding of applications. • highly concurrent systems. Chronicle Map supports multiple readers and writers, distributed across multiple machines.

=== Why use Chronicle Map? Chronicle Map is:

fast. Millions of operations per second, with low and stable microsecond latencies for reads and writes. Write queries scale well up to the number of hardware execution threads in the server. Read queries never block each other. • reliable. Chronicle Software have a “chaos monkey” test which verifies Chronicle Map multi-master replication in the face of node and network failures. The map can optionally be persisted to disk. • in production at banks and hedge funds, globally. • built using lessons learnt from real-world experience solving real-world problems. • open source (standard version), and in use at hundreds of sites around the world.

=== Our offering Chronicle Software provides full support for Chronicle Map, consulting to help you make best use of the product, and can also deliver projects using a mix of our resources and your own.

=== Replication Environment Example The following diagram shows an example of Chronicle Map replication over three servers (or sites). Chronicle Map Replication is part of Chronicle Map (Enterprise Edition); a commercially supported version of our successful open source Chronicle Map.

.Three-Way Replication image::docs\images\Image2_.png[750,650]

Replication is multi-master, lock-free, redundant, deterministic, and eventually consistent.

The writer can optionally wait for replication to occur across nodes or regions.

NOTE: See <<docs/CM_Replication.adoc#,Chronicle Map Replication>> for more information.

''' == Documentation The Chronicle Map documentation comprises:

.Documentation |=== |Document|Purpose |<<docs/CM_Features.adoc#,CM_Features>> |Features description. |<<docs/CM_Replication.adoc#,CM_Replication>> |Replication explanation. |<<docs/CM_Tutorial.adoc#,CM_Tutorial>> |Tutorial. |<<docs/CM_FAQs.adoc#,CM_FAQs>> |Frequently asked questions. |<<docs/CM_Download.adoc#,CM_Download>> |Downloading the software. |<<docs/CM_Updates.adoc#,CM_Updates>> |Updates from Chronicle Map version 2. |<<docs/CM_Compatibility_and_Versioning.adoc#,CM_Compatibility_and_Versioning>> |Compatibility and Versioning description. |===

Linked documentation is contained in the docs folder.

== Chronicle Software Release Notes https://chronicle.software/release-notes[Leave your e-mail] to get information about the latest releases and patches to stay up-to-date.