Difference between revisions of "Hyrax - BES Client commands"

From OPeNDAP Documentation
(Added commands for dap enabled servers:)
Line 4: Line 4:
  
 
<pre>
 
<pre>
     show help;
+
     <showHelp />
 +
 
 
* shows this help
 
* shows this help
     show version;
+
 
 +
     <showVersion />
 +
 
 
* shows the version of OPeNDAP and each data type served by this server
 
* shows the version of OPeNDAP and each data type served by this server
     show process;
+
 
* shows the process number of this application (available only in developer mode)
+
     <showProcess />
     show status;
+
 
 +
* shows the process number of this application. This command is
 +
  only available in developer mode.
 +
 
 +
     <showStatus />
 +
 
 
* shows the status of the server
 
* shows the status of the server
     show config;
+
 
* shows all keys defined in the bes initialization file (available only in developer mode)
+
     <showConfig />
     show containers;
+
 
 +
* shows all key/value pairs defined in the bes configuration file.
 +
  This command is only available in developer mode.
 +
 
 +
     <showContainers />
 +
 
 
* shows all containers currently defined
 
* shows all containers currently defined
     show context;
+
 
 +
     <showDefinitions />
 +
 
 +
* shows all definitions currently defined
 +
 
 +
    <showContext />
 +
 
 
* shows all context name/value pairs set in the BES
 
* shows all context name/value pairs set in the BES
  
     set container [in <storage_name>] values <symbolic_name>,<real_name>,<container_type>;
+
     <setContainer name="container_name" space="store_name" type="data_type">real_name</setContainer>
 +
 
 +
* defines a symbolic name representing a data container, usually
 +
  a file, to be used by definitions, described below
 +
* the space property is the name of the container storage and is
 +
  optional.  Defaults to default volatile storage. Examples
 +
  might include database storage, volatile storage based on
 +
  catalog information.
 +
* real_name is the full qualtified location of the data container, for example the full path to a data file.
 +
* data_type is the type of data that is in the dataset.  For netcdf files it is nc. For some container storage the data type is optional, determined by the container storage.
  
* defines a symbolic name representing a data container, usually a file,
+
    <setContext name="context_name">context_value</setContext>
  to be used by definitions, described below
 
* <storage_name> is the name of the container storage. Defaults to
 
  volatile storage. Examples might include database storage, volatile
 
  storage based on catalog information.
 
* <real_name> is the full path to a data file
 
* <container_type> is the type of data that is in the file. For
 
  netcdf files it is nc, for cedar it is cedar, etc...
 
  
    set context <context_name> to <context_value>;
+
* set the given context with the given value. No default context
* set the given context with the given value. No default context are
+
  are used in the BES
  available in the BES.
 
  
     define <def_name> [in <storage_name>] as <container_list> [where <container_x>.constraint="<constraint>",<container_x>.attributes="<attribute_list>"] [aggregate by "<aggregation_command"];
+
     <define name="definition_name" space="store_name">
 +
<container name="container_name">
 +
    <constraint>legal_constraint</constraint>
 +
    <attributes>attribute_list</attributes>
 +
</container>
 +
<aggregate handler="someHandler" cmd="someCommand" />
 +
    </define>
  
* creates a definition using one or more containers, constraints for
+
* creates a definition using one or more containers, constraints
  each of the containers, attributes to be retrieved from each
+
  for each of the containers, attributes to be retrieved from
  container, and an aggregation. Constraints, attributes, and
+
  each container, and an aggregation. Constraints, attributes,
  aggregation are all optional.
+
  and aggregation are all optional.
* <container_list> is a comma separated list of container names.
+
* There can be more than one container element
* <storage_name> is the name of the definition storage. Defaults to
+
* space is the name of the definition storage. Defaults to
 
  volatile storage. Examples might include database storage.
 
  volatile storage. Examples might include database storage.
* The constraints, attributes and aggregation command must be enclosed in quotes
 
  
     delete container <container_name> [from <storage_name>];
+
     <deleteContainer name="container_name" space="store_name" />
 +
 
 
* deletes the specified container from the specified container
 
* deletes the specified container from the specified container
  storage (defaults to volatile storage).</LI></UL>
+
  storage (defaults to volatile storage).
    delete containers [from <storage_name>]
+
 
 +
    <deleteContainers space="store_name" />
 +
 
 
* deletes all of the currently defined containers from the
 
* deletes all of the currently defined containers from the
 
  specified container storage (defaults to volatile storage).
 
  specified container storage (defaults to volatile storage).
     delete definition <definition_name> [from <storage_name>];
+
 
* deletes the specificed definition from the specified container
+
     <deleteDefinition name="definition_name" space="store_name" />
 +
 
 +
* deletes the specified definition from the specified container
 
  storage (defaults to volatile storage).
 
  storage (defaults to volatile storage).
     delete definitions;
+
 
 +
     <deleteDefinitions space="store_name" />
 +
 
 
* deletes all of the currently defined defintions from the
 
* deletes all of the currently defined defintions from the
 
  specified container storage (defaults to volatile storage).
 
  specified container storage (defaults to volatile storage).
  
    ** remember to terminate each command with a semicolon (;)
 
    For more information please contact Patrick West, pwest@ucar.edu
 
 
</pre>
 
</pre>
  
Line 67: Line 97:
  
 
<pre>
 
<pre>
     show catalog [for "node"];
