Difference between revisions of "Hyrax - BES Client commands"

From OPeNDAP Documentation
(Current core commands available with BES:)
(Added commands for dap enabled servers:)
Line 82: Line 82:
 
     get das|dds|dods|ddx for <definition_name> [return as <return_name>];
 
     get das|dds|dods|ddx for <definition_name> [return as <return_name>];
  
 +
* das: request the data attributes
 
* dds: request the data descriptor structure
 
* dds: request the data descriptor structure
* das: request the data attributes
+
        * ddx: request the data attributes and data structure, returned as 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

Revision as of 14:53, 8 March 2008

1 Client commands

1.1 Current core commands available with BES:

    show help;
	* shows this help
    show version;
	* 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)
    show status;
	* shows the status of the server
    show config;
	* shows all keys defined in the bes initialization file (available only in developer mode)
    show containers;
	* shows all containers currently defined
    show context;
	* shows all context name/value pairs set in the BES

    set container [in <storage_name>] values <symbolic_name>,<real_name>,<container_type>;

	* defines a symbolic name representing a data container, usually a file,
	  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 are
	  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"];

	* 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.
	* <container_list> is a comma separated list of container names.
	* <storage_name> is the name of the definition storage. Defaults to
	  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>];
	* deletes the specified container from the specified container
	  storage (defaults to volatile storage).</LI></UL>
    delete containers [from <storage_name>]
	* deletes all of the currently defined containers from the
	  specified container storage (defaults to volatile storage).
    delete definition <definition_name> [from <storage_name>];
	* deletes the specificed definition from the specified container
	  storage (defaults to volatile storage).
    delete definitions;
	* deletes all of the currently defined defintions from the
	  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

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.

    show catalog [for "node"];

	* 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. The node name must be in single quotes.

    show info [for "node"];

	* 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. The node name must be in single quotes.

    get das|dds|dods|ddx for <definition_name> [return as <return_name>];

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

    set context errors to <dap2|xml|html|txt>;
	* set the context 'errors' to dap2 in order to have all exceptions
	  and errors formatted as dap2 error messages in the response.

    ** remember to terminate each command with a semicolon (;)
    For more information please contact Patrick West, pwest@ucar.edu