Welcome to the Terracotta Online Documentation
About This Documentation
Online Information and Support
Data Protection
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
Performing the Native Installation Procedure
Configuring Your Environment
Evaluation Licenses
System Requirements
Planning a Successful Deployment
TCStore API Developer Guide
Reference
Concepts
Data Model
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
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
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
Clients in a Cluster
Electing an Active Server
Failover
Starting and Stopping the Terracotta Server
Safe Cluster Shutdown and Restart Procedure
The Terracotta Configuration File
Configuring the Terracotta Server
System Recommendations for Hybrid Caching
System Recommendations for Fast Restart (FRS)
Failover Tuning
Connection Leasing
Cluster Tool
Licensing
Backup, Restore and Data Migration
Overview
Data Directory Structure
Online Backup
Offline Backup
Restore
Data Migration of Ehcache data
Technical Details
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 Terracotta BigMemory Max v4 to Terracotta v10
Using Command Central to Manage Terracotta
How to run your clients with a Kubernetes-managed Terracotta cluster
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
Legal
Copyright
Welcome to the Terracotta Online Documentation
Copyright
co-welcome_to_terracotta_db
co-about_this_guide
re-online_information
to-data_protection
to-title_about_terracotta_db
co-about_tcdb
to-about_ehcache_api
co-over_what_is_ehcache
co-cache_basic_terms
co-basics_freshness_expiration
co-store_storage_tiers
co-top_topology_types
to-over_sto_overview
co-concept_sto
co-apiuse_sto
co-advanced_sto
co-faq_sto
to-over_srv_overview
to-over_tmc_overview
co-javadocs_external
to-title_tcdb_installation_guide
co-ins_installation_overview
co-ins_install_sag_installer
co-ins_overview_installation_procedure
co-ins_configuring_your_environment
co-ins_working_with_license_files
co-system_requirements
co-ins_planning_deployment
to-title_sto_developer_guide
to-title_tcstore_reference
to-title_concepts
co-data_model
to-title_configuration_and_lifecycle_operations
co-lifecycle
co-clustered_datasetmanager_using_xml
to-title_operations
co-clustered_reconnection
co-crud
co-streams
co-asynchronous_api
co-functional_dsl
co-indexes
to-title_tcstore_usage
co-stream_optimizations
co-sto_failover_tuning
co-sto_connection_pooling
to-title_tql
to-title_tql_reference
co-tql_concepts
co-tql_operations
to-title_tql_usage_and_best_practice
co-tql_application_scenarios
co-tql_interplay_native_stream_api
co-tql_performance_considerations
to-header_transaction_extension
co-transaction_overview
co-transaction_controller
co-transaction_execution
co-transaction_executionbuilder
co-transaction_operation_behavior
co-transaction_stream_operations
co-transactions_best_practices
to-title_cec_developer_guide
to-codebasics_basic_caching
co-codebasics_primary_classes
co-codebasics_managing_and_creation
to-title_java_configuration
co-codebasics_using_java
co-codebasics_tiers
co-codebasics_cachemanager_clustering
co-codebasics_data_freshness
to-title_xml_configuration
co-codebasics_xml_config
co-codebasics_xml_schema
co-codebasics_xml_property_replacement
co-codebasics_xml_prg
to-title_jsr107_provider
co-jsr107_jcache_overview
co-jsr107_ehcache_as_jcache_provider
co-jsr107_getting_started
co-jsr107_ehcache_configuration_integration
co-jsr107_default_behavior
to-title_user_managed_caches
co-overview_of_user_managed_caches
co-api_extensions
co-code_examples_for_user_managed_caches
co-pattrn_cache_usage_patterns
to-title_expiration_and_data_freshness
co-data_freshness
co-expiry
to-title_xa_transactional_caches
co-xa_what_is_supported
co-xa_configuring_in_java
co-xa_configuring_with_xml
co-tiering_options
to-title_cache_writers
co-writers_introduction
co-writers_cache-through
to-title_listeners
co-listeners_introduction
co-listeners_registering
co-listeners_queues
co-evict_overview
to-title_serializers_and_copiers
co-serial_overview
co-serial_serializers
co-serial_copiers
to-title_thread_pools
co-pools_overview
co-thread_pools_configuring_using_code
co-thread_pools_configuring_using_xml
co-ehcache_code_examples
to-title_ehcache_xsds
co-xsd_namespaces_and_locations
to-title_management_and_monitoring
co-mm_introduction
co-mm_making_use_of_ManagementRegistry
co-mm_capabilities_and_contexts
co-mm_actions
co-mm_managing_multiple_cache_managers
co-mm_rules_for_statistics_calculation
to-class_loading
co-class_about_class_loading
co-class_loading_configuring
to-title_clustered_caches
co-cluster_introduction
co-cluster_concepts
co-cluster_starting_the_terracotta_server
co-cluster_creating_cache_manager_for_clustering
co-cluster_cache_manager_configuration
co-cluster_tier_manager_lifecycle
co-cluster_configuring
co-cluster_creating_cluster_with_multiple_stripes
to-title_fast_restartability
co-overview_of_fast_restartability
co-frs_restartable_cache_manager
co-frs_creating_a_restartable_cache
co-frs_creating_restartable_resource_pools
co-frs_example_of_restartability_scenario
co-frs_general_notes
to-title_hybrid_caching
co-hybrid_overview
co-hybrid_configuring_a_cache_manager
co-hybrid_configuring_a_cache
co-hybrid_example_scenario
co-hybrid_general_notes
co-migrating_code_from_ehcache_v2
to-title_srv_administration_guide
co-srv_cluster_architecture
co-srv_active_and_passive_servers
co-srv_clients_in_a_cluster
co-srv_electing_an_active_server
co-srv_failover
co-srv_starting_the_server
co-srv_safe_cluster_shutdown
co-srv_configuration_file
co-srv_configuring_terracotta_server
co-srv_sys_rec_hybrid_caching
co-srv_sys_rec_fast_restart
co-srv_failover_tuning
co-srv_connection_leasing
co-srv_cluster_tool
co-srv_licensing
to-title_backup_restore_and_migrate
co-srv_backup_restore_migrate
co-srv_restarting_a_stripe
co-ipv6_support
co-srv_ssl_security
co-srv_security_core_concepts
co-srv_cluster_security
co-srv_tms_security
co-srv_ldap_properties
co-srv_ssl_troubleshooting
co-general_procedure
co-using_command_central
co-srv_run_clients_with_kubernetes_managed_cluster
to-title_tmc_guide
co-about_tmc
co-using_tmc
co-using_the_ehcache_tab
co-using_the_tcstore_tab
co-using_the_server_tab
co-using_the_events_tab
co-prometheus-integration
co-performance_considerations
co-migrating_the_tmc
to-online-copyright-page