Apache Geode
CHANGELOG
Supported Character Sets
Geode query language supports the full ASCII and Unicode character sets.
Apache Geode Documentation
Doc Index
- Apache Geode Documentation
- Getting Started with Apache Geode
- Security
-
Configuring and Running a Cluster
- Overview of the Cluster Configuration Service
- Tutorial—Creating and Using a Cluster Configuration
- Deploying Application JARs to Apache Geode Members
- Using Member Groups
- Exporting and Importing Cluster Configurations
- Cluster Configuration Files and Troubleshooting
- Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS
- Deploying Configuration Files without the Cluster Configuration Service
- Starting Up and Shutting Down Your System
- Running Geode Locator Processes
- Running Geode Server Processes
- Managing System Output Files
- Firewall Considerations
- Cluster Management Service (Experimental)
- Basic Configuration and Programming
-
Topologies and Communication
- Topology and Communication General Concepts
- Peer-to-Peer Configuration
- Client/Server Configuration
- Multi-site (WAN) Configuration
-
Managing Apache Geode
-
Apache Geode Management and Monitoring
- Management and Monitoring Features
- Overview of Geode Management and Monitoring Tools
- Architecture and Components
- JMX Manager Operations
- Federated MBean Architecture
- Configuring RMI Registry Ports and RMI Connectors
- Executing gfsh Commands through the Management API
- Managing Heap and Off-heap Memory
- Disk Storage
- Cache and Region Snapshots
- Region Compression
- Network Partitioning
- Performance Tuning and Configuration
- Logging
- Statistics
-
Troubleshooting and System Recovery
- Producing Artifacts for Troubleshooting
- Diagnosing System Problems
- System Failure and Recovery
- Handling Forced Cache Disconnection Using Autoreconnect
- Recovering from Application and Cache Server Crashes
- Recovering from Machine Crashes
- Recovering from ConfictingPersistentDataExceptions
- Preventing and Recovering from Disk Full Errors
- Understanding and Recovering from Network Outages
- Log Messages and Solutions
-
Apache Geode Management and Monitoring
-
Developing with Apache Geode
- Region Data Storage and Distribution
-
Partitioned Regions
- Understanding Partitioning
- Configuring Partitioned Regions
- Configuring the Number of Buckets for a Partitioned Region
- Custom-Partitioning and Colocating Data
- Configuring High Availability for Partitioned Regions
- Configuring Single-Hop Client Access to Server-Partitioned Regions
- Rebalancing Partitioned Region Data
- Checking Redundancy in Partitioned Regions
- Restoring Redundancy in Partitioned Regions
- Moving Partitioned Region Data to Another Member
- Distributed and Replicated Regions
- Consistency for Region Updates
- General Region Data Management
-
Data Serialization
- Overview of Data Serialization
-
Geode PDX Serialization
- Geode PDX Serialization Features
- High Level Steps for Using PDX Serialization
- Using Automatic Reflection-Based PDX Serialization
- Serializing Your Domain Object with a PdxSerializer
- Implementing PdxSerializable in Your Domain Object
- Programming Your Application to Use PdxInstances
- Adding JSON Documents to the Geode Cache
- Using PdxInstanceFactory to Create PdxInstances
- Persisting PDX Metadata to Disk
- Using PDX Objects as Region Entry Keys
- Geode Data Serialization (DataSerializable and DataSerializer)
- Standard Java Serialization
- Events and Event Handling
- Delta Propagation
-
Querying
- Querying FAQ and Examples
- Querying with OQL
- Writing and Executing a Query in OQL
- Advanced Querying
-
Working with Indexes
- Tips and Guidelines on Using Indexes
- Creating, Listing and Removing Indexes
- Creating Key Indexes
- Creating Hash Indexes
- Creating Indexes on Map Fields ("Map Indexes")
- Creating Multiple Indexes at Once
- Maintaining Indexes (Synchronously or Asynchronously) and Index Storage
- Using Query Index Hints
- Using Indexes on Single Region Queries
- Using Indexes with Equi-Join Queries
- Using Indexes with Overflow Regions
- Using Indexes on Equi-Join Queries using Multiple Regions
- Index Samples
- Continuous Querying
- Transactions
- Function Execution
-
Developing REST Applications for Apache Geode
- Geode REST API Overview
- Prerequisites and Limitations for Writing REST Applications
- Setup and Configuration
- Using the Swagger UI to Browse REST APIs
- Developing REST Applications
- Sample REST Applications
- Troubleshooting and FAQ
-
Apache Geode REST API Reference
-
Region Endpoints
- GET /geode/v1
- GET /geode/v1/{region}
- GET /geode/v1/{region}/keys
- GET /geode/v1/{region}/{key}
- GET /geode/v1/{region}/{key1},{key2},...,{keyN}
- HEAD /geode/v1/{region}
- POST /geode/v1/{region}?key=<key>
- PUT /geode/v1/{region}/{key}
- PUT /geode/v1/{region}/{key1},{key2},...{keyN}
- PUT /geode/v1/{region}/{key}?op=REPLACE
- PUT /geode/v1/{region}/{key}?op=CAS
- DELETE /geode/v1/{region}
- DELETE /geode/v1/{region}/{key}
- DELETE /geode/v1/{region}/{key1},{key2},...{keyN}
- Query Endpoints
- Function Endpoints
- Administrative Endpoints
-
Region Endpoints
-
Tools and Modules
-
gfsh
- What You Can Do with gfsh
- Starting gfsh
- Configuring the gfsh Environment
- Useful gfsh Shell Variables
- Basic Shell Features and Command-Line Usage
- Specifying JSON within Command-Line Options
- Tutorial—Performing Common Tasks with gfsh
-
Quick Reference of gfsh Commands by Functional Area
- Basic Geode gfsh Commands
- Configuration Commands
- Data Commands
- Deployment Commands
- Disk Store Commands
- Durable CQ and Client Commands
- Function Execution Commands
- Gateway (WAN) Commands
- Geode Monitoring Commands
- Index Commands
- JMX Connection Commands
- Locator Commands
- Lucene Commands
- PDX Commands
- Region Commands
- Server Commands
-
gfsh Command Help
- alter
- backup disk-store
- change loglevel
- clear defined indexes
- close
- compact
- configure
- connect
- create
- debug
- define index
- deploy
- describe
- destroy
- disconnect
- echo
- execute function
- exit
- export
- gc
- get
- help
- hint
- history
- import
- list
- load-balance gateway-sender
- locate entry
- netstat
- pause gateway-sender
- pdx rename
- put
- query
- rebalance
- remove
- restore redundancy
- resume
- revoke missing-disk-store
- run
- search lucene
- set variable
- sh
- show
- shutdown
- sleep
- start
- status
- stop
- undeploy
- validate offline-disk-store
- version wan-copy region
- Creating and Running gfsh Command Scripts
- Running gfsh Commands on the OS Command Line
- Mapping cache.xml Elements to gfsh Configuration Commands
- Gemcached
-
HTTP Session Management Modules
- HTTP Session Management Quick Start
- Advantages of Using Geode for Session Management
- Common Topologies for HTTP Session Management
- General Information on HTTP Session Management
- Session State Log Files
- Configuring Non-Sticky Sessions
- HTTP Session Management Module for Pivotal tc Server
- HTTP Session Management Module for Tomcat
- HTTP Session Management Module for AppServers
- Geode Pulse
- Apache Lucene Integration
- Micrometer
-
gfsh
- Use Cases
-
Reference
- gemfire.properties and gfsecurity.properties (Geode Properties)
- cache.xml
-
Region Shortcuts
- Region Shortcuts Quick Reference
- LOCAL
- LOCAL_HEAP_LRU
- LOCAL_OVERFLOW
- LOCAL_PERSISTENT
- LOCAL_PERSISTENT_OVERFLOW
- PARTITION
- PARTITION_HEAP_LRU
- PARTITION_OVERFLOW
- PARTITION_PERSISTENT
- PARTITION_PERSISTENT_OVERFLOW
- PARTITION_PROXY
- PARTITION_PROXY_REDUNDANT
- PARTITION_REDUNDANT
- PARTITION_REDUNDANT_HEAP_LRU
- PARTITION_REDUNDANT_OVERFLOW
- PARTITION_REDUNDANT_PERSISTENT
- PARTITION_REDUNDANT_PERSISTENT_OVERFLOW
- REPLICATE
- REPLICATE_HEAP_LRU
- REPLICATE_OVERFLOW
- REPLICATE_PERSISTENT
- REPLICATE_PERSISTENT_OVERFLOW
- REPLICATE_PROXY
- Exceptions and System Failures
- Memory Requirements for Cached Data
-
Geode Statistics List
- Cache Performance (CachePerfStats)
- Cache Server (CacheServerStats)
- Client-Side Notifications (CacheClientUpdaterStats)
- Client-to-Server Messaging Performance (ClientStats)
- Client Connection Pool (PoolStats)
- Continuous Querying (CQStatistics)
- Delta Propagation (DeltaPropagationStatistics)
- Disk Space Usage (DiskDirStatistics)
- Disk Usage and Performance (DiskRegionStatistics)
- Distributed System Messaging (DistributionStats)
- Distributed Lock Services (DLockStats)
- Function Execution (FunctionServiceStatistics)
- Gateway Queue (GatewayStatistics)
- Indexes (IndexStats)
- JVM Performance
- Locator (LocatorStatistics)
- Lucene Indexes (LuceneIndexStats)
- Off-Heap (OffHeapMemoryStats)
- Operating System Statistics - Linux
- Partitioned Regions (PartitionedRegion<partitioned_region_name>Statistics)
- Region Entry Eviction – Count-Based (LRUStatistics)
- Region Entry Eviction – Size-based (LRUStatistics)
- Server Notifications for All Clients (CacheClientNotifierStatistics)
- Server Notifications for Single Client (CacheClientProxyStatistics)
- Server-to-Client Messaging Performance (ClientSubscriptionStats)
- Statistics Collection (StatSampler)
- Transaction Reference Material
- Glossary
Apache Geode
CHANGELOG