doc/MCollective/DDL/DataDDL.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::DDL::DataDDL</title>
   9
  10         <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../../lib/mcollective/ddl/dataddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/ddl/dataddl.rb">lib/mcollective/ddl/dataddl.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link">Base</p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000286">#dataquery</a></li>
  63
  64                                         <li><a href="#M000289">#dataquery_interface</a></li>
  65
  66                                         <li><a href="#M000287">#input</a></li>
  67
  68                                 </ul>
  69                         </div>
  70
  71
  72                         <!-- Included Modules -->
  73
  74                 </div>
  75
  76                 <div id="project-metadata">
  77
  78
  79                         <div id="fileindex-section" class="section project-section">
  80                                 <h3 class="section-header">Files</h3>
  81                                 <ul>
  82
  83                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
  84
  85                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
  86
  87                                         <li class="file"><a href="../../README.html">README</a></li>
  88
  89                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
  90
  91                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  92
  93                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
  94
  95                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  96
  97                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  98
  99                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
 100
 101                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 104
 105                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 106
 107                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 108
 109                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 110
 111                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 112
 113                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 114
 115                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 116
 117                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 118
 119                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 120
 121                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
 122
 123                                 </ul>
 124                         </div>
 125
 126
 127                         <div id="classindex-section" class="section project-section">
 128                                 <h3 class="section-header">Class Index
 129                                         <span class="search-toggle"><img src="../../images/find.png"
 130                                                 height="16" width="16" alt="[+]"
 131                                                 title="show/hide quicksearch" /></span></h3>
 132                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 133                                 <fieldset>
 134                                         <legend>Quicksearch</legend>
 135                                         <input type="text" name="quicksearch" value=""
 136                                                 class="quicksearch-field" />
 137                                 </fieldset>
 138                                 </form>
 139
 140                                 <ul class="link-list">
 141
 142                                         <li><a href="../../MCollective.html">MCollective</a></li>
 143
 144                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
 145
 146                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
 147
 148                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 149
 150                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 151
 152                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 153
 154                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 155
 156                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 157
 158                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 159
 160                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
 161
 162                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
 163
 164                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
 165
 166                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
 167
 168                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 169
 170                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
 171
 172                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
 173
 174                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 175
 176                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
 177
 178                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 179
 180                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 181
 182                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 183
 184                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 185
 186                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 187
 188                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 189
 190                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
 191
 192                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 193
 194                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 195
 196                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 197
 198                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
 199
 200                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 201
 202                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
 203
 204                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 205
 206                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 207
 208                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 209
 210                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 211
 212                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
 213
 214                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
 215
 216                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 217
 218                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 219
 220                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 221
 222                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 223
 224                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 225
 226                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 227
 228                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 229
 230                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
 231
 232                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 233
 234                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 235
 236                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 237
 238                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 239
 240                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 241
 242                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 243
 244                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 245
 246                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 247
 248                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 249
 250                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
 251
 252                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 253
 254                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 255
 256                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 257
 258                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 259
 260                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 261
 262                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 263
 264                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 265
 266                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 267
 268                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 269
 270                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 271
 272                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 273
 274                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 275
 276                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
 277
 278                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 279
 280                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
 281
 282                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 283
 284                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
 285
 286                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
 287
 288                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 289
 290                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 291
 292                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
 293
 294                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 295
 296                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 297
 298                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 299
 300                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 301
 302                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
 303
 304                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
 305
 306                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 307
 308                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 309
 310                                         <li><a href="../../Array.html">Array</a></li>
 311
 312                                         <li><a href="../../Dir.html">Dir</a></li>
 313
 314                                         <li><a href="../../Object.html">Object</a></li>
 315
 316                                         <li><a href="../../String.html">String</a></li>
 317
 318                                         <li><a href="../../Symbol.html">Symbol</a></li>
 319
 320                                 </ul>
 321                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 322                         </div>
 323
 324
 325                 </div>
 326         </div>
 327
 328         <div id="documentation">
 329                 <h1 class="class">MCollective::DDL::DataDDL</h1>
 330
 331                 <div id="description">
 332                         <p>
 333 A <a href="../DDL.html">DDL</a> file for the data query plugins.
 334 </p>
 335 <p>
 336 Query plugins can today take only one input by convention in the <a
 337 href="../DDL.html">DDL</a> that is called :query, otherwise the input is
 338 identical to the standard input.
 339 </p>
 340 <p>
 341 metadata :name => &#8220;Agent&#8221;,
 342 </p>
 343 <pre>
 344             :description =&gt; &quot;Meta data about installed MColletive Agents&quot;,
 345             :author      =&gt; &quot;R.I.Pienaar &lt;rip@devco.net&gt;&quot;,
 346             :license     =&gt; &quot;ASL 2.0&quot;,
 347             :version     =&gt; &quot;1.0&quot;,
 348             :url         =&gt; &quot;http://marionette-collective.org/&quot;,
 349             :timeout     =&gt; 1
 350 </pre>
 351 <p>
 352 dataquery :description => &#8220;<a href="../Agent.html">Agent</a> Meta
 353 Data&#8221; do
 354 </p>
 355 <pre>
 356     input :query,
 357           :prompt =&gt; &quot;Agent Name&quot;,
 358           :description =&gt; &quot;Valid agent name&quot;,
 359           :type =&gt; :string,
 360           :validation =&gt; /^[\w\_]+$/,
 361           :maxlength =&gt; 20
 362
 363     [:license, :timeout, :description, :url, :version, :author].each do |item|
 364       output item,
 365              :description =&gt; &quot;Agent #{item}&quot;,
 366              :display_as =&gt; item.to_s.capitalize
 367     end
 368 </pre>
 369 <p>
 370 end
 371 </p>
 372
 373                 </div>
 374
 375                 <!-- Constants -->
 376
 377
 378                 <!-- Attributes -->
 379
 380
 381                 <!-- Methods -->
 382
 383                 <div id="public-instance-method-details" class="method-section section">
 384                         <h3 class="section-header">Public Instance Methods</h3>
 385
 386
 387                         <div id="dataquery-method" class="method-detail ">
 388                                 <a name="M000286"></a>
 389
 390                                 <div class="method-heading">
 391
 392                                         <span class="method-name">dataquery</span><span
 393                                                 class="method-args">(input, &block)</span>
 394                                         <span class="method-click-advice">click to toggle source</span>
 395
 396                                 </div>
 397
 398                                 <div class="method-description">
 399
 400                                         <p class="missing-docs">(Not documented)</p>
 401
 402
 403
 404                                         <div class="method-source-code"
 405                                                 id="dataquery-source">
 406 <pre>
 407     <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 31</span>
 408 31:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery</span>(<span class="ruby-identifier">input</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 409 32:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Data queries need a :description&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
 410 33:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Data queries can only have one definition&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>]
 411 34:
 412 35:         <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>]  = {<span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>],
 413 36:                              <span class="ruby-identifier">:input</span> =<span class="ruby-operator">&gt;</span> {},
 414 37:                              <span class="ruby-identifier">:output</span> =<span class="ruby-operator">&gt;</span> {}}
 415 38:
 416 39:         <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:data</span>
 417 40:         <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
 418 41:         <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
 419 42:       <span class="ruby-keyword kw">end</span></pre>
 420                                         </div>
 421
 422                                 </div>
 423
 424
 425                         </div>
 426
 427
 428                         <div id="dataquery-interface-method" class="method-detail ">
 429                                 <a name="M000289"></a>
 430
 431                                 <div class="method-heading">
 432
 433                                         <span class="method-name">dataquery_interface</span><span
 434                                                 class="method-args">()</span>
 435                                         <span class="method-click-advice">click to toggle source</span>
 436
 437                                 </div>
 438
 439                                 <div class="method-description">
 440
 441                                         <p>
 442 Returns the interface for the data query
 443 </p>
 444
 445
 446
 447                                         <div class="method-source-code"
 448                                                 id="dataquery-interface-source">
 449 <pre>
 450     <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 51</span>
 451 51:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery_interface</span>
 452 52:         <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] <span class="ruby-operator">||</span> {}
 453 53:       <span class="ruby-keyword kw">end</span></pre>
 454                                         </div>
 455
 456                                 </div>
 457
 458
 459                         </div>
 460
 461
 462                         <div id="input-method" class="method-detail ">
 463                                 <a name="M000287"></a>
 464
 465                                 <div class="method-heading">
 466
 467                                         <span class="method-name">input</span><span
 468                                                 class="method-args">(argument, properties)</span>
 469                                         <span class="method-click-advice">click to toggle source</span>
 470
 471                                 </div>
 472
 473                                 <div class="method-description">
 474
 475                                         <p class="missing-docs">(Not documented)</p>
 476
 477
 478
 479                                         <div class="method-source-code"
 480                                                 id="input-source">
 481 <pre>
 482     <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 44</span>
 483 44:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
 484 45:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;The only valid input name for a data query is 'query'&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:query</span>
 485 46:
 486 47:         <span class="ruby-keyword kw">super</span>
 487 48:       <span class="ruby-keyword kw">end</span></pre>
 488                                         </div>
 489
 490                                 </div>
 491
 492
 493                         </div>
 494
 495
 496                 </div>
 497
 498
 499         </div>
 500
 501
 502         <div id="rdoc-debugging-section-dump" class="debugging-section">
 503
 504                 <p>Disabled; run with --debug to generate this.</p>
 505
 506         </div>
 507
 508         <div id="validator-badges">
 509                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 510                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 511                         Rdoc Generator</a> 1.1.6</small>.</p>
 512         </div>
 513
 514 </body>
 515 </html>
 516