Contents

• Notices

• Preface

• Part 1: Description

  • 1. About Hitachi Elastic Application Data Store

    • 1.1 In-memory data grid for efficient processing of large volumes of data in a manner appropriate to the characteristics of your IT system

    • 1.2 Overview of EADS

      • 1.2.1 Easy data management and simple interface

      • 1.2.2 Managing data in memory

      • 1.2.3 Mass memory areas consisting of multiple servers

    • 1.3 Features of EADS

      • 1.3.1 Ability to achieve high scalability from a small starting point

      • 1.3.2 Data redundancy to achieve a fault-tolerant system with high availability

      • 1.3.3 High-speed data processing for faster response times

      • 1.3.4 Flexible data operations to better match user needs

      • 1.3.5 Management of persistent data using disk areas

    • 1.4 Examples of EADS applications

      • 1.4.1 Using EADS as a write buffer

      • 1.4.2 Using EADS as a read cache

    • 1.5 User tasks and corresponding parts of the manual

  • 2. Architecture

    • 2.1 Configuration of EADS

      • 2.1.1 System configuration

      • 2.1.2 Configuration of processes

    • 2.2 Mechanisms of EADS communication processing

      • 2.2.1 Protocols used for communication

      • 2.2.2 Buffer used for communication

    • 2.3 Areas storing keys and values

      • 2.3.1 Cache types

    • 2.4 Data access

      • 2.4.1 Storing data (using put)

      • 2.4.2 Storing new data (using create)

      • 2.4.3 Updating data (using update)

      • 2.4.4 Replacing data (using replace)

      • 2.4.5 Acquiring data (using get)

      • 2.4.6 Deleting data (remove)

      • 2.4.7 Performing batch operations on a cache

      • 2.4.8 Data access without having to be aware of the locations of individual EADS servers

      • 2.4.9 General procedure for data access

      • 2.4.10 Locking during data access

    • 2.5 Data distribution by consistent hashing

      • 2.5.1 Overview of data distribution

      • 2.5.2 Details about data distribution

      • 2.5.3 Adding EADS servers (scaling out) and distributing data

    • 2.6 Placing data on a specific EADS server (grouping keys)

      • 2.6.1 Grouping keys

      • 2.6.2 Data distribution with grouped keys

    • 2.7 Efficient data processing using user functions

      • 2.7.1 Mechanism of user functions

    • 2.8 Creating redundant copies of data

      • 2.8.1 Overview of creating redundant copies of data

      • 2.8.2 Continuing processing in the event of a failure when redundant copies of data have been created

    • 2.9 Monitoring a cluster

      • 2.9.1 Overview of monitoring a cluster by sending heartbeats

      • 2.9.2 EADS server shutdown decided by the agreement of a specific number of EADS servers

    • 2.10 Cluster information update check by the EADS client

    • 2.11 Cluster and EADS server status transitions

      • 2.11.1 Cluster status transitions

      • 2.11.2 EADS servers' cluster participation status

      • 2.11.3 EADS server status transitions

    • 2.12 Improving throughput by using thread and connection pools

      • 2.12.1 Thread pools

      • 2.12.2 Connection pools

