Pivotal GemFire Tutorial
Pivotal GemFire Tutorial
The tutorial is a guided tour of Pivotal GemFire's core feature set.
Doc Index
- Pivotal GemFire®8.2 Documentation
- Pivotal GemFire 8.2 Release Notes
- Supported Configurations and System Requirements
- Pivotal GemFire User's Guide
-
Getting Started with Pivotal GemFire
- Pivotal GemFire in 15 Minutes or Less
- About Pivotal GemFire
- Main Features of Pivotal GemFire
-
Installing Pivotal GemFire
- OSX: Install Pivotal GemFire from a Homebrew Package
- RHEL: Install Pivotal GemFire from RPM
- Ubuntu: Install Pivotal GemFire from a Debian Package
- Windows/Unix/Linux: Install Pivotal GemFire from a ZIP or tar.gz File
- Obtaining Pivotal GemFire from a Maven Repository
- Obtaining Modified Open Source Code Libraries
- CLASSPATH Settings for GemFire Processes
- How to Uninstall GemFire
- Upgrading Pivotal GemFire
- Setting Up the Product Examples
- Pivotal GemFire Tutorial
- Hello World Example
-
QuickStart Examples
- Setting Up Your Environment for Running the Examples
- Replicated Caching Example
- Server Managed Caching Example
- Partitioned Data Caching Example
- Fixed Partitioning
- Reliable Event Notification Examples
- Persisting Data to Disk Example
- Overflowing Data to Disk Example
- Cache Expiration Example
- Cache Eviction Example
- Querying Example (OQL)
- Transactions Example
- Delta Propagation Example
- Function Execution Example
- JSON Example
- Secure Client Example
- Multiple Secure Client Example
- Distributed Locking Example
- Management and Monitoring Example
- System Alerts JMX Example
- Benchmark Examples
- Product Examples Troubleshooting Checklist
-
Configuring and Running a Cluster
- Overview of the Cluster Configuration Service
- Tutorial: Creating and Using a Cluster Configuration
- Deploying Application JARs to Pivotal GemFire Members
- Using Member Groups
- Exporting and Importing Cluster Configurations
- Cluster Configuration Files and Troubleshooting
- Loading Existing Configuration Files into Cluster Configuration
- Starting Up and Shutting Down Your System
- Running GemFire Locator Processes
- Running GemFire Server Processes
- Managing System Output Files
- Deploying Configuration Files without the Cluster Configuration Service
- Firewall Considerations
-
Basic Configuration and Programming
- Distributed System and Cache Configuration
- Cache Management
-
Data Regions
- Data Region Management
- Creating a Region with gfsh
- Creating a Region Through the cache.xml File
- Creating a Region Through the API
- Region Naming
- Region Shortcuts and Custom Named Region Attributes
- Storing and Retrieving Region Shortcuts and Custom Named Region Attributes
- Managing Region Attributes
- Creating Custom Attributes for Regions and Entries
- Building a New Region with Existing Content
- Data Entries
-
Topologies and Communication
- Topology and Communication General Concepts
- Peer-to-Peer Configuration
- Client/Server Configuration
- Multi-site (WAN) Configuration
-
Managing Pivotal GemFire
-
Pivotal GemFire Management and Monitoring
- Management and Monitoring Features
- Overview of GemFire 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
- Management and Monitoring Programming Examples
- Heap Use and Management
- Disk Storage
- Cache and Region Snapshots
- Region Compression
- Network Partitioning
- Security
-
Performance Tuning and Configuration
-
Improving GemFire Performance on vSphere
- Operating System Guidelines
- NUMA, CPU, and BIOS Settings
- Physical and Virtual NIC Settings
- VMware vSphere vMotion and DRS Cluster Usage
- Placement and Organization of Virtual Machines
- Virtual Machine Memory Reservation
- vSphere High Availability and Pivotal GemFire
- Storage Guidelines
- Additional Resources
- Performance Controls
- System Member Performance
- Slow Receivers with TCP/IP
- Slow distributed-ack Messages
- Socket Communication
- UDP Communication
- Multicast Communication
- Maintaining Cache Consistency
-
Improving GemFire Performance on vSphere
- 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
-
Pivotal GemFire Management and Monitoring
-
Developing with Pivotal GemFire
- 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
- 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
-
GemFire PDX Serialization
- GemFire 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 GemFire Cache
- Using PdxInstanceFactory to Create PdxInstances
- Persisting PDX Metadata to Disk
- Using PDX Objects as Region Entry Keys
- GemFire Data Serialization (DataSerializable and DataSerializer)
- Standard Java Serialization
- Events and Event Handling
- Delta Propagation
-
Querying
- GemFire Querying FAQ and Examples
- Basic Querying
-
Advanced Querying
- Performance Considerations
- Monitoring Low Memory When Querying
- Timeouts for Long-Running Queries
- Using Query Bind Parameters
-
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
- Querying Partitioned Regions
- Continuous Querying
-
Transactions
- About Transactions
- Types of Transactions
-
GemFire Cache Transactions
- Cache Transaction Performance
- Data Location for Cache Transactions
- How to Run a GemFire Cache Transaction
- How to Run a GemFire Cache Transaction that Coordinates with an External Database
-
Working with GemFire Cache Transactions
- Setting Global Copy on Read
- Making a Safe Change Within a Transaction Using CopyHelper.copy
- Transactions and Functions
- Using Queries and Indexes with Transactions
- Collections and Region.Entry Instances in Transactions
- Using Eviction and Expiration Operations
- Transactions and Consistent Regions
- Suspending and Resuming Transactions
- Using Cache Writer and Cache Listener Plug-Ins
- Configuring Transaction Plug-In Event Handlers
- How Transaction Events Are Managed
- How GemFire Cache Transactions Work
- JTA Global Transactions with GemFire
- Monitoring and Troubleshooting Transactions
- Transaction Coding Examples
- Function Execution
-
Developing REST Applications for Pivotal GemFire
- GemFire 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
-
Pivotal GemFire REST API Reference
-
Region Endpoints
- GET /gemfire-api/v1
- GET /gemfire-api/v1/{region}
- GET /gemfire-api/v1/{region}/keys
- GET /gemfire-api/v1/{region}/{key}
- GET /gemfire-api/v1/{region}/{key1},{key2},...,{keyN}
- HEAD /gemfire-api/v1/{region}
- POST /gemfire-api/v1/{region}?key=<key>
- PUT /gemfire-api/v1/{region}/{key}
- PUT /gemfire-api/v1/{region}/{key1},{key2},...{keyN}
- PUT /gemfire-api/v1/{region}/{key}?op=REPLACE
- PUT /gemfire-api/v1/{region}/{key}?op=CAS
- DELETE /gemfire-api/v1/{region}
- DELETE /gemfire-api/v1/{region}/{key}
- DELETE /gemfire-api/v1/{region}/{key1},{key2},...{keyN}
- Query Endpoints
- Function Endpoints
- Administrative Endpoints
-
Region Endpoints
-
Tools and Modules
- DiskConverterPre65to65
- Gemcached
-
gfsh (GemFire SHell)
- What You Can Do with gfsh
- Starting gfsh
- Configuring the gfsh Environment
- Useful gfsh Shell Variables
- Basic Shell Features and Command-Line Usage
- Tutorial: Performing Common Tasks with gfsh
-
Quick Reference of gfsh Commands by Functional Area
- Basic GemFire gfsh Commands
- Configuration Commands
- Data Commands
- Deployment Commands
- Disk Store Commands
- Durable CQ and Client Commands
- Function Execution Commands
- Gateway (WAN) Commands
- GemFire Monitoring Commands
- Index Commands
- JMX Connection Commands
- Locator 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
- encrypt password
- 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
- resume gateway-sender
- revoke missing-disk-store
- run
- set variable
- sh
- show
- shutdown
- sleep
- start
- status
- stop
- undeploy
- upgrade offline-disk-store
- validate offline-disk-store
- version
- Creating and Running gfsh Command Scripts
- Running gfsh Commands on the OS Command Line
- Mapping of cache.xml Elements to gfsh Configuration Commands.
-
Hibernate Cache Module
- Why Use GemFire with Hibernate?
- How GemFire Works with Hibernate
- Installing the Hibernate Cache Module
- Setting Up the GemFire Hibernate Cache Module
- Advanced Configuration (Hibernate Cache Module)
- Changing Pivotal GemFire Default Configuration (Hibernate Cache Module)
- Using Hibernate Cache Module with HTTP Session Management Module
-
HTTP Session Management Modules
- HTTP Session Management Quick Start
- Advantages of Using GemFire for Session Management
- Common Topologies for HTTP Session Management
- General Information on HTTP Session Management
- Session State Log Files
- HTTP Session Management Module for Pivotal tc Server
- HTTP Session Management Module for Tomcat
- HTTP Session Management Module for AppServers
- GemFire Pulse
- Visual Statistics Display
-
Reference
- gemfire.properties and gfsecurity.properties (GemFire Properties)
-
cache.xml
- cache.xml Quick Reference
- <cache> Element Hierarchy
-
<cache> Element Reference
- <cache-transaction-manager>
- <dynamic-region-factory>
- <gateway-hub>
- <gateway>
- <gateway-sender>
- <gateway-receiver>
- <gateway-conflict-resolver>
- <async-event-queue>
- <cache-server>
- <pool>
- <disk-store>
- <pdx>
- <region-attributes>
- <jndi-bindings>
- <region>
- <vm-root-region>
- <function-service>
- <resource-manager>
- <serialization-registration>
- <backup>
- <initializer>
- <class-name> and <parameter>
- <declarable>
- <string>
- <client-cache> Element Hierarchy
-
<client-cache> Element Reference
- <cache-transaction-manager>
- <pool>
- <disk-store>
- <pdx>
- <region-attributes>
- <jndi-bindings>
- <region>
- <function-service>
- <resource-manager>
- <serialization-registration>
- <initializer>
-
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
-
GemFire Statistics List
- Cache Performance (CachePerfStats)
- Cache Server (CacheServerStats)
- Client-Side Notifications (CacheClientUpdaterStats)
- Client-to-Server Messaging Performance (ClientStats)
- Client Connection Pool (PoolStats)
- Delta Propagation (DeltaPropagationStatistics)
- Disk Space Usage (DiskDirStatistics)
- Disk Usage and Performance (DiskRegionStatistics)
- Distributed System Messaging (DistributionStats)
- Distributed Lock Services (DLockStats)
- Function Execution (FunctionServiceStatistics)
- Indexes (IndexStats)
- JVM Performance
- Locator (LocatorStatistics)
- Partitioned Regions (PartitionedRegion<partitioned_region_name>Statistics)
- Operating System Statistics - Linux
- Operating System Statistics - Solaris
- Operating System Statistics - Windows
- 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)
- Continuous Querying (CQStatistics)
- Gateway Queue (GatewayStatistics)
- Glossary
- Pivotal GemFire 8.2.x Native Client User's Guide
- Pivotal GemFire Native Client 8.2 Release Notes
- Pivotal GemFire Native Client Supported Configurations
- Getting Started with Pivotal GemFire Native Client
- Setting System Properties
- Configuring the Native Client Cache
-
Pivotal GemFire Native Client C++ API
- About the Native Client C++ API
- Creating a Cache
- Creating a Proxy Client-Side Region
- Adding an Entry to the Cache
- Accessing an Entry
- Removing an Entry
-
Serializing Data
- Region Data Requiring Serialization
- Data Serialization Options
-
Serializing Data with GemFire PDX Serialization
- Serialize Your Domain Objects with PdxSerializer and PdxWrapper
- Serialize Using the GemFire PdxSerializable Class
- Using Automatic PDX Serialization
- Programming Your Application to Use PdxInstances
- Configuring PDX to Ignore Unread Fields During Deserialization
- Using PdxInstanceFactory to Create PdxInstances
- Using C++ Enum Type with PDX Serialization
- Using PDX Serialization with Delta Propagation
- Serializing Data with the GemFire Serializable Interface
- Serializing Object Graphs
- Serializing and Accessing Data as a Blob
- Implementing User-Defined Objects in Java Clients
- Using a Custom Class
- Creating New Statistics
-
Pivotal GemFire Native Client C# .NET API
- About the Native Client C# .NET API
- C++ Class to .NET Class Mappings
- Java to .NET Type Mapping Table
- Object Lifetimes
- .NET Application Domains
- Creating a Cache
- Creating a Region
- Adding an Entry to the Cache
- Accessing an Entry
- Removing an Entry
-
Data Serialization
- Data Serialization Options
-
Serialize with GemFire PDX Serialization
- GemFire PDX Serialization Features
- Serialize Using the GemFire PDX Autoserializer
- Extend the PDX Autoserializer
- Serialize Your Domain Objects with IPdxSerializer
- Serialize Using the GemFire IPdxSerializable Interface
- Program Your Application to Use IPdxInstance
- Use the IPdxInstanceFactory to Create IPdxInstances
- Map .NET Domain Type Names to PDX Type Names with IPdxTypeMapper
- Serialize with the GemFire IGFSerializable Interface
- Using a Custom Class With IGFSerializable
- Application Callbacks
- A Simple C# Example
- Troubleshooting .NET Applications
-
Preserving Data
- High Availability for Client-Server Communication
- Enabling Queue Conflation to Improve Update Performance
- Durable Client Messaging
- Security
- Remote Querying
- Continuous Querying
- Using Connection Pools
- Transactions
- Function Execution
- Delta Propagation
- Programming Examples
- Interoperability of Language Classes and Types
- System Statistics
- Installing the SQLite Persistence Manager
- Glossary