+
     <showCatalog node="node_name" />
  
 
* Shows catalog information, including contents if a
 
* Shows catalog information, including contents if a
 
  container. If node is not specified then the root node
 
  container. If node is not specified then the root node
 
  information is returned. If node is specified then that nodes
 
  information is returned. If node is specified then that nodes
  information is returned. The node name must be in single quotes.
+
  information is returned.</LI>
  
     show info [for "node"];
+
     <showInfo node="node_name" />
  
 
* Shows catalog information for just that node, the root node
 
* Shows catalog information for just that node, the root node
 
  if no node is specified. If the node is a container the contents
 
  if no node is specified. If the node is a container the contents
  are not displayed. The node name must be in single quotes.
+
  are not displayed.</LI>
  
     get das|dds|dods|ddx for <definition_name> [return as <return_name>];
+
     <get type="das|dds|dods|ddx" definition="def_name" returnAs="returnAs" />
  
 +
* dds: request the data descriptor structure
 
* das: request the data attributes
 
* das: request the data attributes
* dds: request the data descriptor structure
+
* ddx: request the data attributes and data descriptor structure
        * ddx: request the data attributes and data structure, returned as XML document
+
  returned as an xml document
* dods: request for the data stream, this output is an octec binary  
+
* dods: request for the data stream, this output is an octec binary
  stream which requires the analysis by the client dods library
+
* stream which requires the analysis by the client dods library
 +
 
 +
    <setContext name="errors">dap2|xml|html|txt</setContext>
  
    set context errors to <dap2|xml|html|txt>;
+
* set the context 'errors' to dap2 in order to have all
* set the context 'errors' to dap2 in order to have all exceptions
+
  exceptions and errors formatted as dap2 error messages in
  and errors formatted as dap2 error messages in the response.
+
  the response.
  
    ** remember to terminate each command with a semicolon (;)
 
    For more information please contact Patrick West, pwest@ucar.edu
 
 
</pre>
 
</pre>

Revision as of 04:40, 28 January 2009

1 Client commands

1.1 Current core commands available with BES:

    <showHelp />

	* shows this help

    <showVersion />

	* shows the version of OPeNDAP and each data type served by this server

    <showProcess />

	* shows the process number of this application. This command is
	  only available in developer mode.

    <showStatus />

	* shows the status of the server

    <showConfig />

	* shows all key/value pairs defined in the bes configuration file.
	  This command is only available in developer mode.

    <showContainers />

	* shows all containers currently defined

    <showDefinitions />

	* shows all definitions currently defined

    <showContext />

	* shows all context name/value pairs set in the BES

    <setContainer name="container_name" space="store_name" type="data_type">real_name</setContainer>

	* defines a symbolic name representing a data container, usually
	  a file, to be used by definitions, described below
	* the space property is the name of the container storage and is
	  optional.  Defaults to default volatile storage. Examples
	  might include database storage, volatile storage based on
	  catalog information.
	* real_name is the full qualtified location of the data container, for example the full path to a data file.
	* data_type is the type of data that is in the dataset.  For netcdf files it is nc. For some container storage the data type is optional, determined by the container storage.

    <setContext name="context_name">context_value</setContext>

	* set the given context with the given value. No default context
	  are used in the BES

    <define name="definition_name" space="store_name">
	<container name="container_name">
	    <constraint>legal_constraint</constraint>
	    <attributes>attribute_list</attributes>
	</container>
	<aggregate handler="someHandler" cmd="someCommand" />
    </define>

	* creates a definition using one or more containers, constraints
	  for each of the containers, attributes to be retrieved from
	  each container, and an aggregation. Constraints, attributes,
	  and aggregation are all optional.
	* There can be more than one container element
	* space is the name of the definition storage.  Defaults to
	  volatile storage. Examples might include database storage.

    <deleteContainer name="container_name" space="store_name" />

	* deletes the specified container from the specified container
	  storage (defaults to volatile storage).

    <deleteContainers space="store_name" />

	* deletes all of the currently defined containers from the
	  specified container storage (defaults to volatile storage).

    <deleteDefinition name="definition_name" space="store_name" />

	* deletes the specified definition from the specified container
	  storage (defaults to volatile storage).

    <deleteDefinitions space="store_name" />

	* deletes all of the currently defined defintions from the
	  specified container storage (defaults to volatile storage).

1.2 Added commands for dap enabled servers:

If you are serving up OPeNDAP data responses (DAS, DDS, DataDDS) then you will have loaded the dap commands in your configuration file. Here are the available commands in the dap module.

    <showCatalog node="node_name" />

	* Shows catalog information, including contents if a
	  container. If node is not specified then the root node
	  information is returned. If node is specified then that nodes
	  information is returned.</LI>

    <showInfo node="node_name" />

	* Shows catalog information for just that node, the root node
	  if no node is specified. If the node is a container the contents
	  are not displayed.</LI>

    <get type="das|dds|dods|ddx" definition="def_name" returnAs="returnAs" />

	* dds: request the data descriptor structure
	* das: request the data attributes
	* ddx: request the data attributes and data descriptor structure
	  returned as an xml document
	* dods: request for the data stream, this output is an octec binary
	* stream which requires the analysis by the client dods library

    <setContext name="errors">dap2|xml|html|txt</setContext>

	* set the context 'errors' to dap2 in order to have all
	  exceptions and errors formatted as dap2 error messages in
	  the response.