• Part 2: Design and Configuration

  • 3. General Procedure for Designing and Configuring a System

    • 3.1 General procedure for designing and configuring a system

      • 3.1.1 Checking the required resources

      • 3.1.2 Installing and setting up

      • 3.1.3 Designing the environment-dependent parameters

      • 3.1.4 Designing the tuning parameters

  • 4. Checking the Required Resources

    • 4.1 Estimating the required memory

      • 4.1.1 Memory configuration

      • 4.1.2 Estimating the Java heap size

      • 4.1.3 Estimating the explicit heap size

      • 4.1.4 Estimating the size of memory used by an EADS server

    • 4.2 Estimating the required disk capacity

      • 4.2.1 Estimating the disk capacity required for EADS servers

      • 4.2.2 Estimating the disk capacity required for EADS clients

    • 4.3 Estimating the numbers of threads and file descriptors

      • 4.3.1 Estimating the number of threads

      • 4.3.2 Estimating the number of file descriptors

    • 4.4 Estimating the sizes of cache files

      • 4.4.1 Estimating the size and number of cache data files

      • 4.4.2 Estimating the size of a cache index file

  • 5. Installing and Setting Up (EADS Servers)

    • 5.1 Installing an EADS server

      • 5.1.1 Preparations before starting the installation

      • 5.1.2 Installation procedure

      • 5.1.3 Post-installation procedure

    • 5.2 Setting up the EADS server

      • 5.2.1 Creating the management directory

      • 5.2.2 Editing the property files

      • 5.2.3 Distributing application programs

    • 5.3 Testing

      • 5.3.1 Starting the EADS server (creating a cache)

      • 5.3.2 Using commands to manipulate the test data

      • 5.3.3 Terminating the EADS server

    • 5.4 Canceling EADS server setup

    • 5.5 Uninstalling an EADS server

  • 6. Installing and Setting Up (EADS Clients)

    • 6.1 Installing an EADS client

      • 6.1.1 Post-installation procedures

    • 6.2 Setting up an EADS client

      • 6.2.1 Placement of the application programs

      • 6.2.2 Editing the client property file

    • 6.3 Uninstalling an EADS client

  • 7. Designing the Environment-Dependent Parameters (EADS Servers)

    • 7.1 Types of property files (used by EADS servers)

    • 7.2 Format of property files

    • 7.3 Designing the communication-dependent parameters

      • 7.3.1 Specifying the IP address or host name and the port number

      • 7.3.2 Communication-dependent parameters

    • 7.4 Designing the log file-dependent parameters

      • 7.4.1 Types of log files

      • 7.4.2 Specifying the file output destinations

      • 7.4.3 Specifying the file sizes and the numbers of files

      • 7.4.4 Specifying the rotation of statistics files

      • 7.4.5 Log file-dependent parameters

    • 7.5 Designing the cluster configuration-dependent parameters

      • 7.5.1 Specifying the locations of EADS servers

      • 7.5.2 Specifying the data multiplicity

      • 7.5.3 Cluster configuration-dependent parameters

    • 7.6 Designing the backup file-dependent parameters

      • 7.6.1 Specifying the file output destinations

      • 7.6.2 Specifying the number of store data file generations

      • 7.6.3 Backup file-dependent parameters

    • 7.7 Designing the cache operation-dependent parameters

      • 7.7.1 Specifying parameters for each type of cache type

      • 7.7.2 Specifying the types of cache files and their storage locations

      • 7.7.3 Specifying the sizes of cache files

      • 7.7.4 Cache operation-dependent parameters

  • 8. Designing the Environment-Dependent Parameters (EADS Clients)

    • 8.1 Type of property file (used by EADS clients)

    • 8.2 Format of property files

    • 8.3 Designing the communication-dependent parameters

      • 8.3.1 Specifying the connection-target EADS server, the IP address or host name, and the port number

      • 8.3.2 Communication-dependent parameters

    • 8.4 Designing the log file-dependent parameters

      • 8.4.1 Types of log files

      • 8.4.2 Specifying the file output destinations

      • 8.4.3 Specifying the file sizes and the numbers of files

      • 8.4.4 Log file-dependent parameters

  • 9. Designing the Tuning Parameters

    • 9.1 Designing the parameters related to memory and buffers

      • 9.1.1 Specifying the memory sizes

      • 9.1.2 Specifying the buffer size

      • 9.1.3 Parameters related to memory and buffers

    • 9.2 Designing the parameters related to thread pools and connection pools

      • 9.2.1 Setting the maximum number of simultaneous connections

      • 9.2.2 Setting the maximum number of simultaneous threads

      • 9.2.3 Parameters related to thread pools and connection pools

    • 9.3 Designing the timeout-related parameters

      • 9.3.1 Setting the timers for monitoring communication

      • 9.3.2 Setting the timers for monitoring the cluster

      • 9.3.3 Timeout-related parameters

    • 9.4 Designing the command operation-related parameters

      • 9.4.1 Command operation-related parameters

    • 9.5 Designing application program operation-related parameters

      • 9.5.1 Application program operation-related parameters

    • 9.6 Designing the compaction-related parameters

      • 9.6.1 Specifying thresholds for compaction effects

      • 9.6.2 Compaction-related parameters

