Data Grid Command Line Interface

Procedure

1. Open a terminal in $RHDG_HOME.
2. Create and modify Data Grid users with the user command.

Procedure

1. Open a terminal in $RHDG_HOME.

2. Start the CLI.

   • Linux:

     $ bin/cli.sh

     Copy to Clipboard Toggle word wrap

   • Microsoft Windows:

     $ bin\cli.bat

     Copy to Clipboard Toggle word wrap

3. Run the connect command and enter your username and password when prompted.

   • Data Grid Server on the default port of 11222:

     [disconnected]> connect

     Copy to Clipboard Toggle word wrap

   • Data Grid Server with a port offset of 100:

     [disconnected]> connect 127.0.0.1:11322

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Shut down Data Grid Server in one of the following ways:

   • Stop all nodes in a cluster with the shutdown cluster command, for example:

     [//containers/default]> shutdown cluster

     Copy to Clipboard Toggle word wrap

     This command saves cluster state to the data folder for each node in the cluster. If you use a cache store, the shutdown cluster command also persists all data in the cache.

   • Stop individual server instances with the shutdown server command and the server hostname, for example:

     [//containers/default]> shutdown server <my_server01>

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Add cache definitions with the create cache command.

   • Add a cache definition from an XML or JSON file with the --file option.

     [//containers/default]> create cache --file=configuration.xml mycache

     Copy to Clipboard Toggle word wrap

   • Add a cache definition from a template with the --template option.

     [//containers/default]> create cache --template=org.infinispan.DIST_SYNC mycache

     Copy to Clipboard Toggle word wrap
     Tip

     Press the tab key after the --template= argument to list available cache templates.

3. Verify the cache exists with the ls command.

   [//containers/default]> ls caches
   mycache

   Copy to Clipboard Toggle word wrap

4. Retrieve the cache configuration with the describe command.

   [//containers/default]> describe caches/mycache

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Add entries into your cache as follows:

   • Use the put command from the context of a cache:

     [//containers/default/caches/mycache]> put hello world

     Copy to Clipboard Toggle word wrap

   • Use the --cache= with the put command:

     [//containers/default]> put --cache=mycache hello world

     Copy to Clipboard Toggle word wrap

3. Use the get command to verify entries.

   [//containers/default/caches/mycache]> get hello
   world

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Do one of the following:

   • Delete all entries with the clearcache command.

     [//containers/default]> clearcache mycache

     Copy to Clipboard Toggle word wrap

   • Remove specific entries with the remove command.

     [//containers/default]> remove --cache=mycache hello

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Remove caches with the drop command.

   [//containers/default]> drop cache mycache

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a file that contains a set of operations.

   For example, create a file named batch that creates a cache named mybatch, adds two entries to the cache, and disconnects from the CLI.

   $ cat > batch<<EOF
   create cache --template=org.infinispan.DIST_SYNC mybatch
   put --cache=mybatch hello world
   put --cache=mybatch hola mundo
   disconnect
   EOF

   Copy to Clipboard Toggle word wrap

2. Run the CLI and specify the file as input.

   $ bin/cli.sh -c localhost:11222 -f batch

   Copy to Clipboard Toggle word wrap

3. Create a new Data Grid CLI connection and verify mybatch.

   [//containers/default]> ls caches
   ___protobuf_metadata
   mybatch
   [//containers/default]> ls caches/mybatch
   hola
   hello
   [//containers/default]> disconnect
   [disconnected]>

   Copy to Clipboard Toggle word wrap

Procedure

1. Start the Data Grid CLI in interactive mode.

   $ bin/cli.sh -c localhost:11222 -f -

   Copy to Clipboard Toggle word wrap
   Note

   If you do not use the -c flag, you must run the connect command.

   $ bin/cli.sh -f -
   connect

   Copy to Clipboard Toggle word wrap

2. Run batch operations, for example:

   create cache --template=org.infinispan.DIST_SYNC mybatch
   put --cache=mybatch hello world
   put --cache=mybatch hola mundo
   disconnect
   quit

   Copy to Clipboard Toggle word wrap

Procedure

1. Optionally set a custom path to the Data Grid CLI storage directory in one of the following ways:

   • Using the cli.dir system property:

     $ bin/cli.sh -Dcli.dir=/path/to/cli/storage ...

     Copy to Clipboard Toggle word wrap

   • Using the ISPN_CLI_DIR environment variable:

     export ISPN_CLI_DIR=/path/to/cli/storage
     $ bin/cli.sh ...

     Copy to Clipboard Toggle word wrap
2. Set values for configuration properties with the config set command.

3. Verify configuration properties with the config get command.

   Tip

   Run help config to review available configuration properties and get example usage.

Procedure

1. Create aliases with the alias <alias>=<command> command.

   For example, set q as an alias for the quit command:

   [//containers/default]> alias q=quit

   Copy to Clipboard Toggle word wrap

2. Run the alias command to check the defined aliases.

   [//containers/default]> alias
   alias q='quit'

   Copy to Clipboard Toggle word wrap

3. Delete aliases with the unalias command, for example:

   [//containers/default]> unalias q

   Copy to Clipboard Toggle word wrap

Procedure

1. Specify the location of the server key store, as in the following example:

   $ bin/cli.sh config set truststore /home/user/my-trust-store.jks

   Copy to Clipboard Toggle word wrap

2. Define the key store password, if necessary, as follows:

   $ bin/cli.sh config set truststore-password secret

   Copy to Clipboard Toggle word wrap

3. Verify your CLI configuration.

   $ bin/cli.sh config get truststore
   truststore=/home/user/my-trust-store.jks
   
   $ bin/cli.sh config get truststore-password
   truststore-password=secret

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Run the create counter command with the appropriate arguments.

   1. Create my-weak-counter.

      [//containers/default]> create counter --concurrency-level=1 --initial-value=5 --storage=PERSISTENT --type=weak my-weak-counter

      Copy to Clipboard Toggle word wrap

   2. Create my-strong-counter.

      [//containers/default]> create counter --initial-value=3 --storage=PERSISTENT --type=strong my-strong-counter

      Copy to Clipboard Toggle word wrap

3. List available counters.

   [//containers/default]> ls counters
   my-strong-counter
   my-weak-counter

   Copy to Clipboard Toggle word wrap

4. Verify counter configurations.

   1. Describe my-weak-counter.

      [//containers/default]> describe counters/my-weak-counter
      
      {
          "weak-counter":{
              "initial-value":5,
              "storage":"PERSISTENT",
              "concurrency-level":1
          }
      }

      Copy to Clipboard Toggle word wrap

   2. Describe my-strong-counter.

      [//containers/default]> describe counters/my-strong-counter
      
      {
          "strong-counter":{
              "initial-value":3,
              "storage":"PERSISTENT",
              "upper-bound":5
          }
      }

      Copy to Clipboard Toggle word wrap

Procedure

1. Select a counter.

   [//containers/default]> counter my-weak-counter

   Copy to Clipboard Toggle word wrap

2. List the current count.

   [//containers/default/counters/my-weak-counter]> ls
   5

   Copy to Clipboard Toggle word wrap

3. Increment the counter value by 2.

   [//containers/default/counters/my-weak-counter]> add --delta=2

   Copy to Clipboard Toggle word wrap

4. Decrement the counter value by -4.

   [//containers/default/counters/my-weak-counter]> add --delta=-4

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a Data Grid configuration file that adds a distributed cache named qcache and configures the media type, for example:

   <infinispan>
      <cache-container>
         <distributed-cache name="qcache">
            <encoding>
               <key media-type="application/x-protostream"/>
               <value media-type="application/x-protostream"/>
            </encoding>
         </distributed-cache>
      </cache-container>
   </infinispan>

   Copy to Clipboard Toggle word wrap

2. Create qcache from pcache.xml with the --file= option.

   [//containers/default]> create cache --file=pcache.xml pcache

   Copy to Clipboard Toggle word wrap

3. Verify pcache.

   [//containers/default]> ls caches
   pcache
   ___protobuf_metadata
   [//containers/default]> describe caches/pcache
   {
     "distributed-cache" : {
       "mode" : "SYNC",
       "encoding" : {
         "key" : {
           "media-type" : "application/x-protostream"
         },
         "value" : {
           "media-type" : "application/x-protostream"
         }
       },
       "transaction" : {
         "mode" : "NONE"
       }
     }
   }

   Copy to Clipboard Toggle word wrap

4. Add an entry to pcache and check the encoding.

   [//containers/default]> put --cache=pcache good morning
   [//containers/default]> cd caches/pcache
   [//containers/default/caches/pcache]> get good
   {
     "_type" : "string",
     "_value" : "morning"
   }

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a schema file named person.proto with the following messages:

   package org.infinispan.rest.search.entity;
   
   message Address {
       required string street = 1;
       required string postCode = 2;
   }
   
   message PhoneNumber {
       required string number = 1;
   }
   
   message Person {
       optional int32 id = 1;
       required string name = 2;
       required string surname = 3;
       optional Address address = 4;
       repeated PhoneNumber phoneNumbers = 5;
       optional uint32 age = 6;
       enum Gender {
           MALE = 0;
           FEMALE = 1;
       }
   
       optional Gender gender = 7;
   }

   Copy to Clipboard Toggle word wrap

2. Register person.proto.

   [//containers/default]> schema --upload=person.proto person.proto

   Copy to Clipboard Toggle word wrap

3. Verify person.proto.

   [//containers/default]> cd caches/___protobuf_metadata
   [//containers/default/caches/___protobuf_metadata]> ls
   person.proto
   [//containers/default/caches/___protobuf_metadata]> get person.proto

   Copy to Clipboard Toggle word wrap

Procedure

1. Navigate to the pcache cache.

   [//containers/default/caches]> cd pcache

   Copy to Clipboard Toggle word wrap

2. Add each JSON document as an entry to the cache, for example:

   [//containers/default/caches/pcache]> put --encoding=application/json --file=jessicajones.json jessicajones
   [//containers/default/caches/pcache]> put --encoding=application/json --file=matthewmurdock.json matthewmurdock
   [//containers/default/caches/pcache]> put --encoding=application/json --file=lukecage.json lukecage

   Copy to Clipboard Toggle word wrap

3. Verify that the entries exist.

   [//containers/default/caches/pcache]> ls
   lukecage
   matthewmurdock
   jessicajones

   Copy to Clipboard Toggle word wrap

4. Query the cache to return entries from the Protobuf Person entity where the gender datatype is MALE.

   [//containers/default/caches/pcache]> query "from org.infinispan.rest.search.entity.Person p where p.gender = 'MALE'"
   {
     "total_results" : 2,
     "hits" : [ {
       "hit" : {
         "_type" : "org.infinispan.rest.search.entity.Person",
         "id" : 2,
         "name" : "Luke",
         "surname" : "Cage",
         "gender" : "MALE",
         "address" : {
           "street" : "38th St",
           "postCode" : "NY 11221"
         },
         "phoneNumbers" : [ {
           "number" : "4444"
         }, {
           "number" : "5555"
         } ]
       }
     }, {
       "hit" : {
         "_type" : "org.infinispan.rest.search.entity.Person",
         "id" : 3,
         "name" : "Matthew",
         "surname" : "Murdock",
         "gender" : "MALE",
         "address" : {
           "street" : "57th St",
           "postCode" : "NY 10019"
         }
       }
     } ]
   }

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Check if backup locations are online or offline with the site status command:

   //containers/default]> site status --cache=cacheName --site=NYC

   Copy to Clipboard Toggle word wrap
   Note

   --site is an optional argument. If not set, the CLI returns all backup locations.

3. Manage backup locations as follows:

   • Bring backup locations online with the bring-online command:

     //containers/default]> site bring-online --cache=customers --site=NYC

     Copy to Clipboard Toggle word wrap

   • Take backup locations offline with the take-offline command:

     //containers/default]> site take-offline --cache=customers --site=NYC

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Use the site command to push state transfer, as in the following example:

   //containers/default]> site push-site-state --cache=cacheName --site=NYC

   Copy to Clipboard Toggle word wrap