• Welcome to the BigMemory Go Online Documentation
•  About This Documentation
  • Online Information and Support
  • Data Protection
• BigMemory Go 4.4 Release Notes
•  About BigMemory Go
  •  BigMemory Go Overview
    • What is BigMemory Go?
    • Basic Terms
  •  Topologies
    • Topology Types
  •  Storage Options
    • Storage Tiers
  •  Automatic Resource Control
    • Automatic Resource Control
•  Installation Guide
  • Installing BigMemory Go
  • Configuring BigMemory Go
  • Working with Terracotta License Files
  • Learn More about How BigMemory Go Works
•  Code Samples
  • About the BigMemory Go Code Samples
  • Example: Declarative Configuration
  • Example: Programmatic Configuration
  • Example: Create, Read, Update, Delete
  • Example: Search
  • Example: Automatic Resource Control
  • Example: Using BigMemory Go As a Cache
•  Product Documentation
  •  BigMemory Go Developer Guide
    •  Key Classes and Methods
      • About the Key Classes
      • CacheManager
      • Cache
      • Element
    •  Basic Caching
      • Creating a CacheManager
      • Loading a Configuration
      • Adding and Removing Caches Programmatically
      • Performing Basic Cache Operations
      • Shut down the CacheManager
      • JUnit Tests
    •  Cache Usage Patterns
      • Supported Usage Patterns
      • cache-aside
      • cache-as-sor
      • read-through
      • write-through
      • write-behind
      • Copy Cache
    •  Searching a Cache
      • About Searching
      • Making a Cache Searchable
      • Defining Attributes
      • Creating a Query
      • Obtaining and Organizing Query Results
      • Best Practices for Optimizing Searches
      • Concurrency Considerations
      • Options for Working with Nulls
    •  Searching with BigMemory SQL
      • About BigMemory SQL
      • Using BigMemory SQL
      • Using the QueryManager API
      •  SQL Syntax and Examples
        • SELECT Clause
        • FROM Clause
        • WHERE Clause
        • Data Types
        • Enums
        • Dates
        • GROUP BY Clause
        • ORDER BY Clause
        • ORDER BY and GROUP BY Together
        • LIMIT Clause
        • Additional Syntax
    •  Using Explicit Locking
      • About Explicit Locking
      • Code Sample for Explicit Locking
      • How Locking Works
      • The Locking API
    •  Blocking and Self Populating Caches
      • About Blocking and Self-Populating Caches
      • Blocking Cache
      • SelfPopulatingCache
    •  Transaction Support
      • About Transaction Support
      • Requirements for Transactional Caches
      • Configuring Transactional Cache
      • Working with Global Transactions
      • Failure Recovery
      • Sample Applications
      • Transaction Managers
      • Working with Local Transactions
      • Performance Considerations
      • Potential Timeouts in a Transactional Cache
      • Transactions in Write-Behind and Write-Through Caches
      • Support for Other Transaction Systems
    •  Write-Through and Write-Behind Caches
      • About Write-Through and Write-Behind Caches
      • Using a Combined Read-Through and Write-Behind Cache
      • Write-Behind Sample Application
      • Configuring a Cache Writer
      • CacheWriterFactory Attributes
      • API
      • SPI
      • Monitoring the Size of Write-Behind Queue
      • Handling Exceptions that Occur After a Writer is Called
    •  Cache Loaders
      • About Cache Loaders
      • Declarative Configuration
      • Implementing a CacheLoaderFactory and CacheLoader
      • Programmatic Configuration
    •  Cache Manager Event Listeners
      • About CacheManager Event Listeners
      • Configuring a Cache Manager Event Listener
      • Implementing a CacheManager Event Listener Factory and CacheManager Event Listener
    •  Cache Event Listeners
      • About Cache Event Listeners
      • Configuring a Cache Event Listener
      • Implementing a Cache Event Listener Factory and Cache Event Listener
      • Adding a Listener Programmatically
    •  Cache Exception Handlers
      • About Exception Handlers
      • Declarative Configuration
      • Implementing a Cache Exception Handler Factory and Cache Exception Handler
      • Programmatic Configuration
    •  Cache Decorators
      • About Cache Decorators
      • Built-in Decorators
      •  Creating a Decorator
        • Declarative Creation
        • Programmatic Creation
      • Adding Decorated Caches to a CacheManager
    •  Cache Extensions
      • About Cache Extensions
      • Declarative Configuration
      • Implementing a Cache Extension Factory and Cache Extension
      • Programmatic Configuration
    •  Cache Eviction Algorithms
      • About Cache Eviction Algorithms
      • Built-in Memory Store Eviction Algorithms
      • Plugging in Your own Eviction Algorithm
      • Disk Store Eviction Algorithm
    •  Class Loading
      • About Class Loading
      • Plugin Class Loading
      • Loading of ehcache.xml Resources
    •  Working with Apache Maven
      • About Working with Apache Maven
      • Creating Enterprise Edition Clients
      • Using the tc-maven Plugin
      • Working With Terracotta SNAPSHOT Projects
      • Terracotta Repositories
  •  BigMemory Go Configuration Guide
    •  Configuring BigMemory Go
      • About BigMemory Go Configuration
      • XML Configuration
      • Dynamically Changing Cache Configuration
      • Passing Copies Instead of References
    •  Configuring Storage Tiers
      • About Storage Tiers
      • Configuring Memory Store
      • Configuring Off-Heap Store
      • Off-Heap Configuration Examples
      • Tuning Off-Heap Store Performance
      • Configuring Disk Store
    •  Sizing Storage Tiers
      • The Sizing Attributes
      • Pooling Resources Versus Sizing Individual Data Sets
      • Sizing Examples
      • Pinning and Size Limitations
      • Built-In Sizing Computation and Enforcement
      • Eviction When Using CacheManager-Level Storage
    •  Managing Data Life
      • Configuration Options that Affect Data Life
      • Setting Expiration
      • Pinning Data
      • How Configuration Affects Element Flushing and Eviction
      • Data Freshness and Expiration
    •  Configuring Fast Restart (FRS)
      • About Fast Restart (FRS)
      • System Requirements
      • Data Persistence Implementation
      • Configuration Examples
      • Fast Restart Performance
      • Fast Restart Limitations
    •  System Properties
      • Special System Properties
  •  BigMemory Go Operations Guide
    •  Logging
      • SLFJ Logging
      • Recommended Logging Levels
    •  Shutting Down Ehcache
      • About Shutdown
      • ServletContextListener
      • The Shutdown Hook
      • Dirty Shutdown
  •  Terracotta Management Console User Guide
    •  Getting Started with Terracotta Management Console
      • About the Terracotta Management Console
      •  Installing the Terracotta Management Server
        • Running the Terracotta Management Server with a Different Container
      • Configuring the Terracotta Management Server
      •  Starting and Stopping the Terracotta Management Console
        • Starting the Terracotta Management Console
        • To Stop the Terracotta Management Console
      • Connecting to the Terracotta Management Console
      • Updating the Terracotta Management Server
      • Uninstalling the Terracotta Management Console
    •  Using the Terracotta Management Console
      • Initial Setup
      • The TMC Home Page
      • Connections and Global Settings
      • Dashboards, Tabs, and Management Panels
    •  Using the Application Data Tab
      • About the Application Data Tab
      • Overview Panel
      • Charts Panel
      • Sizing Panel
      • Management Panel
      • Contents Panel
    •  Using the Monitoring Tab
      • About the Monitoring Tab
      • Runtime Statistics
      • Events
      • Versions
    •  Using the Administration Tab
      • About the Administration Tab
      • Configuration
      • Backing Up Cluster Data
      • Changing Cluster Topology
      • Off-line Data
    •  Using the Troubleshooting Tab
      • About the Troubleshooting Tab
      • Understanding Special TSA Modes
      • Generating Thread Dumps
      • Viewing Server Logs
    •  Using the WAN Tab
      • About the WAN Tab
      • Overview Panel for Master Caches
      • Overview Panel for Replica Caches
      • Charts Panel for Master Caches
      • Charts Panel for Replica Caches
      • The WAN Tab Statistics
    •  Setting up Security
      • Available Security Levels
      • No Security
      • Default Security
      • Basic Connection Security
      • Adding SSL
      • Certificate-Based Client Authentication
      • Forcing SSL Connections For TMC Clients
      • Setting up LDAP or Active Directory Authorization
    •  Integrating with Nagios
      • About Integrating with Nagios XI
      • Example of a Shell Script Plugin
    •  Integration with Prometheus
      • Connecting to Prometheus with Security disabled in TMC
      • Connecting to Prometheus with Security enabled in TMC
      • Prometheus Usage Notes
      • Cache Metrics
      • Server Metrics
      • Visualization with Grafana
    •  Troubleshooting
      • Setup Errors
      • Connection Errors
      • Logged SSL Connection Errors
      • Runtime Errors
      • Display Errors
  •  Terracotta REST Developer Guide
    •  Using the Terracotta Managment REST API
      • Overview of the Management Components
      • Connecting to the Management Service REST API
      • REST API Versions
    •  Constructing URIs for HTTP Operations
      • The URI for the Terracotta Management Service
      • Security for REST API usage without TMC
      • Special Resource Locations
    •  Specifications for HTTP Operations
      • Response Headers
      •  Examples of URIs
        • DELETE
        • GET and HEAD
        • OPTIONS
        • PUT
    •  Using Query Parameters in URIs
      • Using Query Parameters in URIs
    •  JSON Schema
      • JSON Schema
    •  REST API for the Terracotta Server Array
      • REST API for TSA
      • Statistics
      • Topology Views
      • Configuration
      • Diagnostics
      • Backups
      • Operator Events
      • Logs
  •  BigMemory Go Integrations
    •  Using BigMemory Go with Hibernate
      • About Using BigMemory Go with Hibernate
      • Downloading and Installing BigMemory Go for Hibernate
      • Building with Maven
      • Configuring BigMemory Go as the Second-Level Cache Provider
      • Enabling Second-Level Cache and Query Cache Settings
      • Configuring Hibernate Entities to use Second-Level Caching
      •  Configuring ehcache.xml Settings
        • Ehcache Settings for Domain Objects
        • Ehcache Settings for Collections
        • Ehcache Settings for Queries
      • The Demo Application and Tutorial
      • Performance Tips
      • Viewing Hibernate Statistics
      • FAQ
    •  Using BigMemory Go with ColdFusion
      • About ColdFusion and BigMemory Go
      • Example Integration
    •  Using BigMemory Go with Spring
      • Using Spring 3.1
      • Spring 2.5 to 3.1
      • Annotations for Spring Project
    •  Using BigMemory Go with JSR107
      • About BigMemory Go Support for JSR107
• Reference Documentation
•  FAQ
  • General Questions
  • Configuration Questions
  • Operations Questions
  • Troubleshooting Questions
• Copyright

Welcome to the BigMemory Go Online Documentation

Copyright