| <div align="center"> |
| |
| [](http://geode.apache.org) |
| |
| [](https://concourse.apachegeode-ci.info/teams/main/pipelines/apache-develop-main) [](https://www.apache.org/licenses/LICENSE-2.0) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.geode%22) [](https://formulae.brew.sh/formula/apache-geode) [](https://hub.docker.com/r/apachegeode/geode/) [](https://lgtm.com/projects/g/apache/geode/alerts/) [](https://lgtm.com/projects/g/apache/geode/context:java) [](https://lgtm.com/projects/g/apache/geode/context:javascript) [](https://lgtm.com/projects/g/apache/geode/context:python) |
| |
| </div> |
| |
| ## Contents |
| 1. [Overview](#overview) |
| 1. [How to Get Apache Geode](#obtaining) |
| 1. [Main Concepts and Components](#concepts) |
| 1. [Location of Directions for Building from Source](#building) |
| 1. [Geode in 5 minutes](#started) |
| 1. [Application Development](#development) |
| 1. [Documentation](https://geode.apache.org/docs/) |
| 1. [Wiki](https://cwiki.apache.org/confluence/display/GEODE/Index) |
| 1. [How to Contribute](https://cwiki.apache.org/confluence/display/GEODE/How+to+Contribute) |
| 1. [Export Control](#export) |
| |
| ## <a name="overview"></a>Overview |
| |
| [Apache Geode](http://geode.apache.org/) is |
| a data management platform that provides real-time, consistent access to |
| data-intensive applications throughout widely distributed cloud architectures. |
| |
| Apache Geode pools memory, CPU, network resources, and optionally local disk |
| across multiple processes to manage application objects and behavior. It uses |
| dynamic replication and data partitioning techniques to implement high |
| availability, improved performance, scalability, and fault tolerance. In |
| addition to being a distributed data container, Apache Geode is an in-memory |
| data management system that provides reliable asynchronous event notifications |
| and guaranteed message delivery. |
| |
| Apache Geode is a mature, robust technology originally developed by GemStone |
| Systems. Commercially available as GemFire™, it was first deployed in the |
| financial sector as the transactional, low-latency data engine used in Wall |
| Street trading platforms. Today Apache Geode technology is used by hundreds of |
| enterprise customers for high-scale business applications that must meet low |
| latency and 24x7 availability requirements. |
| |
| ## <a name="obtaining"></a>How to Get Apache Geode |
| |
| You can download Apache Geode from the |
| [website](https://geode.apache.org/releases/), run a Docker |
| [image](https://hub.docker.com/r/apachegeode/geode/), or install with |
| [Homebrew](https://formulae.brew.sh/formula/apache-geode) on OSX. Application developers |
| can load dependencies from [Maven |
| Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.geode%22). |
| |
| Maven |
| ```xml |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.geode</groupId> |
| <artifactId>geode-core</artifactId> |
| <version>$VERSION</version> |
| </dependency> |
| </dependencies> |
| ``` |
| |
| Gradle |
| ```groovy |
| dependencies { |
| compile "org.apache.geode:geode-core:$VERSION" |
| } |
| ``` |
| |
| ## <a name="concepts"></a>Main Concepts and Components |
| |
| _Caches_ are an abstraction that describe a node in an Apache Geode distributed |
| system. |
| |
| Within each cache, you define data _regions_. Data regions are analogous to |
| tables in a relational database and manage data in a distributed fashion as |
| name/value pairs. A _replicated_ region stores identical copies of the data on |
| each cache member of a distributed system. A _partitioned_ region spreads the |
| data among cache members. After the system is configured, client applications |
| can access the distributed data in regions without knowledge of the underlying |
| system architecture. You can define listeners to receive notifications when |
| data has changed, and you can define expiration criteria to delete obsolete |
| data in a region. |
| |
| _Locators_ provide clients with both discovery and server load balancing |
| services. Clients are configured with locator information, and the locators |
| maintain a dynamic list of member servers. The locators provide clients with |
| connection information to a server. |
| |
| Apache Geode includes the following features: |
| |
| * Combines redundancy, replication, and a "shared nothing" persistence |
| architecture to deliver fail-safe reliability and performance. |
| * Horizontally scalable to thousands of cache members, with multiple cache |
| topologies to meet different enterprise needs. The cache can be |
| distributed across multiple computers. |
| * Asynchronous and synchronous cache update propagation. |
| * Delta propagation distributes only the difference between old and new |
| versions of an object (delta) instead of the entire object, resulting in |
| significant distribution cost savings. |
| * Reliable asynchronous event notifications and guaranteed message delivery |
| through optimized, low latency distribution layer. |
| * Data awareness and real-time business intelligence. If data changes as |
| you retrieve it, you see the changes immediately. |
| * Integration with Spring Framework to speed and simplify the development |
| of scalable, transactional enterprise applications. |
| * JTA compliant transaction support. |
| * Cluster-wide configurations that can be persisted and exported to other |
| clusters. |
| * Remote cluster management through HTTP. |
| * REST APIs for REST-enabled application development. |
| * Rolling upgrades may be possible, but they will be subject to any |
| limitations imposed by new features. |
| |
| ## <a name="building"></a>Building this Release from Source |
| |
| See [BUILDING.md](./BUILDING.md) for |
| instructions on how to build the project. |
| |
| ## <a name="testing"></a>Running Tests |
| See [TESTING.md](./TESTING.md) for |
| instructions on how to run tests. |
| |
| ## <a name="started"></a>Geode in 5 minutes |
| |
| Geode requires installation of JDK version 1.8. After installing Apache Geode, |
| start a locator and server: |
| ```console |
| $ gfsh |
| gfsh> start locator |
| gfsh> start server |
| ``` |
| |
| Create a region: |
| ```console |
| gfsh> create region --name=hello --type=REPLICATE |
| ``` |
| |
| Write a client application (this example uses a [Gradle](https://gradle.org) |
| build script): |
| |
| _build.gradle_ |
| ```groovy |
| apply plugin: 'java' |
| apply plugin: 'application' |
| |
| mainClassName = 'HelloWorld' |
| |
| repositories { mavenCentral() } |
| dependencies { |
| compile 'org.apache.geode:geode-core:1.4.0' |
| runtime 'org.slf4j:slf4j-log4j12:1.7.24' |
| } |
| ``` |
| |
| _src/main/java/HelloWorld.java_ |
| ```java |
| import java.util.Map; |
| import org.apache.geode.cache.Region; |
| import org.apache.geode.cache.client.*; |
| |
| public class HelloWorld { |
| public static void main(String[] args) throws Exception { |
| ClientCache cache = new ClientCacheFactory() |
| .addPoolLocator("localhost", 10334) |
| .create(); |
| Region<String, String> region = cache |
| .<String, String>createClientRegionFactory(ClientRegionShortcut.CACHING_PROXY) |
| .create("hello"); |
| |
| region.put("1", "Hello"); |
| region.put("2", "World"); |
| |
| for (Map.Entry<String, String> entry : region.entrySet()) { |
| System.out.format("key = %s, value = %s\n", entry.getKey(), entry.getValue()); |
| } |
| cache.close(); |
| } |
| } |
| ``` |
| |
| Build and run the `HelloWorld` example: |
| ```console |
| $ gradle run |
| ``` |
| |
| The application will connect to the running cluster, create a local cache, put |
| some data in the cache, and print the cached data to the console: |
| ```console |
| key = 1, value = Hello |
| key = 2, value = World |
| ``` |
| |
| Finally, shutdown the Geode server and locator: |
| ```console |
| gfsh> shutdown --include-locators=true |
| ``` |
| |
| For more information see the [Geode |
| Examples](https://github.com/apache/geode-examples) repository or the |
| [documentation](https://geode.apache.org/docs/). |
| |
| ## <a name="development"></a>Application Development |
| |
| Apache Geode applications can be written in these client technologies: |
| |
| * Java [client](https://geode.apache.org/docs/guide/18/topologies_and_comm/cs_configuration/chapter_overview.html) |
| or [peer](https://geode.apache.org/docs/guide/18/topologies_and_comm/p2p_configuration/chapter_overview.html) |
| * [REST](https://geode.apache.org/docs/guide/18/rest_apps/chapter_overview.html) |
| * [Memcached](https://cwiki.apache.org/confluence/display/GEODE/Moving+from+memcached+to+gemcached) |
| |
| The following libraries are available external to the Apache Geode project: |
| |
| * [Spring Data GemFire](https://projects.spring.io/spring-data-gemfire/) |
| * [Spring Cache](https://docs.spring.io/spring/docs/current/spring-framework-reference/html/cache.html) |
| * [Python](https://github.com/gemfire/py-gemfire-rest) |
| |
| ## <a name="export"></a>Export Control |
| |
| This distribution includes cryptographic software. |
| The country in which you currently reside may have restrictions |
| on the import, possession, use, and/or re-export to another country, |
| of encryption software. BEFORE using any encryption software, |
| please check your country's laws, regulations and policies |
| concerning the import, possession, or use, and re-export of |
| encryption software, to see if this is permitted. |
| See <http://www.wassenaar.org/> for more information. |
| |
| The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), |
| has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, |
| which includes information security software using or performing |
| cryptographic functions with asymmetric algorithms. |
| The form and manner of this Apache Software Foundation distribution makes |
| it eligible for export under the License Exception |
| ENC Technology Software Unrestricted (TSU) exception |
| (see the BIS Export Administration Regulations, Section 740.13) |
| for both object code and source code. |
| |
| The following provides more details on the included cryptographic software: |
| |
| * Apache Geode is designed to be used with |
| [Java Secure Socket Extension](https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html) (JSSE) and |
| [Java Cryptography Extension](https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) (JCE). |
| The [JCE Unlimited Strength Jurisdiction Policy](https://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) |
| may need to be installed separately to use keystore passwords with 7 or more characters. |
| * Apache Geode links to and uses [OpenSSL](https://www.openssl.org/) ciphers. |
| |