• Part 3: Operations

  • 10. Normal Operations

    • 10.1 The system operation administrator's tasks

    • 10.2 Starting the EADS servers (and creating caches)

      • 10.2.1 How to start the EADS servers (creating caches in memory)

      • 10.2.2 Starting the EADS servers (creating caches on disk)

      • 10.2.3 Notes about using multiple caches

    • 10.3 Starting the EADS servers (and creating caches by importing data from files)

      • 10.3.1 How to start the EADS servers (creating caches in memory)

      • 10.3.2 How to start the EADS servers (resuming caches on disk)

    • 10.4 Terminating the EADS servers (and discarding data from memory)

      • 10.4.1 How to terminate the EADS servers

    • 10.5 Terminating the EADS servers (after exporting data from memory to files)

      • 10.5.1 How to terminate the EADS servers

    • 10.6 Terminating the EADS servers (terminating caches on disk)

      • 10.6.1 How to terminate the EADS servers

    • 10.7 Checking the cluster and EADS server statuses

    • 10.8 Displaying a list of caches

    • 10.9 Reducing the data usage of cache data files (performing compaction on cache data files)

      • 10.9.1 Performing compaction on cache data files

      • 10.9.2 Stopping compaction processing

  • 11. Maintenance Operations

    • 11.1 Adding EADS servers to a cluster

      • 11.1.1 How to add EADS servers to a cluster without stopping the cluster (scale-out processing)

      • 11.1.2 How to add EADS servers to a cluster after stopping the cluster (using only memory caches)

      • 11.1.3 How to add EADS servers to a cluster after stopping the cluster (using only disk caches)

    • 11.2 Deleting EADS servers from a cluster

      • 11.2.1 How to delete EADS servers from a cluster (using only memory caches)

      • 11.2.2 How to delete EADS servers from a cluster (using disk caches)

    • 11.3 Making the number of keys uniform in all ranges

      • 11.3.1 How to make the number of keys uniform in all ranges

    • 11.4 Changing the properties

      • 11.4.1 How to change the properties

      • 11.4.2 Notes about changing properties

    • 11.5 Adding and deleting caches

      • 11.5.1 How to add and delete memory caches

      • 11.5.2 How to add and delete disk caches and two-way caches

    • 11.6 Making a backup

      • 11.6.1 How to back up data

    • 11.7 Managing store data files

      • 11.7.1 How to check and delete store data files

    • 11.8 Checking the data storage location

    • 11.9 Checking a list of group names

    • 11.10 Checking a list of keys

    • 11.11 Checking whether user functions have been placed correctly on individual EADS servers and whether they can be executed

    • 11.12 Applying EADS server patches while the cluster is running

      • 11.12.1 How to apply EADS server patches

    • 11.13 Obtaining statistics

      • 11.13.1 Statistics storage locations

      • 11.13.2 Statistics (eads_stats.csv)

      • 11.13.3 Cache statistics (eads_cache_stats.csv)

      • 11.13.4 User function statistics (eads_function_stats.csv)

      • 11.13.5 Statistics by range (eads_store_stats.csv)

    • 11.14 Managing available space in the data storage

      • 11.14.1 How to manage available space in the data storage (using only memory caches)

      • 11.14.2 How to manage available space in the data storage (using disk caches)

    • 11.15 Managing cache files

      • 11.15.1 How to check and delete cache files

  • 12. Error Handling Operations

    • 12.1 Preventing failures (error monitoring and detection)

      • 12.1.1 Monitoring messages

      • 12.1.2 Monitoring the EADS server processes

    • 12.2 The system operation administrator's tasks in the event of a failure

      • 12.2.1 If one or more EADS servers are isolated

      • 12.2.2 If the cluster is unavailable (NOT_AVAILABLE) or is partially available (PARTIALLY_AVAILABLE)

      • 12.2.3 If a poor response was reported

    • 12.3 Acquiring error information

      • 12.3.1 Error information needed for root cause investigation

      • 12.3.2 Obtaining statistics

      • 12.3.3 Obtaining thread dumps

  • 13. Investigating the Causes of Failures

    • 13.1 Investigating the cause of a poor response

      • 13.1.1 General investigation procedure

      • 13.1.2 Investigating the cause

  • 14. Command Reference

    • 14.1 Command storage location

    • 14.2 EADS commands

      • 14.2.1 ezstart (starts an EADS server)

      • 14.2.2 ezserver (starts an EADS server in the foreground)

      • 14.2.3 eztool (runs the cluster)

    • 14.3 Subcommands of the eztool command

      • 14.3.1 Locking between commands

      • 14.3.2 close (closes the cluster)

      • 14.3.3 open (opens the cluster)

      • 14.3.4 status (checks the status of the cluster)

      • 14.3.5 listconf (displays a list of most recent parameters)

      • 14.3.6 listcache (displays a list of caches)

      • 14.3.7 listesd (displays a list of store data files)

      • 14.3.8 listgroup (displays a list of group names)

      • 14.3.9 listkey (displays a list of keys)

      • 14.3.10 getposition (displays data storage locations)

      • 14.3.11 storeusage (checks the usage status of ranges and caches)

      • 14.3.12 unlock (unlock)

      • 14.3.13 createcache (creates a cache)

      • 14.3.14 deletecache (deletes a cache)

      • 14.3.15 export (exports data)

      • 14.3.16 import (imports data)

      • 14.3.17 deleteesd (deletes store data files)

      • 14.3.18 put (stores specified data)

      • 14.3.19 get (acquires specified data)

      • 14.3.20 remove (deletes specified data)

      • 14.3.21 removeall (deletes all data)

      • 14.3.22 listfunc (displays which user functions are executable)

      • 14.3.23 execfunc (executes user functions)

      • 14.3.24 listecf (displays a list of information about persistent data)

      • 14.3.25 resume (resumes caches)

      • 14.3.26 importecf (relocates persistent data)

      • 14.3.27 deleteecf (deletes cache files)

      • 14.3.28 compaction (performs compaction on cache data files)

      • 14.3.29 threaddump (outputs a thread dump)

      • 14.3.30 snapshot (collects logs, settings, hardware information, and network information)

      • 14.3.31 stop (terminates the cluster)

      • 14.3.32 forcestop (forcibly terminates an EADS server)

      • 14.3.33 isolate (isolates an EADS server)

    • 14.4 Information displayed as execution results by the eztool command's subcommands

      • 14.4.1 Components of the displayed information

      • 14.4.2 How to specify the display format

      • 14.4.3 How to specify column filters

      • 14.4.4 How to specify row filters

      • 14.4.5 How to specify a condition match

