{"id":1418,"date":"2012-01-31T10:08:26","date_gmt":"2012-01-31T15:08:26","guid":{"rendered":"http:\/\/hstore.cs.brown.edu\/?page_id=1418"},"modified":"2012-07-11T10:23:54","modified_gmt":"2012-07-11T14:23:54","slug":"configuration-properties","status":"publish","type":"page","link":"https:\/\/hstore.cs.brown.edu\/documentation\/development\/configuration-properties\/","title":{"rendered":"Adding Configuration Properties"},"content":{"rendered":"<p id=\"top\" \/><div class=\"prevpage\"><B>\u00ab<\/B> <a href=\"https:\/\/hstore.cs.brown.edu\/documentation\/development\/query-planning\/\" title=\"Query Planning &#038; Execution\">Query Planning &#038; Execution<\/a><\/div> <div class=\"nextpage\"><a href=\"https:\/\/hstore.cs.brown.edu\/documentation\/development\/parameter-mappings\/\" title=\"Transaction Parameter Mappings\">Transaction Parameter Mappings<\/a> <B>\u00bb<\/B><\/div><div style=\"clear:both;\"><\/div><\/p>\n<p>The H-Store configuration file is managed at runtime by <a href=\"https:\/\/github.com\/apavlo\/h-store\/blob\/master\/src\/frontend\/edu\/brown\/hstore\/conf\/HStoreConf.java\">HStoreConf<\/a>. This file contains all of the configuration properties that are used when the H-Store system is deployed. These instructions are for how to add new properties to the system. To add a new parameter, one first must decide whether it is a <tt>global<\/tt>, <tt>client<\/tt>, or <tt>site<\/tt> property.<\/p>\n<ul>\n<li><a href=\"\/documentation\/configuration\/properties-file\/global\/\" class=\"property\">global<\/a>: These are the configuration parameters that are global to either the sites or the clients.\n<li><a href=\"\/documentation\/configuration\/properties-file\/client\/\" class=\"property\">client<\/a>: Configuration parameters that affect the execution behavior of clients during a benchmark run.\n<li><a href=\"\/documentation\/configuration\/properties-file\/client\/\" class=\"property\">site<\/a>: Configuration parameters that affect the execution behavior of each <tt>HStoreSite<\/tt>.\n<\/ul>\n<p> In this example, we&#8217;ll assume that we want to add a new boolean <a href=\"\/documentation\/configuration\/properties-file\/client\/\" class=\"property\">site<\/a> parameter called <tt class=\"property\">my_new_parameter<\/tt>. That means in <a href=\"https:\/\/github.com\/apavlo\/h-store\/blob\/master\/src\/frontend\/edu\/brown\/hstore\/conf\/HStoreConf.java\">HStoreConf<\/a>, under the <tt>Site<\/tt> configuration class, we will add in a new data member:<\/p>\n\n<div class=\"wp_syntax\"><table><tr><td class=\"code\"><pre class=\"java\" style=\"font-family:monospace;\">@ConfigProperty<span style=\"color: #009900;\">&#40;<\/span>\n    description<span style=\"color: #339933;\">=<\/span><span style=\"color: #0000ff;\">&quot;Describe what this parameter does.&quot;<\/span>,\n    defaultBoolean<span style=\"color: #339933;\">=<\/span><span style=\"color: #000066; font-weight: bold;\">true<\/span>,\n    experimental<span style=\"color: #339933;\">=<\/span><span style=\"color: #000066; font-weight: bold;\">false<\/span>\n<span style=\"color: #009900;\">&#41;<\/span>\n<span style=\"color: #000000; font-weight: bold;\">public<\/span> <span style=\"color: #000066; font-weight: bold;\">boolean<\/span> my_new_parameter<span style=\"color: #339933;\">;<\/span><\/pre><\/td><\/tr><\/table><\/div>\n\n<p>The <a href=\"https:\/\/github.com\/apavlo\/h-store\/blob\/master\/src\/frontend\/edu\/brown\/hstore\/interfaces\/ConfigProperty.java\">@ConfigProperty<\/a> annotation is used to provide additional information about the new parameter. The <tt>description<\/tt> field is used to provide additional information about what the configuration property is used for. The <tt>experimental<\/tt> flag is warning to other users as to whether this parameter is only used for research experiments and should not be changed without understanding what the affects are first. The <tt>default<\/tt> field defines what the default value of the parameter is if the administrator does not provide one. You must used the proper default field name based on whether the value of configuration parameter is a boolean (<tt>defaultBoolean<\/tt>), an integer (<tt>defaultInt<\/tt>), a long (<tt>defaultLong<\/tt>), a double (<tt>defaultDouble<\/tt>), or a string (<tt>defaultString<\/tt>). If the default value of a string should be null, you can use set <tt>defaultNull<\/tt> field to true.<\/p>\n<p>Once the new property is added and the code compiles successfully, you must execute the following command to update <a href=\"https:\/\/github.com\/apavlo\/h-store\/blob\/master\/build-common.xml\">build-common.xml<\/a>. This file contains all of the properties that can be passed in from the command-line. The <tt class=\"ant-target\">hstore-dist<\/tt> command will automatically pick out the name of the parameter and add it to <tt>build-common.xml<\/tt>.<\/p>\n<pre>ant <tt class=\"ant-target\">compile<\/tt> <tt class=\"ant-target\">hstore-dist<\/tt><\/pre>\n<p>Now you can pass your configuration property from the command-line when you deploy H-Store:<\/p>\n<pre>ant <tt class=\"ant-target\">hstore-benchmark<\/tt> -Dproject=tpcc -Dsite.my_new_parameter=true<\/pre>\n<p><div class=\"prevpage\"><B>\u00ab<\/B> <a href=\"https:\/\/hstore.cs.brown.edu\/documentation\/development\/query-planning\/\" title=\"Query Planning &#038; Execution\">Query Planning &#038; Execution<\/a><\/div> <div class=\"nextpage\"><a href=\"https:\/\/hstore.cs.brown.edu\/documentation\/development\/parameter-mappings\/\" title=\"Transaction Parameter Mappings\">Transaction Parameter Mappings<\/a> <B>\u00bb<\/B><\/div><div style=\"clear:both;\"><\/div><\/p>\n","protected":false},"excerpt":{"rendered":"<p>The H-Store configuration file is managed at runtime by HStoreConf. This file contains all of the configuration properties that are used when the H-Store system is deployed. These instructions are for how to add new properties to the system. To add a new parameter, one first must decide whether it is a global, client, or [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":616,"menu_order":30,"comment_status":"closed","ping_status":"open","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/pages\/1418"}],"collection":[{"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/comments?post=1418"}],"version-history":[{"count":15,"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/pages\/1418\/revisions"}],"predecessor-version":[{"id":1721,"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/pages\/1418\/revisions\/1721"}],"up":[{"embeddable":true,"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/pages\/616"}],"wp:attachment":[{"href":"https:\/\/hstore.cs.brown.edu\/wp-json\/wp\/v2\/media?parent=1418"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}