[[Dashboard | << Back to Dashboard ]]

{| align="right"
| __TOC__
|}

= Exploring the ClusterStorage Plugin =


== Overview ==
Cluster Storage plugin. It provides the user with a mechanism for permanent data storage using the Cluster scope. This plugin creates a special variable in cluster scope that correctly identifies the coldbox app.

<div class="mynotes">
'''Important''' : This plugin only works under [http://www.getrailo.org Railo CFML Engine] and its ''cluster'' scope
</div>


== setVar ==
Set a new permanent variable.

=== Returns ===
* This function returns ''void''


=== Arguments ===

{| cellpadding="5", class="tablelisting"
! '''Key''' !! '''Type'''  !! '''Required''' !! '''Default''' !! '''Description''' 
|-
| name || string || Yes || --- || The name of the variable.
|-
| value || any || Yes || --- || The value to set in the variable.
|}

=== Examples ===


<source lang="coldfusion">
// Prepare data, can be simple or complex
userData = {
  name = "Luis Majano",
  created = now(),
  nicknames = ["Captain Awesome", "Pio"],
  awesomeLevel = "high"
};
getPlugin("ClusterStorage").setVar("userData", userData);
</source>

== getVar ==
Get a new permanent variable. If the variable does not exist. The method returns blank unless using the default return argument.

=== Returns ===
* This function returns ''any''


=== Arguments ===

{| cellpadding="5", class="tablelisting"
! '''Key''' !! '''Type'''  !! '''Required''' !! '''Default''' !! '''Description''' 
|-
| name || string || Yes || --- || The variable name to retrieve.
|-
| default || any || No ||  || The default value to set. If not used, a blank is returned.
|}

=== Examples ===


<source lang="coldfusion">
// No default
var userData = getPlugin("ClusterStorage").getVar("userData");

// With Default
var data= getPlugin("ClusterStorage").getVar("userData", structNew() );

</source>


== removeStorage ==
remove the entire storage from scope

=== Returns ===
* This function returns ''void''


=== Examples ===


<source lang="coldfusion">
// Remove the entire cluster storage
getPlugin("ClusterStorage").removeStorage();
</source>


== exists ==
Checks wether the permanent variable exists.

=== Returns ===
* This function returns ''boolean''


=== Arguments ===

{| cellpadding="5", class="tablelisting"
! '''Key''' !! '''Type'''  !! '''Required''' !! '''Default''' !! '''Description''' 
|-
| name || string || Yes || --- || The variable name to retrieve.
|}

=== Examples ===

<source lang="coldfusion">
if ( getPlugin("ClusterStorage").exists("userData") ){
  // use the data
}
</source>

== clearAll ==
Clear the entire coldbox cluster storage

=== Returns ===
* This function returns ''void''


=== Examples ===

<source lang="coldfusion">
getPlugin("ClusterStorage").clearAll();
</source>


== deleteVar ==
Tries to delete a permanent cluster variable. Returns True if deleted.

=== Returns ===
* This function returns ''boolean''


=== Arguments ===

{| cellpadding="5", class="tablelisting"
! '''Key''' !! '''Type'''  !! '''Required''' !! '''Default''' !! '''Description''' 
|-
| name || string || Yes || --- || The variable name to retrieve.
|}

=== Examples ===

<source lang="coldfusion">
getPlugin("ClusterStorage").deleteVar("userData");
</source>

== getStorage ==
Get the entire storage scope structure

=== Returns ===
* This function returns ''struct''


=== Examples ===

<source lang="coldfusion">
var clusterStore = getPlugin("ClusterStorage").getStorage();
</source>