Welcome to the Terracotta Online Documentation
About Terracotta
Introduction to Terracotta
What is Ehcache?
Features
Basic Terms
Data Freshness and Expiration
Storage Tiers
Topology Types
What is TCStore?
Core Concepts of TCStore
API Usages
Advanced Topics
Frequently Asked Questions
What is the Terracotta Server?
What is the Terracotta Management Console?
JAVADOC Documentation of the APIs
Terracotta Installation Guide
Installation Overview
Installing using the Software AG Installer
Installing using the Native Kit
Configuring Your Environment
Evaluation Licenses
System Requirements
Planning a Successful Deployment
TCStore API Developer Guide
Reference
Concepts
Data Model
Working with Complex Data Types
Configuration and Lifecycle Operations
Clustered DatasetManager using the API
Clustered DatasetManager using XML
Operations
Clustered Reconnection
Server-Side Connection Management
Client-Side Connection Management
CRUD Operations
Streams
Asynchronous API
Functional DSL
Indexes
Usage and Best Practices
Stream Optimizations
Failover Tuning for TCStore
Connection Pooling
Textual Query Language Extension
Reference
Concepts
Operations
Usage and Best Practice
Application Scenarios
Interplay with Native Stream API
Performance Considerations
Transactions Extension
Overview
Transaction Controller
Transaction Execution
Transaction ExecutionBuilder
Transactional Operation Behavior
Stream Operations
Best practices
Ehcache API Developer Guide
Caching Basics
Primary Classes
Comparison of CacheManager to UserManagedCache
Creating and Configuring a CacheManager Using Java
Going Through the Lifecycle of a Cache
Configuring Storage Tiers using Java
Creating a Cache Manager with Clustering Support
Data Freshness
Configuring a CacheManager Using XML
Configuring Storage Tiers using XML
The XML Schema Definition
Property replacement in XML configuration files
XML Programmatic Parsing
Programmatic configuration to XML
Multiple XML Configurations in one Document
Multiple Ehcache Manager Configurations
Multiple Cache Manager Variants
Multiple Cache Manager Retrieval
Building XML Multi Configurations
Configuration Derivation
Principles
Core Configuration Changes
Extended Configuration Changes
The JCache (JSR-107) Cache Provider
Overview of JCache
Using Ehcache as a JCache Provider
Getting Started with Ehcache and JCache (JSR-107)
Integrating JCache and Ehcache Configurations
Differences in Default Behavior between Ehcache and Ehcache through JCache
User Managed Caches
Overview of User Managed Caches
API Extensions
Code examples for User Managed Caches
Cache Usage Patterns
Data Freshness and Expiry
Data Freshness
Expiry
Transactions Support
What is supported and what are the limitations?
Configuring it all in Java
Configuring it with XML
Tiering Options
Cache Loaders and Writers
Introduction to Cache Loaders and Writers
Implementing Cache-Through
Cache Event Listeners
Introduction
Registering Event Listeners during runtime
Event Processing Queues
Eviction Advisors
Serializers and Copiers
Overview of Serializers and Copiers
Serializers
Copiers
Thread Pools
Introduction to Thread Pools
Configuring Thread Pools with Code
Configuring Thread Pools with XML
Code Examples
Ehcache XSDs
XSD namespaces and locations
Management and Monitoring with Ehcache
Introduction
Making use of the ManagementRegistry
Capabilities and contexts
Actions
Managing multiple cache managers
Rules for Statistics Calculation
Class Loading
About Class Loading
Handling User Types
Clustered Caches
Introduction
Clustering Concepts
Starting the Terracotta Server
Creating a Cache Manager with Clustering Capabilities
Cache Manager Configuration and Usage of Server Side Resources
Ehcache Cluster Tier Manager Lifecycle
Configuring a Clustered Cache
Creating a Cluster with Multiple Stripes
Fast Restartability
Overview of Fast Restartability
Creating a Restartable Cache Manager
Creating a Restartable Cache
Creating Restartable Resource Pools
Example of a Restartability Scenario
General Notes on Configuring Restartability
Hybrid Caching
Overview of Hybrid Caching
Configuring a Hybrid Cache Manager
Configuring a Hybrid Cache
Example of a Hybrid Scenario
General Notes on Configuring Hybrid
Migrating Code from Ehcache v2
Terracotta Server Administration Guide
Cluster Architecture
Active and Passive Servers
Logical Server States
Clients in a Cluster
Electing an Active Server
Failover
Starting and Stopping the Terracotta Server
Safe Cluster Shutdown and Restart Procedure
Configuration Terms and Concepts
Planning a Configuration
The TerracottaConfiguration File
Config Tool
Overview
Settings
Performing configuration changes
Diagnosing and Repairing Problems
Config Tool Troubleshooting Guide
Parameter Substitution
Configuring the Terracotta Server
System Recommendations for Hybrid Caching
System Recommendations for Fast Restart (FRS)
Failover Tuning
Connection Leasing
Cluster Tool
Importing and Exporting Datasets
Overview
Import-Export Tool
Import-Export API
Licensing
Backup, Restore and Data Migration
Overview of Backup and Restore
Data Directory Structure
Online Backup
Offline Backup
Restore
Data Migration of Ehcache data
Technical Details
Migrating from older Terracotta versions to 10.7
Migrating from 10.7 to a newer 10.7 version
Restarting a Stripe
IPv6 support in Terracotta
SSL / TLS Security Configuration in Terracotta
Security Core Concepts
Cluster Security
TMS Security
LDAP Properties
SSL / TLS Troubleshooting guide
Terracotta Server Migration from BigMemory to Terracotta
Using Command Central to Manage Terracotta
Terracotta in Network Environments with Subnets
Terracotta Management and Monitoring
Getting Started with the Terracotta Management Console
Using the Terracotta Management Console
Using the Ehcache Tab
Using the TCStore Tab
Using the Server Tab
Using the Events Tab
Prometheus Integration
Performance Considerations
Migrating the Terracotta Management Console
Glossary
Welcome to the Terracotta Online Documentation
Glossary