• Part 4: Application Program Development

  • 15. General Procedure for Developing Application Programs

    • 15.1 General procedure for developing application programs

      • 15.1.1 Configure a development environment

      • 15.1.2 Create application programs

      • 15.1.3 Test the application programs

      • 15.1.4 Migrate the created application programs to the execution environment

    • 15.2 Prerequisites for the development of application programs

      • 15.2.1 Programming languages for application programs and EADS clients

      • 15.2.2 Data that is supported as keys, group names, values, cache names, and EADS client names

      • 15.2.3 Reserved package and system property names (applicable to Java)

  • 16. Creating Client Application Programs (in Java)

    • 16.1 Creating source programs (in Java)

      • 16.1.1 General procedure for accessing caches and manipulating data

    • 16.2 Notes about creating client application programs (in Java)

      • 16.2.1 Notes about initializing an EADS client

      • 16.2.2 Notes about starting access to caches

      • 16.2.3 Notes about manipulating data

      • 16.2.4 Notes about terminating access to caches

      • 16.2.5 Notes about terminating use of the EADS client

    • 16.3 Compiling source programs (in Java)

  • 17. Creating User Functions

    • 17.1 Prerequisites for creating user functions

      • 17.1.1 Programming language for user functions

      • 17.1.2 User function execution methods

      • 17.1.3 Java class loaders used by EADS servers

      • 17.1.4 General procedure for creating user functions

    • 17.2 Creating a source program (user function)

      • 17.2.1 Flow of a user function

    • 17.3 Notes about creating user functions

      • 17.3.1 Notes about jar file names

      • 17.3.2 Notes about package names

      • 17.3.3 Notes about implementing user functions

      • 17.3.4 How to acquire a list of keys efficiently

    • 17.4 Creating a function property file (optional)

    • 17.5 Compiling source programs (user functions)

      • 17.5.1 How to compile user functions

    • 17.6 Packaging the user functions

      • 17.6.1 How to package user functions

    • 17.7 Deploying user functions

      • 17.7.1 How to deploy user functions

    • 17.8 Executing user functions

      • 17.8.1 Call a user function

      • 17.8.2 Output information to the user logs

      • 17.8.3 Notes about running user functions

    • 17.9 Distributing the directory to the execution environment

  • 18. Application Programming Interface Reference (Java)

    • 18.1 Classes provided by the Java client libraries

      • 18.1.1 Cache class

      • 18.1.2 CacheManager class

      • 18.1.3 Node class

      • 18.1.4 FailureOperationInfo class

      • 18.1.5 CacheException class

      • 18.1.6 InitializeException class

      • 18.1.7 InternalClientException class

      • 18.1.8 InternalServerException class

      • 18.1.9 ServerCommunicationException class

      • 18.1.10 UserOperationException class

      • 18.1.11 BatchOperationException class

      • 18.1.12 AllFailureException class

      • 18.1.13 PartFailureException class

    • 18.2 API interfaces supported in user functions

      • 18.2.1 Function interface

      • 18.2.2 FunctionContext interface

      • 18.2.3 InitConfig interface

      • 18.2.4 ClientInfo interface

      • 18.2.5 ServerInfo interface

      • 18.2.6 ClusterInfo interface

      • 18.2.7 CacheInfo interface

      • 18.2.8 Store interface

      • 18.2.9 Group interface

      • 18.2.10 Key interface

      • 18.2.11 Value interface

      • 18.2.12 UserLogger interface

      • 18.2.13 EADsStoreException class

      • 18.2.14 InternalServerException class

      • 18.2.15 UserOperationException class

      • 18.2.16 Enumeration CacheType

  • 19. Creating a Client Application Program (in C)

    • 19.1 Creating a source program (in C)

      • 19.1.1 Flow of cache access and data operations

    • 19.2 Notes on creating client application programs (in C)

      • 19.2.1 Notes on initializing EADS clients

      • 19.2.2 Notes on starting access to the cache

      • 19.2.3 Notes on manipulating data

      • 19.2.4 Notes on stopping access to the cache

      • 19.2.5 Notes on terminating the EADS client

    • 19.3 Compiling the source program (in C)

  • 20. API Reference (C)

    • 20.1 Functions provided by the C client library

      • 20.1.1 ead_init_client() (initializes the EADS client)

      • 20.1.2 ead_init_client_n() (initializes the EADS client)

      • 20.1.3 ead_start_cache() (starts access to the cache)

      • 20.1.4 ead_stop_cache() (stops access to the cache)

      • 20.1.5 ead_get_cache_name() (acquires cache names)

      • 20.1.6 ead_terminate_client() (terminates the EADS client)

      • 20.1.7 ead_put() (store a key and value)

      • 20.1.8 ead_put_array_value() (concatenates and stores multiple values)

      • 20.1.9 ead_put_all() (stores keys and values by using a batch operation)

      • 20.1.10 ead_create() (stores a new key and value)

      • 20.1.11 ead_update() (updates a value)

      • 20.1.12 ead_replace() (replaces a value)

      • 20.1.13 ead_get() (retrieves a value)

      • 20.1.14 ead_get_all() (acquires values by using a batch operation)

      • 20.1.15 ead_get_group() (acquires values by using a batch operation with group specification)

      • 20.1.16 ead_remove() (deletes a value)

      • 20.1.17 ead_remove_all() (deletes values by using a batch operation)

      • 20.1.18 ead_remove_group() (deletes values by using a batch operation with group specification)

      • 20.1.19 ead_remove_node() (deletes values by using a batch operation with EADS server specification)

      • 20.1.20 ead_get_group_names() (acquires a list of group names in the highest hierarchy)

      • 20.1.21 ead_get_group_keys() (acquires a list of keys with group specification)

      • 20.1.22 ead_get_node_keys() (acquires a list of keys with EADS server specification)

      • 20.1.23 ead_get_group_count() (acquires the number of groups in the highest hierarchy)

      • 20.1.24 ead_get_group_key_count() (acquires the number of keys with group specification)

      • 20.1.25 ead_get_node_key_count() (acquires the number of keys with EADS server specification)

      • 20.1.26 ead_get_group_first_key() (acquires the first key with group specification)

      • 20.1.27 ead_get_node_first_key() (acquires the first key with EADS server specification)

      • 20.1.28 ead_get_group_next_key() (acquires the next key with group specification)

      • 20.1.29 ead_get_node_next_key() (acquires the next key with EADS server specification)

      • 20.1.30 ead_execute_function() (executes a user function with key specification or group specification)

      • 20.1.31 ead_execute_function_rt() (executes a user function with key specification or group specification and reception timeout specification)

      • 20.1.32 ead_execute_node_function() (executes a user function with an EADS server specified)

      • 20.1.33 ead_execute_node_function_rt() (executes a user function with EADS server and reception timeout specification)

      • 20.1.34 ead_get_nodelist() (acquires information about the connection-target EADS servers)

      • 20.1.35 [Deprecated] ead_get_node() (acquires information about the original source EADS server from which a specified key was copied)

      • 20.1.36 ead_get_slave_nodelist() (acquires information about the original target EADS server for data)

      • 20.1.37 ead_get_current_master_node() (acquires information about the current source EADS server)

      • 20.1.38 ead_get_original_master_node() (acquires information about the original source EADS server)

      • 20.1.39 ead_value_element structure (value information)

      • 20.1.40 ead_key_value_pair structure (key-value pairs)

      • 20.1.41 ead_keys structure (multiple keys)

      • 20.1.42 ead_group_names structure (multiple group names)

      • 20.1.43 ead_put_all_results structure (execution results of ead_put_all())

      • 20.1.44 ead_get_all_results structure (execution results of ead_get_all())

      • 20.1.45 ead_get_group_results structure (execution results of ead_get_group())

      • 20.1.46 ead_remove_all_results structure (execution results of ead_remove_all())

      • 20.1.47 ead_failure_operation_info structure (information about the failed operation during batch operation)

      • 20.1.48 ead_object structure (object used in a user function)

      • 20.1.49 ead_nodelist structure (EADS server information)

      • 20.1.50 ead_node structure (object used in a user function with an EADS server specified)

      • 20.1.51 ead_address structure (EADS server address information)

    • 20.2 Error codes in the client library (C)

• Part 5: Useful Lists and Messages

  • 21. Useful Lists

    • 21.1 List of minimum and maximum values

  • 22. Messages

    • 22.1 Message output format

    • 22.2 KDEA00001 to KDEA01999

    • 22.3 KDEA02000 to KDEA02999

    • 22.4 KDEA03000 to KDEA03999

    • 22.5 KDEA04000 to KDEA05999

    • 22.6 KDEA06000 to KDEA07999

    • 22.7 KDEA08000 to KDEA09999

    • 22.8 KDEA10000 to KDEA11999

• Appendix

  • A. Glossary

• Index

To Page Top