wdb:manuals:wdb_call_interface

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
wdb:manuals:wdb_call_interface [2012-04-04 12:56:38]
michaeloa [WDB Call Interface User Manual] 		wdb:manuals:wdb_call_interface [2022-05-31 09:29:32] (current)
Line 6: Line 6:
  
 This is the User's Manual for WDB Call Interface. This is the User's Manual for WDB Call Interface.
-===== Chapter�1.�Introduction ===== +===== Introduction =====
- +
-**Table of Contents** +
- +
-[[#sec:about_manual|About this Manual]][[#sec:intended_usage|Intended Usage]][[#sec:wci_outline|Outline]]+
  
 The WDB Call Interface (WCI) is the official API used for retrieving data from the WDB system. The WDB Call Interface (WCI) is the official API used for retrieving data from the WDB system.
  
-===== About this Manual =====+==== About this Manual ====
  
 This manual is intended for system designers, application developers and programmers. It describes in technical terms how weather data can be retrieved from the WDB system through the WCI. It is assumed that the reader has some familiarity with databases and weather data. This manual is intended for system designers, application developers and programmers. It describes in technical terms how weather data can be retrieved from the WDB system through the WCI. It is assumed that the reader has some familiarity with databases and weather data.
Line 20: Line 16:
 For a more elaborate description of the vision and system architecture of the WDB system, see the WDB Developer's Manual. For a more elaborate description of the vision and system architecture of the WDB system, see the WDB Developer's Manual.
  
-===== Intended Usage =====+==== Intended Usage ====
  
 WCI is intended to be used for retrieving weather data (e.g., temperature, air pressure, etc.) for a geographic point or area, given an altitude interval and a time or time interval. It is possible to retrieve individual data values or huge quantities of data using a single API. WCI is intended to be used for retrieving weather data (e.g., temperature, air pressure, etc.) for a geographic point or area, given an altitude interval and a time or time interval. It is possible to retrieve individual data values or huge quantities of data using a single API.
  
-===== Outline =====+==== Outline ====
  
 This document is structured as follows: This document is structured as follows:
Line 36: Line 32:
   * Known bugs and limitations   * Known bugs and limitations
  
-===== Chapter�2.�Key Concepts ===== +===== Key Concepts =====
- +
-**Table of Contents** +
- +
-[[#sec:wci_overview|Overview]][[#sec:data_provider|Data Provider]][[#sec:place|Place (Geographic Location)]][[#sec:reftime|Reference Time]][[#sec:validtime|Valid Time]][[#sec:value_parameter|Value Parameter]][[#sec:level|Level]][[#sec:data_version|Data Version]]+
  
 This section provides an overview of the WCI, including some important definitions and explanations. This section provides an overview of the WCI, including some important definitions and explanations.
  
-===== Overview =====+==== Overview ====
  
 WCI is an API designed to retrieve weather data from the WDB system. The WCI API resides on the database server. WCI is an API designed to retrieve weather data from the WDB system. The WCI API resides on the database server.
Line 64: Line 56:
 The dimensions are described in the following sections. The dimensions are described in the following sections.
  
-===== Data Provider =====+==== Data Provider ====
  
 The Data Provider identifies the source of the data; literally, //the entity that provides the data//. Where multiple sources could be identified as the source of the data, the entity that can be identified closest to the creation of the data item at the time of loading is usually used. The Data Provider identifies the source of the data; literally, //the entity that provides the data//. Where multiple sources could be identified as the source of the data, the entity that can be identified closest to the creation of the data item at the time of loading is usually used.
Line 82: Line 74:
   SELECT * FROM wci.getDataProvider( NULL );   SELECT * FROM wci.getDataProvider( NULL );
  
-===== Place (Geographic Location) =====+==== Place (Geographic Location) ====
  
 The place (geographic location) of a data item is the position of the item on the earth in a 2D space. In WDB, the geographic location is by default specified using longitude and latitude in a WGS84 coordinate system (though this can be changed when the database is set up; consult your system administrator). The geographic dimension is specified using a geometry object and can be either a point or a polygon. The place (geographic location) of a data item is the position of the item on the earth in a 2D space. In WDB, the geographic location is by default specified using longitude and latitude in a WGS84 coordinate system (though this can be changed when the database is set up; consult your system administrator). The geographic dimension is specified using a geometry object and can be either a point or a polygon.
Line 112: Line 104:
   SELECT * FROM wci.getPlaceDefinition( NULL );   SELECT * FROM wci.getPlaceDefinition( NULL );
  
-===== Reference Time =====+==== Reference Time ====
  
 The reference time of a data item is the moment when the data item is referenced from. For forecast data, this would typically be the reference time of the data values the forecast is based upon; for observation data, it would typically be the time when the observation data was recorded. The reference time of a data item is the moment when the data item is referenced from. For forecast data, this would typically be the reference time of the data values the forecast is based upon; for observation data, it would typically be the time when the observation data was recorded.
Line 144: Line 136:
 Denotes that the user wants to return all data inside the time period between the time point of 11:20 UTC, on the 31st of March, 2009 and the same time two months later. Denotes that the user wants to return all data inside the time period between the time point of 11:20 UTC, on the 31st of March, 2009 and the same time two months later.
  
-===== Valid Time =====+==== Valid Time ====
  
 The valid time of a data item is the time period for which the data item is valid. The valid time is always stored in the database as a time interval. The valid time of a data item is the time period for which the data item is valid. The valid time is always stored in the database as a time interval.
Line 176: Line 168:
 The contains keyword returns all the data with valid times beginning prior to the specified time and ending after the specified time. Semantics are inclusive, so a valid time that matches exactly would be returned as a row by this query. The contains keyword returns all the data with valid times beginning prior to the specified time and ending after the specified time. Semantics are inclusive, so a valid time that matches exactly would be returned as a row by this query.
  
-===== Value Parameter =====+==== Value Parameter ====
  
 Each data value can be described using a "value parameter". The value parameter is a name that describes the physics or code table basis of the parameter value. The value parameter concept in WCI is broadly similar to the concept of meteorological parameter used in, e.g., GRIB files. Each data value can be described using a "value parameter". The value parameter is a name that describes the physics or code table basis of the parameter value. The value parameter concept in WCI is broadly similar to the concept of meteorological parameter used in, e.g., GRIB files.
Line 190: Line 182:
   SELECT * FROM wci.getValueParameter( NULL );   SELECT * FROM wci.getValueParameter( NULL );
  
-===== Level =====+==== Level ====
  
 The //Level// dimension is normally used to designate the altitude or depth of the data value. Level is designated using a level interval (height from and to) and a level parameter (e.g., height above sea level, pressure). The level definition can be prefixed with a level interpolation option that permits the user a large degree of flexibility in expressing searches. Levels are specified using a level specification in string form that is parsed by the WCI. The //Level// dimension is normally used to designate the altitude or depth of the data value. Level is designated using a level interval (height from and to) and a level parameter (e.g., height above sea level, pressure). The level definition can be prefixed with a level interpolation option that permits the user a large degree of flexibility in expressing searches. Levels are specified using a level specification in string form that is parsed by the WCI.
Line 220: Line 212:
   SELECT * FROM wci.getLevelParameter( NULL );   SELECT * FROM wci.getLevelParameter( NULL );
  
-===== Data Version =====+==== Data Version ====
  
 There can be several different versions of the same data value that is valid for the same time, position, etc. This can happen with probability forecast calculations or when a data value is edited (in which case the new value may often be inserted with a higher data version). A data version is always a positive whole number. There can be several different versions of the same data value that is valid for the same time, position, etc. This can happen with probability forecast calculations or when a data value is edited (in which case the new value may often be inserted with a higher data version). A data version is always a positive whole number.
Line 228: Line 220:
 There is no wci.browse functionality to list all of the data versions of the data in the database. There is no wci.browse functionality to list all of the data versions of the data in the database.
  
-===== Chapter�3.�Using the WCI ===== +===== Using the WCI =====
- +
-**Table of Contents** +
- +
-[[#sec:using_outline|Outline]][[#sec:open_connection|Open a connection]][[#sec:initialize_wci|Initialize WCI]][[#sec:reading_wci|Read from the WCI]][[#sec:reading_wci_point|Reading Point Data from WCI]][[#sec:reading_wci_grid|Reading Grid Data from WCI]][[#sec:release_wci|Release WCI]][[#sec:close_connection|Close Connection]]+
  
 This section gives an overview on how to use the WCI to retrieve data values from WDB. This section gives an overview on how to use the WCI to retrieve data values from WDB.
  
-===== Outline =====+==== Outline ====
  
 The following list provides a brief overview of the actions that the user takes in order to retrieve data from WCI. The following list provides a brief overview of the actions that the user takes in order to retrieve data from WCI.
Line 246: Line 234:
   * Close database connection   * Close database connection
  
-===== Open a connection =====+==== Open a connection ====
  
 To enable communication with WCI, the user must open a connection to the database. How this is done depends very much on the application or API that is being used (consult the documentation of the program or API for information). To enable communication with WCI, the user must open a connection to the database. How this is done depends very much on the application or API that is being used (consult the documentation of the program or API for information).
Line 256: Line 244:
 The connection must be open and valid as long as commands are being sent and data retrieved from the database. It is worth noting that connections are a resource; the database will have limits on how many connections can be open at the same time. This is particularly important for massively multi-user applications (e.g., web applications). In such cases, the database connections must be managed with some care. There is also an amount overhead involved with setting up a connection, so it will always be more efficient to connect once and perform multiple database operations, than to connect repeatedly for each operation. The connection must be open and valid as long as commands are being sent and data retrieved from the database. It is worth noting that connections are a resource; the database will have limits on how many connections can be open at the same time. This is particularly important for massively multi-user applications (e.g., web applications). In such cases, the database connections must be managed with some care. There is also an amount overhead involved with setting up a connection, so it will always be more efficient to connect once and perform multiple database operations, than to connect repeatedly for each operation.
  
-===== Initialize WCI =====+==== Initialize WCI ====
  
 Before WCI may be used by the user, it must be initialized. Before WCI may be used by the user, it must be initialized.
Line 268: Line 256:
 Name spaces are used to identify what set of names should be used for searching the database. While the user is in a namespace, only the data defined in that namespace is visible to the user. If the user should wish, for some reason, to combine data from different namespaces within an application, it will be necessary to call wci.begin repeatedly; once for each time the application needs to change its namespace. Name spaces are used to identify what set of names should be used for searching the database. While the user is in a namespace, only the data defined in that namespace is visible to the user. If the user should wish, for some reason, to combine data from different namespaces within an application, it will be necessary to call wci.begin repeatedly; once for each time the application needs to change its namespace.
  
-===== Read from the WCI =====+==== Read from the WCI ====
  
 As soon as the user has initialized WCI using wci.begin, the database is ready for retrieval of data. Data is retrieved using the wci.read function, and data is searched for by setting the appropriate dimensions in that call. As soon as the user has initialized WCI using wci.begin, the database is ready for retrieval of data. Data is retrieved using the wci.read function, and data is searched for by setting the appropriate dimensions in that call.
  
-==== Reading Point Data from WCI ====+=== Reading Point Data from WCI ===
  
 The wci.read function is overloaded to permit the user to read either point data or binary data (entire grids) from the database. The last parameter in the wci.read function allows the user to specify the return type of the query. To return point data values, the user specifies wci.returnFloat. The wci.read function is overloaded to permit the user to read either point data or binary data (entire grids) from the database. The last parameter in the wci.read function allows the user to specify the return type of the query. To return point data values, the user specifies wci.returnFloat.
Line 304: Line 292:
 The above call returns all precipitation parameters valid for the 10 days following the given referencetime measured at the nearest point to oslo. Oslo, in this case, is a place name usually defined as a geographical point within the database. Prefixing the place name is the interpolation that we wish to use when retrieving points; we could also have used any of the alternatives defined in the reference manual below. Note the use of SQL wildcard characters in the value parameter; although these slow down queries (since wildcard searching is not as efficient as a straight comparison), it is possible to use the wci.read call in this way. Note also that names can be written in upper or lower case; the wci.read function call is not case-sensitive. The above call returns all precipitation parameters valid for the 10 days following the given referencetime measured at the nearest point to oslo. Oslo, in this case, is a place name usually defined as a geographical point within the database. Prefixing the place name is the interpolation that we wish to use when retrieving points; we could also have used any of the alternatives defined in the reference manual below. Note the use of SQL wildcard characters in the value parameter; although these slow down queries (since wildcard searching is not as efficient as a straight comparison), it is possible to use the wci.read call in this way. Note also that names can be written in upper or lower case; the wci.read function call is not case-sensitive.
  
-=== Return values ===+== Return values ==
  
 The return value from this call is one row for each value. This means that if you have chosen an interpolation type that will return several values for each grid, you will get many rows for each grid. The return value from this call is one row for each value. This means that if you have chosen an interpolation type that will return several values for each grid, you will get many rows for each grid.
Line 310: Line 298:
 The actual data value is given in the column "value". In some cases this may have a NULL value. This means that the there exists a data field for your query, and the point(s) you requested is inside the data's grid, but that grid point has explicitly gotten a "not defined" value. The actual data value is given in the column "value". In some cases this may have a NULL value. This means that the there exists a data field for your query, and the point(s) you requested is inside the data's grid, but that grid point has explicitly gotten a "not defined" value.
  
-==== Reading Grid Data from WCI ====+=== Reading Grid Data from WCI ===
  
 Reading grid data from the database is a two-step process. First the user retrieves the Grid ID with wci.read function (with wci.returnGId), and then the grid itself can be retrieved using the wci.fetch function call. Reading grid data from the database is a two-step process. First the user retrieves the Grid ID with wci.read function (with wci.returnGId), and then the grid itself can be retrieved using the wci.fetch function call.
Line 336: Line 324:
 The above call returns a single row, containing a binary string containing the actual grid data. It also includes additional information detailing the configuration of the grid. For details about the wci.fetch call, see the function reference. The above call returns a single row, containing a binary string containing the actual grid data. It also includes additional information detailing the configuration of the grid. For details about the wci.fetch call, see the function reference.
  
-=== Return values ===+== Return values ==
  
 The return value from this call is one row for each grid. The number given in the "value" column may be used as input argument for a wci.fetch call. The return value from this call is one row for each grid. The number given in the "value" column may be used as input argument for a wci.fetch call.
  
-===== Release WCI =====+==== Release WCI ====
  
 Once the user has finished retrieving data using WCI, it is a good idea to close down WCI. Once the user has finished retrieving data using WCI, it is a good idea to close down WCI.
Line 348: Line 336:
 This is not strictly necessary, but allows the system to graciously deallocate resources and reset any settings that may have been changed by WCI. This is not strictly necessary, but allows the system to graciously deallocate resources and reset any settings that may have been changed by WCI.
  
-===== Close Connection =====+==== Close Connection ====
  
 Closes down the connection to the database, freeing up the resources on the database to be used by other applications. Closes down the connection to the database, freeing up the resources on the database to be used by other applications.
Line 356: Line 344:
   PQfinish(connection_);   PQfinish(connection_);
  
-===== Chapter�4.�Function Reference ===== +===== Function Reference =====
- +
-**Table of Contents** +
- +
-[[#sec:wci.addcodelevelparameter|wci.addCodeLevelParameter]][[#sec:wci.addcodelevelparameter.prereq|Prerequisites]][[#sec:wci.addcodelevelparameter.syntax|Syntax]][[#sec:wci.addcodelevelparameter.parameters|Parameters]][[#sec:wci.addcodelevelparameter.result|Expected Result]][[#sec:wci.addcodelevelparameter.example|Example]][[#sec:wci.addcodelevelparamater.see|See Also]][[#sec:wci.addcodevalueparameter|wci.addCodeValueParameter]][[#sec:wci.addcodevalueparameter.prereq|Prerequisites]][[#sec:wci.addcodevalueparameter.syntax|Syntax]][[#sec:wci.addcodevalueparameter.parameters|Parameters]][[#sec:wci.addcodevalueparameter.result|Expected Result]][[#sec:wci.addcodevalueparameter.example|Example]][[#sec:wci.addcodevalueparamater.see|See Also]][[#sec:wci.adddataprovider|wci.addDataProvider]][[#sec:wci.adddataprovider.prereq|Prerequisites]][[#sec:wci.adddataprovider.syntax|Syntax]][[#sec:wci.adddataprovider.parameters|Parameters]][[#sec:wci.adddataprovider.result|Expected Result]][[#sec:wci.adddataprovider.example|Example]][[#sec:wci.adddataprovider.see|See Also]][[#sec:wci.adddataprovider2group|wci.addDataProviderToGroup]][[#sec:wci.adddataprovider2group.prereq|Prerequisites]][[#sec:wci.adddataprovider2group.syntax|Syntax]][[#sec:wci.adddataprovider2group.parameters|Parameters]][[#sec:wci.adddataprovider2group.result|Expected Result]][[#sec:wci.adddataprovider2group.example|Example]][[#sec:wci.adddataprovider2group.see|See Also]][[#sec:wci.adddimvalueparameter|wci.addDimensionlessValueParameter]][[#sec:wci.adddimvalueparameter.prereq|Prerequisites]][[#sec:wci.adddimvalueparameter.syntax|Syntax]][[#sec:wci.adddimvalueparameter.parameters|Parameters]][[#sec:wci.adddimvalueparameter.result|Expected Result]][[#sec:wci.adddimvalueparameter.example|Example]][[#sec:wci.adddimvalueparamater.see|See Also]][[#sec:wci.addfunctionvalueparameter|wci.addFunctionValueParameter]][[#sec:wci.addfunctionvalueparameter.prereq|Prerequisites]][[#sec:wci.addfunctionvalueparameter.syntax|Syntax]][[#sec:wci.addfunctionvalueparameter.parameters|Parameters]][[#sec:wci.addfunctionvalueparameter.result|Expected Result]][[#sec:wci.addfunctionvalueparameter.example|Example]][[#sec:wci.addfunctionvalueparamater.see|See Also]][[#sec:wci.addlevelparameterusage|wci.addLevelParameterUsage]][[#sec:wci.addlevelparameterusage.prereq|Prerequisites]][[#sec:wci.addlevelparameterusage.syntax|Syntax]][[#sec:wci.addlevelparameterusage.parameters|Parameters]][[#sec:wci.addlevelparameterusage.result|Expected Result]][[#sec:wci.addlevelparameterusage.example|Example]][[#sec:wci.addlevelparameterusage.see|See Also]][[#sec:wci.addmeasure|wci.addMeasure]][[#sec:wci.addmeasure.prereq|Prerequisites]][[#sec:wci.addmeasure.syntax|Syntax]][[#sec:wci.addmeasure.parameters|Parameters]][[#sec:wci.addmeasure.result|Expected Result]][[#sec:wci.addmeasure.example|Example]][[#sec:wci.addmeasure.see|See Also]][[#sec:wci.addmeasurelevelparameter|wci.addMeasureLevelParameter]][[#sec:wci.addmeasurelevelparameter.prereq|Prerequisites]][[#sec:wci.addmeasurelevelparameter.syntax|Syntax]][[#sec:wci.addmeasurelevelparameter.parameters|Parameters]][[#sec:wci.addmeasurelevelparameter.result|Expected Result]][[#sec:wci.addmeasurelevelparameter.example|Example]][[#sec:wci.addmeasurelevelparamater.see|See Also]][[#sec:wci.addmeasurevalueparameter|wci.addMeasureValueParameter]][[#sec:wci.addmeasurevalueparameter.prereq|Prerequisites]][[#sec:wci.addmeasurevalueparameter.syntax|Syntax]][[#sec:wci.addmeasurevalueparameter.parameters|Parameters]][[#sec:wci.addmeasurevalueparameter.result|Expected Result]][[#sec:wci.addmeasurevalueparameter.example|Example]][[#sec:wci.addmeasurevalueparameter.see|See Also]][[#sec:wci.addparameterfunctiontype|wci.addParameterFunctionType]][[#sec:wci.addparameterfunctiontype.prereq|Prerequisites]][[#sec:wci.addparameterfunctiontype.syntax|Syntax]][[#sec:wci.addparameterfunctiontype.parameters|Parameters]][[#sec:wci.addparameterfunctiontype.result|Expected Result]][[#sec:wci.addparameterfunctiontype.example|Example]][[#sec:wci.addparameterfunctiontype.see|See Also]][[#sec:wci.addplacepoint|wci.addPlacePoint]][[#sec:wci.addplacepoint.prereq|Prerequisites]][[#sec:wci.addplacepoint.syntax|Syntax]][[#sec:wci.addplacepoint.parameters|Parameters]][[#sec:wci.addplacepoint.result|Expected Result]][[#sec:wci.addplacepoint.example|Example]][[#sec:wci.addplacepoint.see|See Also]][[#sec:wci.addplacepolygon|wci.addPlacePolygon]][[#sec:wci.addplacepolygon.prereq|Prerequisites]][[#sec:wci.addplacepolygon.syntax|Syntax]][[#sec:wci.addplacepolygon.parameters|Parameters]][[#sec:wci.addplacepolygon.result|Expected Result]][[#sec:wci.addplacepolygon.example|Example]][[#sec:wci.addplacepolygon.see|See Also]][[#sec:wci.addplaceregulargrid|wci.addPlacerRegularGrid]][[#sec:wci.addplaceregulargrid.prereq|Prerequisites]][[#sec:wci.addplaceregulargrid.syntax|Syntax]][[#sec:wci.addplaceregulargrid.parameters|Parameters]][[#sec:wci.addplaceregulargrid.result|Expected Result]][[#sec:wci.addplaceregulargrid.example|Example]][[#sec:wci.addplaceregulargrid.see|See Also]][[#sec:wci.addsrid|wci.addSrid]][[#sec:wci.addsrid.prereq|Prerequisites]][[#sec:wci.addsrid.syntax|Syntax]][[#sec:wci.addsrid.parameters|Parameters]][[#sec:wci.addsrid.result|Expected Result]][[#sec:wci.addsrid.example|Example]][[#sec:wci.addsrid.see|See Also]][[#sec:wci.addunit|wci.addUnit]][[#sec:wci.addunit.prereq|Prerequisites]][[#sec:wci.addunit.syntax|Syntax]][[#sec:wci.addunit.parameters|Parameters]][[#sec:wci.addunit.result|Expected Result]][[#sec:wci.addunit.example|Example]][[#sec:wci.addunit.see|See Also]][[#sec:wci.addvalueparameterusage|wci.addValueParameterUsage]][[#sec:wci.addvalueparameterusage.prereq|Prerequisites]][[#sec:wci.addvalueparameterusage.syntax|Syntax]][[#sec:wci.addvalueparameterusage.parameters|Parameters]][[#sec:wci.addvalueparameterusage.result|Expected Result]][[#sec:wci.addvalueparameterusage.example|Example]][[#sec:wci.addvalueparameterusage.see|See Also]][[#sec:wci.addwciuser|wci.addWciUser]][[#sec:wci.addwciuser.prereq|Prerequisites]][[#sec:wci.addwciuser.syntax|Syntax]][[#sec:wci.addwciuser.parameters|Parameters]][[#sec:wci.addwciuser.result|Expected Result]][[#sec:wci.addwciuser.example|Example]][[#sec:wci.addwciuser.see|See Also]][[#sec:wci.begin|wci.begin]][[#sec:wci.begin.prereq|Prerequisites]][[#sec:wci.begin.syntax|Syntax]][[#sec:wci.begin.parameters|Parameters]][[#sec:wci.begin.result|Expected Result]][[#sec:wci.begin.example|Example]][[#sec:wci.begin.see|See Also]][[#sec:wci.browse|wci.browse]][[#sec:wci.browse.prereq|Prerequisites]][[#sec:wci.browse:syntax|Syntax]][[#sec:wci.browse.parameters|Parameters]][[#sec:wci.browse.result|Expected Result]][[#sec:wci.browse.example|Example]][[#sec:wci.browse.see|See Also]][[#sec:wci.configuration|wci.configuration]][[#sec:wci.configuration.prereq|Prerequisites]][[#sec:wci.configuration.syntax|Syntax]][[#sec:wci.configuration.parameters|Parameters]][[#sec:wci.configuration.result|Expected Result]][[#sec:wci.configuration.example|Example]][[#sec:wci.configuration.see|See Also]][[#sec:wci.end|wci.end]][[#sec:wci.end.prereq|Prerequisites]][[#sec:wci.end.syntax|Syntax]][[#sec:wci.end.parameters|Parameters]][[#sec:wci.end.result|Expected Result]][[#sec:wci.end.example|Example]][[#sec:wci.end.see|See Also]][[#sec:wci.fetch|wci.fetch]][[#sec:wci.fetch:prerequisites|Prerequisites]][[#sec:wci.fetch:syntax|Syntax]][[#sec:wci.fetch:parameters|Parameters]][[#sec:wci.fetch:expected_result|Expected Result]][[#sec:wci.fetch:examples|Examples]][[#sec:wci.fetch:see|See Also]][[#sec:wci.getcodelevelparameter|wci.getCodeLevelParameter]][[#sec:wci.getcodelevelparameter.prereq|Prerequisites]][[#sec:wci.getcodelevelparameter.syntax|Syntax]][[#sec:wci.getcodelevelparameter.parameters|Parameters]][[#sec:wci.getcodelevelparameter.result|Expected Result]][[#sec:wci.getcodelevelparameter.example|Example]][[#sec:wci.getcodelevelparameter.see|See Also]][[#sec:wci.getcodevalueparameter|wci.getCodeValueParameter]][[#sec:wci.getcodevalueparameter.prereq|Prerequisites]][[#sec:wci.getcodevalueparameter.syntax|Syntax]][[#sec:wci.getcodevalueparameter.parameters|Parameters]][[#sec:wci.getcodevalueparameter.result|Expected Result]][[#sec:wci.getcodevalueparameter.example|Example]][[#sec:wci.getcodevalueparameter.see|See Also]][[#sec:wci.getdataprovider|wci.getDataProvider]][[#sec:wci.getdataprovider.prereq|Prerequisites]][[#sec:wci.getdataprovider.syntax|Syntax]][[#sec:wci.getdataprovider.parameters|Parameters]][[#sec:wci.getdataprovider.result|Expected Result]][[#sec:wci.getdataprovider.example|Example]][[#sec:wci.getdataprovider.see|See Also]][[#sec:wci.getdataprovidername|wci.getDataProviderName]][[#sec:wci.getdataprovidername.prereq|Prerequisites]][[#sec:wci.getdataprovidername.syntax|Syntax]][[#sec:wci.getdataprovidername.parameters|Parameters]][[#sec:wci.getdataprovidername.result|Expected Result]][[#sec:wci.getdataprovidername.example|Example]][[#sec:wci.getdataprovidername.see|See Also]][[#sec:wci.getdimensionlessvalueparameter|wci.getDimensionlessValueParameter]][[#sec:wci.getdimensionlessvalueparameter.prereq|Prerequisites]][[#sec:wci.getdimensionlessvalueparameter.syntax|Syntax]][[#sec:wci.getdimensionlessvalueparameter.parameters|Parameters]][[#sec:wci.getdimensionlessvalueparameter.result|Expected Result]][[#sec:wci.getdimensionlessvalueparameter.example|Example]][[#sec:wci.getdimensionlessvalueparameter.see|See Also]][[#sec:wci.getfunctionvalueparameter|wci.getFunctionValueParameter]][[#sec:wci.getfunctionvalueparameter.prereq|Prerequisites]][[#sec:wci.getfunctionvalueparameter.syntax|Syntax]][[#sec:wci.getfunctionvalueparameter.parameters|Parameters]][[#sec:wci.getfunctionvalueparameter.result|Expected Result]][[#sec:wci.getfunctionvalueparameter.example|Example]][[#sec:wci.getfunctionvalueparameter.see|See Also]][[#sec:wci.getlevelparameter|wci.getLevelParameter]][[#sec:wci.getlevelparameter.prereq|Prerequisites]][[#sec:wci.getlevelparameter.syntax|Syntax]][[#sec:wci.getlevelparameter.parameters|Parameters]][[#sec:wci.getlevelparameter.result|Expected Result]][[#sec:wci.getlevelparameter.example|Example]][[#sec:wci.getlevelparameter.see|See Also]][[#sec:wci.getlevelparameterusage|wci.getlevelparameterusage]][[#sec:wci.getlevelparameterusage.prereq|Prerequisites]][[#sec:wci.getlevelparameterusage.syntax|Syntax]][[#sec:wci.getlevelparameterusage.parameters|Parameters]][[#sec:wci.getlevelparameterusage.result|Expected Result]][[#sec:wci.getlevelparameterusage.example|Example]][[#sec:wci.getlevelparameterusage.see|See Also]][[#sec:wci.getmeasure|wci.getMeasure]][[#sec:wci.getmeasure.prereq|Prerequisites]][[#sec:wci.getmeasure.syntax|Syntax]][[#sec:wci.getmeasure.parameters|Parameters]][[#sec:wci.getmeasure.result|Expected Result]][[#sec:wci.getmeasure.example|Example]][[#sec:wci.getmeasure.see|See Also]][[#sec:wci.getmeasurelevelparameter|wci.getMeasureLevelParameter]][[#sec:wci.getmeasurelevelparameter.prereq|Prerequisites]][[#sec:wci.getmeasurelevelparameter.syntax|Syntax]][[#sec:wci.getmeasurelevelparameter.parameters|Parameters]][[#sec:wci.getmeasurelevelparameter.result|Expected Result]][[#sec:wci.getmeasurelevelparameter.example|Example]][[#sec:wci.getmeasurelevelparameter.see|See Also]][[#sec:wci.getmeasurevalueparameter|wci.getMeasureValueParameter]][[#sec:wci.getmeasurevalueparameter.prereq|Prerequisites]][[#sec:wci.getmeasurevalueparameter.syntax|Syntax]][[#sec:wci.getmeasurevalueparameter.parameters|Parameters]][[#sec:wci.getmeasurevalueparameter.result|Expected Result]][[#sec:wci.getmeasurevalueparameter.example|Example]][[#sec:wci.getmeasurevalueparameter.see|See Also]][[#sec:wci.getparameterfunctiontype|wci.getParameterFunctionType]][[#sec:wci.getparameterfunctiontype.prereq|Prerequisites]][[#sec:wci.getparameterfunctiontype.syntax|Syntax]][[#sec:wci.getparameterfunctiontype.parameters|Parameters]][[#sec:wci.getparameterfunctiontype.result|Expected Result]][[#sec:wci.getparameterfunctiontype.example|Example]][[#sec:wci.getparameterfunctiontype.see|See Also]][[#sec:wci.getplacedefinition|wci.getPlaceDefinition]][[#sec:wci.getplacedefinition.prereq|Prerequisites]][[#sec:wci.getplacedefinition.syntax|Syntax]][[#sec:wci.getplacedefinition.parameters|Parameters]][[#sec:wci.getplacedefinition.result|Expected Result]][[#sec:wci.getplacedefinition.example|Example]][[#sec:wci.getplacedefinition.see|See Also]][[#sec:wci.getplacename|wci.getPlaceName]][[#sec:wci.getplacename.prereq|Prerequisites]][[#sec:wci.getplacename.syntax|Syntax]][[#sec:wci.getplacename.parameters|Parameters]][[#sec:wci.getplacename.result|Expected Result]][[#sec:wci.getplacename.example|Example]][[#sec:wci.getplacename.see|See Also]][[#sec:wci.getplacepoint|wci.getPlacePoint]][[#sec:wci.getplacepoint.prereq|Prerequisites]][[#sec:wci.getplacepoint.syntax|Syntax]][[#sec:wci.getplacepoint.parameters|Parameters]][[#sec:wci.getplacepoint.result|Expected Result]][[#sec:wci.getplacepoint.example|Example]][[#sec:wci.getplacepoint.see|See Also]][[#sec:wci.getplaceregulargrid|wci.getPlaceRegularGrid]][[#sec:wci.getplaceregulargrid.prereq|Prerequisites]][[#sec:wci.getplaceregulargrid.syntax|Syntax]][[#sec:wci.getplaceregulargrid.parameters|Parameters]][[#sec:wci.getplaceregulargrid.result|Expected Result]][[#sec:wci.getplaceregulargrid.example|Example]][[#sec:wci.getplaceregulargrid.see|See Also]][[#sec:wci.getsrid|wci.getSrid]][[#sec:wci.getsrid.prereq|Prerequisites]][[#sec:wci.getsrid.syntax|Syntax]][[#sec:wci.getsrid.parameters|Parameters]][[#sec:wci.getsrid.result|Expected Result]][[#sec:wci.getsrid.example|Example]][[#sec:wci.getsrid.see|See Also]][[#sec:wci.getunit|wci.getunit]][[#sec:wci.getunit.prereq|Prerequisites]][[#sec:wci.getunit.syntax|Syntax]][[#sec:wci.getunit.parameters|Parameters]][[#sec:wci.getunit.result|Expected Result]][[#sec:wci.getunit.example|Example]][[#sec:wci.getunit.see|See Also]][[#sec:wci.getvalueparameter|wci.getValueParameter]][[#sec:wci.getvalueparameter.prereq|Prerequisites]][[#sec:wci.getvalueparameter.syntax|Syntax]][[#sec:wci.getvalueparameter.parameters|Parameters]][[#sec:wci.getvalueparameter.result|Expected Result]][[#sec:wci.getvalueparameter.example|Example]][[#sec:wci.getvalueparameter.see|See Also]][[#sec:wci.read|wci.read]][[#sec:wci.read:prerequisites|Prerequisites]][[#sec:wci.read:syntax|Syntax]][[#sec:wci.read:parameters|Parameters]][[#sec:wci.read:expected_result|Expected Result]][[#sec:wci.read:examples|Examples]][[#sec:wci.read:see|See Also]][[#sec:wci.setdataprovidername|wci.setDataProviderName]][[#sec:wci.setdataprovidername.prereq|Prerequisites]][[#sec:wci.setdataprovidername.syntax|Syntax]][[#sec:wci.setdataprovidername.parameters|Parameters]][[#sec:wci.setdataprovidername.result|Expected Result]][[#sec:wci.setdataprovidername.example|Example]][[#sec:wci.setdataprovidername.see|See Also]][[#sec:wci.setlevelparametername|wci.setLevelParameterName]][[#sec:wci.setlevelparametername.prereq|Prerequisites]][[#sec:wci.setlevelparametername.syntax|Syntax]][[#sec:wci.setlevelparametername.parameters|Parameters]][[#sec:wci.setlevelparametername.result|Expected Result]][[#sec:wci.setlevelparametername.example|Example]][[#sec:wci.setlevelparametername.see|See Also]][[#sec:wci.setplacename|wci.setPlaceName]][[#sec:wci.setplacename.prereq|Prerequisites]][[#sec:wci.setplacename.syntax|Syntax]][[#sec:wci.setplacename.parameters|Parameters]][[#sec:wci.setplacename.result|Expected Result]][[#sec:wci.setplacename.example|Example]][[#sec:wci.setplacename.see|See Also]][[#sec:wci.setvalueparametername|wci.setValueParameterName]][[#sec:wci.setvalueparametername.prereq|Prerequisites]][[#sec:wci.setvalueparametername.syntax|Syntax]][[#sec:wci.setvalueparametername.parameters|Parameters]][[#sec:wci.setvalueparametername.result|Expected Result]][[#sec:wci.setvalueparametername.example|Example]][[#sec:wci.setvalueparametername.see|See Also]][[#sec:wci.version|wci.version]][[#sec:wci.version:prerequisites|Prerequisites]][[#sec:wci.version:syntax|Syntax]][[#sec:wci.version:parameters|Parameters]][[#sec:wci.version:expected_result|Expected Result]][[#sec:wci.version:examples|Examples]][[#sec:wci.version:see|See Also]][[#id2900563|wci.write]][[#id2900578|Prerequisites]][[#id2900608|Syntax]][[#id2900640|Parameters]][[#id2900794|Expected Result]][[#id2900804|See Also]]+
  
 The following sections provide a list of the functions available for usage through the WDB Call Interface. The following sections provide a list of the functions available for usage through the WDB Call Interface.
  
-===== wci.addCodeLevelParameter =====+==== wci.addCodeLevelParameter ====
  
 The function wci.addCodeLevelParameter allows an administrator to add new Level Parameters representing code tables to the WDB system. The function wci.addCodeLevelParameter allows an administrator to add new Level Parameters representing code tables to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addcodelevelparameter   wci.addcodelevelparameter
Line 380: Line 364:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.1.�wci.addCodeLevelParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 390: Line 372:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'hybrid level' code parameter from WMO: An example adding the 'hybrid level' code parameter from WMO:
Line 400: Line 382:
   SELECT wci.addcodelevelparameter ( 'hybrid level', 'WMO Code Table 3, WMO publication no. 306 - Manual on Code' );   SELECT wci.addcodelevelparameter ( 'hybrid level', 'WMO Code Table 3, WMO publication no. 306 - Manual on Code' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasurelevelparameter   * wci.addmeasurelevelparameter
Line 407: Line 389:
   * wci.getmeasurelevelparameter   * wci.getmeasurelevelparameter
  
-===== wci.addCodeValueParameter =====+==== wci.addCodeValueParameter ====
  
 The function wci.addCodeValueParameter allows an administrator to add new Value Parameters representing code tables to the WDB system. The function wci.addCodeValueParameter allows an administrator to add new Value Parameters representing code tables to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addcodevalueparameter   wci.addcodevalueparameter
Line 423: Line 405:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.2.�wci.addCodeValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 433: Line 413:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'yr weather symbol' code parameter from www.yr.no: An example adding the 'yr weather symbol' code parameter from www.yr.no:
Line 443: Line 423:
   SELECT wci.addcodevalueparameter ( 'yr weather symbol', 'http://www.yr.no' );   SELECT wci.addcodevalueparameter ( 'yr weather symbol', 'http://www.yr.no' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addparameterfunctiontype   * wci.addparameterfunctiontype
Line 450: Line 430:
   * wci.getparameterfunctiontype   * wci.getparameterfunctiontype
  
-===== wci.addDataProvider =====+==== wci.addDataProvider ====
  
 The function wci.addDataProvider allows an administrator to add a new Data Provider to the WDB system. The function wci.addDataProvider allows an administrator to add a new Data Provider to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.adddataprovider   wci.adddataprovider
Line 468: Line 448:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.3.�wci.addDataProvider parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 480: Line 458:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The DataProviderId (key reference number). The DataProviderId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example setting up the data provider "michael" who provides point data: An example setting up the data provider "michael" who provides point data:
Line 494: Line 472:
   SELECT wci.adddataprovider( 'longyear', 'Computer System', 'Grid', 'Model generated from longyearbyen' );   SELECT wci.adddataprovider( 'longyear', 'Computer System', 'Grid', 'Model generated from longyearbyen' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovidertogroup   * wci.adddataprovidertogroup
Line 502: Line 480:
   * wci.setdataprovidername   * wci.setdataprovidername
  
-===== wci.addDataProviderToGroup =====+==== wci.addDataProviderToGroup ====
  
 The function wci.addDataProviderToGroup allows an administrator to add a specified data provider to a data provider group in WDB. The function wci.addDataProviderToGroup allows an administrator to add a specified data provider to a data provider group in WDB.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.adddataprovidertogroup   wci.adddataprovidertogroup
Line 518: Line 496:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.4.�wci.addDataProviderToGroup parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 528: Line 504:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The DataProviderId (key reference number) of the assigned data provider. The DataProviderId (key reference number) of the assigned data provider.
  
-==== Example ====+=== Example ===
  
 An example setting the data provider "michael" into group 'metno': An example setting the data provider "michael" into group 'metno':
Line 538: Line 514:
   SELECT wci.adddataprovidertogroup ( 'michael', 'metno' );   SELECT wci.adddataprovidertogroup ( 'michael', 'metno' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovider   * wci.adddataprovider
Line 546: Line 522:
   * wci.setdataprovidername   * wci.setdataprovidername
  
-===== wci.addDimensionlessValueParameter =====+==== wci.addDimensionlessValueParameter ====
  
 The function wci.addDimensionlessValueParameter allows an administrator to add new Value Parameters without a physical dimension to the WDB system. The function wci.addDimensionlessValueParameter allows an administrator to add new Value Parameters without a physical dimension to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.adddimensionlessvalueparameter   wci.adddimensionlessvalueparameter
Line 562: Line 538:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.5.�wci.addDimensionlessValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 572: Line 546:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'land cover' value parameter from WMO: An example adding the 'land cover' value parameter from WMO:
Line 582: Line 556:
   SELECT wci.adddimensionlessvalueparameter ( 'land cover', 'Proportion of grid cell covered by land (WMO)' );   SELECT wci.adddimensionlessvalueparameter ( 'land cover', 'Proportion of grid cell covered by land (WMO)' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getvalueparameter   * wci.getvalueparameter
  
-===== wci.addFunctionValueParameter =====+==== wci.addFunctionValueParameter ====
  
 The function wci.addFunctionValueParameter allows an administrator to add new function value parameters to the WDB system. The function wci.addFunctionValueParameter allows an administrator to add new function value parameters to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addfunctionvalueparameter   wci.addfunctionvalueparameter
Line 604: Line 578:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.6.�wci.addFunctionValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 616: Line 588:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'mean wind waves duration' value parameter to the database: An example adding the 'mean wind waves duration' value parameter to the database:
Line 626: Line 598:
   SELECT wci.addfunctionvalueparameter ( 'wind waves', 's', 'mean', 'scalar' );   SELECT wci.addfunctionvalueparameter ( 'wind waves', 's', 'mean', 'scalar' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getvalueparameter   * wci.getvalueparameter
  
-===== wci.addLevelParameterUsage =====+==== wci.addLevelParameterUsage ====
  
 The function wci.addLevelParameterUsage allows an administrator to add new Level Parameter usages to the WDB system. The function wci.addLevelParameterUsage allows an administrator to add new Level Parameter usages to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addlevelparameterusage   wci.addlevelparameterusage
Line 646: Line 618:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.7.�wci.addLevelParameterUsage parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 656: Line 626:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example adding the 'height above ground' level usage to the database: An example adding the 'height above ground' level usage to the database:
Line 667: Line 637:
   'Denotes the height level of the value-' );   'Denotes the height level of the value-' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getlevelparameterusage   * wci.getlevelparameterusage
  
-===== wci.addMeasure =====+==== wci.addMeasure ====
  
 The function wci.addMeasure allows an administrator to add new measures (e.g., physical dimensions) to the WDB system. The function wci.addMeasure allows an administrator to add new measures (e.g., physical dimensions) to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addmeasure   wci.addmeasure
Line 694: Line 664:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.8.�wci.addmeasure parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 711: Line 679:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example adding 'acceleration' measure to the database: An example adding 'acceleration' measure to the database:
Line 721: Line 689:
   SELECT wci.addmeasure ( 'acceleration', 1, 0, -2, 0, 0, 0, 0, 0 );   SELECT wci.addmeasure ( 'acceleration', 1, 0, -2, 0, 0, 0, 0, 0 );
  
-==== See Also ====+=== See Also ===
  
   * wci.getmeasure   * wci.getmeasure
  
-===== wci.addMeasureLevelParameter =====+==== wci.addMeasureLevelParameter ====
  
 The function wci.addMeasureLevelParameter allows an administrator to add new level parameters based on measures to the WDB system. The function wci.addMeasureLevelParameter allows an administrator to add new level parameters based on measures to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addmeasurelevelparameter   wci.addmeasurelevelparameter
Line 741: Line 709:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.9.�wci.addMeasureLevelParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 751: Line 717:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'isobaric surface pressure' level parameter to the database: An example adding the 'isobaric surface pressure' level parameter to the database:
Line 761: Line 727:
   SELECT wci.addmeasurelevelparameter ( 'isobaric surface', 'Pa' );   SELECT wci.addmeasurelevelparameter ( 'isobaric surface', 'Pa' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getlevelparameter   * wci.getlevelparameter
  
-===== wci.addMeasureValueParameter =====+==== wci.addMeasureValueParameter ====
  
 The function wci.addMeasureValueParameter allows an administrator to add new value parameters based on measures to the WDB system. The function wci.addMeasureValueParameter allows an administrator to add new value parameters based on measures to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addmeasurevalueparameter   wci.addmeasurevalueparameter
Line 782: Line 748:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.10.�wci.addMeasureValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 793: Line 757:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The ParameterId (key reference number). The ParameterId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example adding the 'air temperature' value parameter to the database: An example adding the 'air temperature' value parameter to the database:
Line 803: Line 767:
   SELECT wci.addmeasurevalueparameter ( 'air', 'K', 'scalar' );   SELECT wci.addmeasurevalueparameter ( 'air', 'K', 'scalar' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasure   * wci.addmeasure
   * wci.getmeasurevalueparameter   * wci.getmeasurevalueparameter
  
-===== wci.addParameterFunctionType =====+==== wci.addParameterFunctionType ====
  
 The function wci.addParameterFunctionType allows an administrator to add new function types to be used with value parameters to the WDB system. The function wci.addParameterFunctionType allows an administrator to add new function types to be used with value parameters to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addparameterfunctiontype   wci.addparameterfunctiontype
Line 824: Line 788:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.11.�wci.addParameterFunctionType parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 834: Line 796:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example adding the 'max' function type to the database: An example adding the 'max' function type to the database:
Line 845: Line 807:
   'Maximum value for the period specified by the valid time interval' );   'Maximum value for the period specified by the valid time interval' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getfunctionvalueparameter   * wci.getfunctionvalueparameter
  
-===== wci.addPlacePoint =====+==== wci.addPlacePoint ====
  
 The function wci.addPlacePoint allows an administrator to add a new place definition for a point to the WDB system. The function wci.addPlacePoint allows an administrator to add a new place definition for a point to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have write privileges on the database.   * The user must have write privileges on the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addplacepoint   wci.addplacepoint
Line 865: Line 827:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.12.�wci.addPlacePoint parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 875: Line 835:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The PlaceId (key reference number). The PlaceId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example setting up the place point "karasjok": An example setting up the place point "karasjok":
Line 887: Line 847:
 Adding this point to the database while logged into a place name space other than zero, will add a point with the place name of 'karasjok' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database. Adding this point to the database while logged into a place name space other than zero, will add a point with the place name of 'karasjok' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database.
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepolygon   * wci.addplacepolygon
Line 899: Line 859:
   * wci.setplacename   * wci.setplacename
  
-===== wci.addPlacePolygon =====+==== wci.addPlacePolygon ====
  
 The function wci.addPlacePolygon allows an administrator to add a new place definition for a polygon to the WDB system. The function wci.addPlacePolygon allows an administrator to add a new place definition for a polygon to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have write privileges on the database.   * The user must have write privileges on the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addplacepolygon   wci.addplacepolygon
Line 915: Line 875:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.13.�wci.addPlacePolygon parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 925: Line 883:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The PlaceId (key reference number). The PlaceId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example setting up a polygon for "square at nowhere": An example setting up a polygon for "square at nowhere":
Line 938: Line 896:
 Adding this polygon to the database while logged into a place name space other than zero, will add a point with the place name of 'square at nowhere' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database. Adding this polygon to the database while logged into a place name space other than zero, will add a point with the place name of 'square at nowhere' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database.
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 950: Line 908:
   * wci.setplacename   * wci.setplacename
  
-===== wci.addPlacerRegularGrid =====+==== wci.addPlacerRegularGrid ====
  
 The function wci.addPlaceRegularGrid allows an administrator to add a new place definition for a regular grid to the WDB system. The function wci.addPlaceRegularGrid allows an administrator to add a new place definition for a regular grid to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have write privileges on the database.   * The user must have write privileges on the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addplaceregulargrid   wci.addplaceregulargrid
Line 972: Line 930:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.14.�wci.addPlaceRegularGrid parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 988: Line 944:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The PlaceId (key reference number). The PlaceId (key reference number).
  
-==== Example ====+=== Example ===
  
 An example setting up the hirlam 10km grid: An example setting up the hirlam 10km grid:
Line 1000: Line 956:
 Adding this grid to the database while logged into a place name space other than zero, will add a grid with the place name of 'hirlam 10km grid' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database. Adding this grid to the database while logged into a place name space other than zero, will add a grid with the place name of 'hirlam 10km grid' to the database and a canonical name in the zero name space. If the user was logged into the zero name space, only the canonical name would be added to the database.
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 1011: Line 967:
   * wci.setplacename   * wci.setplacename
  
-===== wci.addSrid =====+==== wci.addSrid ====
  
 The function wci.addSrid allows an administrator to add a new SRID definition to WDB. The function wci.addSrid allows an administrator to add a new SRID definition to WDB.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have write privileges on the database.   * The user must have write privileges on the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addsrid   wci.addsrid
Line 1027: Line 983:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.15.�wci.addSrid parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1037: Line 991:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The SRID (spatial reference id). The SRID (spatial reference id).
  
-==== Example ====+=== Example ===
  
 An example setting up the SRID of the Hirlam 10 grid (a rotated, longitude/latitude projection: An example setting up the SRID of the Hirlam 10 grid (a rotated, longitude/latitude projection:
Line 1048: Line 1002:
   '+proj=ob_tran +o_proj=longlat +lon_0=-40 +o_lat_p=22 +a=6367470.0 +no_defs');   '+proj=ob_tran +o_proj=longlat +lon_0=-40 +o_lat_p=22 +a=6367470.0 +no_defs');
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 1059: Line 1013:
   * wci.setplacename   * wci.setplacename
  
-===== wci.addUnit =====+==== wci.addUnit ====
  
 The function wci.addUnit allows an administrator to add a new unit to WDB. The function wci.addUnit allows an administrator to add a new unit to WDB.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addunit   wci.addunit
Line 1079: Line 1033:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.16.�wci.addUnit parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1093: Line 1045:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example adding the degree Fahrenheit to the database: An example adding the degree Fahrenheit to the database:
Line 1107: Line 1059:
   SELECT wci.addunit( 'K', 'SI Unit', 'temperature', 'Kelvin', 1, 0 );   SELECT wci.addunit( 'K', 'SI Unit', 'temperature', 'Kelvin', 1, 0 );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasure   * wci.addmeasure
  
-===== wci.addValueParameterUsage =====+==== wci.addValueParameterUsage ====
  
 The function wci.addValueParameterUsage allows an administrator to add new Value Parameter usages to the WDB system. The function wci.addValueParameterUsage allows an administrator to add new Value Parameter usages to the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addvalueparameterusage   wci.addvalueparameterusage
Line 1127: Line 1079:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.17.�wci.addLevelParameterUsage parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1137: Line 1087:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example adding the 'mean sea level' value usage to the database: An example adding the 'mean sea level' value usage to the database:
Line 1148: Line 1098:
   'Value reduced to sea level assuming an isothermal layer at the measuring point's temperature.' );   'Value reduced to sea level assuming an isothermal layer at the measuring point's temperature.' );
  
-==== See Also ====+=== See Also ===
  
   * wci.getvalueparameterusage   * wci.getvalueparameterusage
  
-===== wci.addWciUser =====+==== wci.addWciUser ====
  
 The function wci.addWciuser allows an administrator to add a WCI user to the database as a data provider in WDB. The function wci.addWciuser allows an administrator to add a WCI user to the database as a data provider in WDB.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.addwciuser   wci.addwciuser
Line 1167: Line 1117:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.18.�wci.addWciUser parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1176: Line 1124:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The DataProviderId (key reference number) of the inserted data provider. The DataProviderId (key reference number) of the inserted data provider.
  
-==== Example ====+=== Example ===
  
 An example adding the wci user "michael" as a new data provider: An example adding the wci user "michael" as a new data provider:
Line 1186: Line 1134:
   SELECT wci.addwciuser( 'michael' );   SELECT wci.addwciuser( 'michael' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovider   * wci.adddataprovider
Line 1194: Line 1142:
   * wci.setdataprovidername   * wci.setdataprovidername
  
-===== wci.begin =====+==== wci.begin ====
  
 The function wci.begin initializes the WDB Call Interface for a specified user. The function wci.begin initializes the WDB Call Interface for a specified user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have been set up as a WDB user (i.e., have access to one of the wdb user groups   * The user must have been set up as a WDB user (i.e., have access to one of the wdb user groups
  
-==== Syntax ====+=== Syntax ===
  
   wci.begin   wci.begin
Line 1216: Line 1164:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.19.�wci.begin parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1228: Line 1174:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 No return expected. No return expected.
  
-==== Example ====+=== Example ===
  
 An example setting up the user "michael" with the data provider and parameter name spaces associated with the code 1, while retaining use of the default place names: An example setting up the user "michael" with the data provider and parameter name spaces associated with the code 1, while retaining use of the default place names:
Line 1242: Line 1188:
   SELECT wci.begin ( 'michael' );   SELECT wci.begin ( 'michael' );
  
-==== See Also ====+=== See Also ===
  
   * wci.end   * wci.end
  
-===== wci.browse =====+==== wci.browse ====
  
 The wci.browse function is utilized to browse the meteorological, hydrological and oceanographic data in the database. Essentially, it can be used to retrieve summary data about what data values exist in the database. The function takes as input the same search parameters as the wci.read call, but returns summarized rather than detailed data about the values in the database. Using wci.browse will usually be significantly faster than performing a similar wci.read call followed by aggregation. The wci.browse function is utilized to browse the meteorological, hydrological and oceanographic data in the database. Essentially, it can be used to retrieve summary data about what data values exist in the database. The function takes as input the same search parameters as the wci.read call, but returns summarized rather than detailed data about the values in the database. Using wci.browse will usually be significantly faster than performing a similar wci.read call followed by aggregation.
Line 1252: Line 1198:
 The function is overloaded, and exists in many different versions, depending on the return type required. The function is overloaded, and exists in many different versions, depending on the return type required.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have access to group role wdb_read   * The user must have access to group role wdb_read
   * The user must have called wci.begin   * The user must have called wci.begin
  
-==== Syntax ====+=== Syntax ===
  
   wci.browse   wci.browse
Line 1361: Line 1307:
   )   )
  
-==== Parameters ====+=== Parameters ===
  
-All the wci.browse input parameters, except the returnType, are precisely the same as the input paramaters to a wci.read call (see Section [[#sec:wci.read:parameters|the section called “Parameters”]]). Calling a function with only the "returnType" parameter specified is basically equivalent to calling the wci.browse function with all NULLs (indicating that all data is required). Be aware that trying to retrieve aggregates about all the data in a huge database can take a while.+All the wci.browse input parameters, except the returnType, are precisely the same as the input paramaters to a wci.read call (see Section Parameters). Calling a function with only the "returnType" parameter specified is basically equivalent to calling the wci.browse function with all NULLs (indicating that all data is required). Be aware that trying to retrieve aggregates about all the data in a huge database can take a while.
  
 The returnType specifies which of the six different types of summarized metadata the user wants to retrieve. The returnType specifies which of the six different types of summarized metadata the user wants to retrieve.
  
-==== Expected Result ====+=== Expected Result ===
  
 Depending on the returnType specified: Depending on the returnType specified:
  
-  * wci.browsedataproviderThis returns a list of the data providers that exist in the database for the parameter definitions given in the wci.browse call and the utilized namespace. For each dataprovider, the number of data records and the earliest and latest referencetimes that exist for that data value is also listed. +  * wci.browsedataprovider This returns a list of the data providers that exist in the database for the parameter definitions given in the wci.browse call and the utilized namespace. For each dataprovider, the number of data records and the earliest and latest referencetimes that exist for that data value is also listed. 
-  * wci.browseplaceThis returns a list of the place definitions that exist in the database for the parameter definitions given by the wci.browse call and the used namespace. For each place definition, the number of data records in the database are listed. +  * wci.browseplace This returns a list of the place definitions that exist in the database for the parameter definitions given by the wci.browse call and the used namespace. For each place definition, the number of data records in the database are listed. 
-  * wci.browsereferencetimeThis returns a list of the referencetimes that exist in the database for the parameter definitions given by the wci.browse call. For each referencetime, the number of data records in the database are listed. +  * wci.browsereferencetime This returns a list of the referencetimes that exist in the database for the parameter definitions given by the wci.browse call. For each referencetime, the number of data records in the database are listed. 
-  * wci.browsevalidtimeThis returns a list of the validtimes that exist in the database for the parameter definitions given by the wci.browse call. For each validtime, the number of data records in the database are listed. +  * wci.browsevalidtime This returns a list of the validtimes that exist in the database for the parameter definitions given by the wci.browse call. For each validtime, the number of data records in the database are listed. 
-  * wci.browsevalueparameterThis returns a list of the value parameters that exist in the database for the parameter definitions given by the wci.browse call and the used namespace. For each valueparameter, the number of data records in the database are listed. +  * wci.browsevalueparameter This returns a list of the value parameters that exist in the database for the parameter definitions given by the wci.browse call and the used namespace. For each valueparameter, the number of data records in the database are listed. 
-  * wci.browselevelparameterThis returns a list of the level parameters that exist in the database for the parameter definitions given by the wci.browse call and the utilized namespace. For each level parameter, the number of data records in the database are listed.+  * wci.browselevelparameter This returns a list of the level parameters that exist in the database for the parameter definitions given by the wci.browse call and the utilized namespace. For each level parameter, the number of data records in the database are listed.
  
-==== Example ====+=== Example ===
  
 The following browse query could be used to retrieve the data provider names of all data providers in the database. The following browse query could be used to retrieve the data provider names of all data providers in the database.
Line 1397: Line 1343:
          NULL::wci.browsevalueparameter );          NULL::wci.browsevalueparameter );
  
-==== See Also ====+=== See Also ===
  
   * wci.read   * wci.read
  
-===== wci.configuration =====+==== wci.configuration ====
  
 The wci.configuration function returns all configuration information (i.e., the complete list of all versions installed) for the WDB database. The wci.configuration function returns all configuration information (i.e., the complete list of all versions installed) for the WDB database.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.configuration   wci.configuration
Line 1415: Line 1361:
   )   )
  
-==== Parameters ====+=== Parameters ===
  
 None. None.
  
-==== Expected Result ====+=== Expected Result ===
  
 Configuration information. Configuration information.
- 
-**Table�4.20.�wci.configuration return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1434: Line 1378:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to extract the configuration of the database: An example to extract the configuration of the database:
Line 1440: Line 1384:
   SELECT wci.configuration ( );   SELECT wci.configuration ( );
  
-==== See Also ====+=== See Also ===
  
   * wci.version   * wci.version
  
-===== wci.end =====+==== wci.end ====
  
 The function wci.end unsets any settings and frees up resources that may have been initialized by wci.begin. The function wci.end unsets any settings and frees up resources that may have been initialized by wci.begin.
  
-==== Prerequisites ====+=== Prerequisites ===
  
 None. None.
  
-==== Syntax ====+=== Syntax ===
  
   wci.end   wci.end
Line 1458: Line 1402:
   )   )
  
-==== Parameters ====+=== Parameters ===
  
 None. None.
  
-==== Expected Result ====+=== Expected Result ===
  
 No return expected. No return expected.
  
-==== Example ====+=== Example ===
  
 The wci.end function is just a simple functional call: The wci.end function is just a simple functional call:
Line 1472: Line 1416:
   SELECT wci.end ( );   SELECT wci.end ( );
  
-==== See Also ====+=== See Also ===
  
   * wci.begin   * wci.begin
  
-===== wci.fetch =====+==== wci.fetch ====
  
 wci.fetch is the function used to retrieve binary data values from the database. The function takes a binary object ID returned by a wci.read call and returns a row containing the binary data (as bytea data) as well as additional relevant information required for the manipulation of the binary data. wci.fetch is the function used to retrieve binary data values from the database. The function takes a binary object ID returned by a wci.read call and returns a row containing the binary data (as bytea data) as well as additional relevant information required for the manipulation of the binary data.
Line 1482: Line 1426:
 The returned binary data should be interpreted as 4-byte floats. Some of the data may have the value not-a-number. This means that that particular point does not have any defined value. The returned binary data should be interpreted as 4-byte floats. Some of the data may have the value not-a-number. This means that that particular point does not have any defined value.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have a valid object ID that references a grid   * The user must have a valid object ID that references a grid
Line 1488: Line 1432:
   * The user must have called wci.begin   * The user must have called wci.begin
  
-==== Syntax ====+=== Syntax ===
  
   wci.fetch   wci.fetch
Line 1496: Line 1440:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.21.�wci.fetch parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1506: Line 1448:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 Currently, the function always returns a: Currently, the function always returns a:
Line 1512: Line 1454:
   * wci.grid   * wci.grid
  
-==== Examples ====+=== Examples ===
  
 The following query returns the grid referenced as 11702: The following query returns the grid referenced as 11702:
Line 1523: Line 1465:
 The result is a single row containing the binary data of the grid itself (as a bytea), in addition to the number of points along the x and y axis of the grid, the distance between grid increments, the starting positions of the x and y points in the original projection, and the PROJ.4 string defining the original projection of the grid. The result is a single row containing the binary data of the grid itself (as a bytea), in addition to the number of points along the x and y axis of the grid, the distance between grid increments, the starting positions of the x and y points in the original projection, and the PROJ.4 string defining the original projection of the grid.
  
-==== See Also ====+=== See Also ===
  
   * wci.read   * wci.read
   * wci.write   * wci.write
  
-===== wci.getCodeLevelParameter =====+==== wci.getCodeLevelParameter ====
  
 The function wci.getCodeLevelParameter returns information about the specified level parameter of the code type to the user. The function wci.getCodeLevelParameter returns information about the specified level parameter of the code type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getcodelevelparameter   wci.getcodelevelparameter
Line 1543: Line 1485:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.22.�wci.getCodeLevelParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1552: Line 1492:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the level parameter in the namespace. A row of data describing the level parameter in the namespace.
Line 1567: Line 1507:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about code "hybrid level": An example to get information about code "hybrid level":
Line 1577: Line 1517:
   SELECT wci.getcodelevelparameter ( 'hybrid%' );   SELECT wci.getcodelevelparameter ( 'hybrid%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addcodelevelparameter   * wci.addcodelevelparameter
  
-===== wci.getCodeValueParameter =====+==== wci.getCodeValueParameter ====
  
 The function wci.getCodeValueParameter returns information about the specified value parameter of the code type to the user. The function wci.getCodeValueParameter returns information about the specified value parameter of the code type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getcodevalueparameter   wci.getcodevalueparameter
Line 1596: Line 1536:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.24.�wci.getCodeValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1605: Line 1543:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the value parameter in the namespace. A row of data describing the value parameter in the namespace.
- 
-**Table�4.25.�wci.getCodeValueParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1620: Line 1556:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about code "ice presence": An example to get information about code "ice presence":
Line 1630: Line 1566:
   SELECT wci.getcodevalueparameter ( 'ice%' );   SELECT wci.getcodevalueparameter ( 'ice%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addcodevalueparameter   * wci.addcodevalueparameter
  
-===== wci.getDataProvider =====+==== wci.getDataProvider ====
  
 The function wci.getDataProvider returns information about the specified data provider to a user. The function wci.getDataProvider returns information about the specified data provider to a user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getdataprovider   wci.getdataprovider
Line 1649: Line 1585:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.26.�wci.getDataProvider parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1658: Line 1592:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the Data Provider in the namespace. A row of data describing the Data Provider in the namespace.
- 
-**Table�4.27.�wci.getDataProvider return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1677: Line 1609:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about data provider "michael": An example to get information about data provider "michael":
Line 1687: Line 1619:
   SELECT wci.getdataprovider ( 'mich%' );   SELECT wci.getdataprovider ( 'mich%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovider   * wci.adddataprovider
Line 1695: Line 1627:
   * wci.setdataprovidername   * wci.setdataprovidername
  
-===== wci.getDataProviderName =====+==== wci.getDataProviderName ====
  
 The function wci.getDataProviderName lists the data provider names in the namespace that match the search criteria. The function wci.getDataProviderName lists the data provider names in the namespace that match the search criteria.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getdataprovidername   wci.getdataprovidername
Line 1710: Line 1642:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.28.�wci.getDataProviderName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1719: Line 1649:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of data provider names. The list of data provider names.
- 
-**Table�4.29.�wci.getDataProviderName return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1732: Line 1660:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the data provider matching the name "michael": An example to list the data provider matching the name "michael":
Line 1742: Line 1670:
   SELECT wci.getdataprovidername ( 'mich%' );   SELECT wci.getdataprovidername ( 'mich%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovider   * wci.adddataprovider
Line 1750: Line 1678:
   * wci.setdataprovidername   * wci.setdataprovidername
  
-===== wci.getDimensionlessValueParameter =====+==== wci.getDimensionlessValueParameter ====
  
 The function wci.getDimensionlessValueParameter returns information about the specified value parameter of the dimensionless type to the user. The function wci.getDimensionlessValueParameter returns information about the specified value parameter of the dimensionless type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getdimensionlessvalueparameter   wci.getdimensionlessvalueparameter
Line 1765: Line 1693:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.30.�wci.getDimensionlessValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1774: Line 1700:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the value parameter in the namespace. A row of data describing the value parameter in the namespace.
- 
-**Table�4.31.�wci.getDimensionlessValueParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1790: Line 1714:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the parameter "land albedo": An example to get information about the parameter "land albedo":
Line 1800: Line 1724:
   SELECT wci.getdimensionlessvalueparameter ( 'land%' );   SELECT wci.getdimensionlessvalueparameter ( 'land%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddimensionlessvalueparameter   * wci.adddimensionlessvalueparameter
  
-===== wci.getFunctionValueParameter =====+==== wci.getFunctionValueParameter ====
  
 The function wci.getFunctionValueParameter returns information about the specified value parameter of the function type to the user. The function wci.getFunctionValueParameter returns information about the specified value parameter of the function type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getfunctionvalueparameter   wci.getfunctionvalueparameter
Line 1819: Line 1743:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.32.�wci.getFunctionValueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1828: Line 1750:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the value parameter in the namespace. A row of data describing the value parameter in the namespace.
- 
-**Table�4.33.�wci.getfunctionValueParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1846: Line 1766:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the parameter "peak wave duration": An example to get information about the parameter "peak wave duration":
Line 1856: Line 1776:
   SELECT wci.getfunctionvalueparameter ( 'peak%' );   SELECT wci.getfunctionvalueparameter ( 'peak%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addfunctionvalueparameter   * wci.addfunctionvalueparameter
  
-===== wci.getLevelParameter =====+==== wci.getLevelParameter ====
  
 The function wci.getLevelParameter returns information about the specified level parameter of the function type to the user. The function wci.getLevelParameter returns information about the specified level parameter of the function type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getlevelparameter   wci.getlevelparameter
Line 1875: Line 1795:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.34.�wci.getLevelParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1884: Line 1802:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the level parameters in the namespace. A row of data describing the level parameters in the namespace.
- 
-**Table�4.35.�wci.getlevelParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1898: Line 1814:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the level parameter "hybrid level": An example to get information about the level parameter "hybrid level":
Line 1908: Line 1824:
   SELECT wci.getlevelparameter ( '%hybrid%' );   SELECT wci.getlevelparameter ( '%hybrid%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addcodelevelparameter   * wci.addcodelevelparameter
   * wci.addmeasurelevelparameter   * wci.addmeasurelevelparameter
  
-===== wci.getlevelparameterusage =====+==== wci.getlevelparameterusage ====
  
 The function wci.getlevelparameterusage returns information about the specified level parameter usage to the user. The function wci.getlevelparameterusage returns information about the specified level parameter usage to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getlevelparameterusage   wci.getlevelparameterusage
Line 1928: Line 1844:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.36.�wci.getlevelparameterusage parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1937: Line 1851:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the level parameter usages. A row of data describing the level parameter usages.
- 
-**Table�4.37.�wci.getlevelparameterusage return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 1949: Line 1861:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the level usage "sea surface": An example to get information about the level usage "sea surface":
Line 1959: Line 1871:
   SELECT wci.getlevelparameterusage ( '%sea%' );   SELECT wci.getlevelparameterusage ( '%sea%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addlevelparameterusage   * wci.addlevelparameterusage
  
-===== wci.getMeasure =====+==== wci.getMeasure ====
  
 The function wci.getMeasure returns information about the specified measure to the user. The function wci.getMeasure returns information about the specified measure to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getmeasure   wci.getmeasure
Line 1978: Line 1890:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.38.�wci.getmeasure parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 1987: Line 1897:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the measure. A row of data describing the measure.
- 
-**Table�4.39.�wci.getmeasure return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2006: Line 1914:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the measure "distance": An example to get information about the measure "distance":
Line 2012: Line 1920:
   SELECT wci.getmeasure ( 'distance' );   SELECT wci.getmeasure ( 'distance' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasure   * wci.addmeasure
  
-===== wci.getMeasureLevelParameter =====+==== wci.getMeasureLevelParameter ====
  
 The function wci.getmeasurelevelParameter returns information about the specified level parameter of the function type to the user. The function wci.getmeasurelevelParameter returns information about the specified level parameter of the function type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getmeasurelevelparameter   wci.getmeasurelevelparameter
Line 2031: Line 1939:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.40.�wci.getMeasureLevelParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2040: Line 1946:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the level parameters in the namespace. A row of data describing the level parameters in the namespace.
- 
-**Table�4.41.�wci.getmeasurelevelParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2056: Line 1960:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the level parameter "sea surface pressure": An example to get information about the level parameter "sea surface pressure":
Line 2066: Line 1970:
   SELECT wci.getmeasurelevelparameter ( '%sea%' );   SELECT wci.getmeasurelevelparameter ( '%sea%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasurelevelparameter   * wci.addmeasurelevelparameter
  
-===== wci.getMeasureValueParameter =====+==== wci.getMeasureValueParameter ====
  
 The function wci.getmeasurevalueParameter returns information about the specified value parameter of the function type to the user. The function wci.getmeasurevalueParameter returns information about the specified value parameter of the function type to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getmeasurevalueparameter   wci.getmeasurevalueparameter
Line 2085: Line 1989:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.42.�wci.getMeasurevalueParameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2094: Line 1996:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the value parameters in the namespace. A row of data describing the value parameters in the namespace.
- 
-**Table�4.43.�wci.getMeasurevalueParameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2111: Line 2011:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the value parameter "air temperature": An example to get information about the value parameter "air temperature":
Line 2121: Line 2021:
   SELECT wci.getmeasurevalueparameter ( '%temperature%' );   SELECT wci.getmeasurevalueparameter ( '%temperature%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addmeasurevalueparameter   * wci.addmeasurevalueparameter
  
-===== wci.getParameterFunctionType =====+==== wci.getParameterFunctionType ====
  
 The function wci.getparameterfunctiontype returns information about the specified parameterfunctiontype to the user. The function wci.getparameterfunctiontype returns information about the specified parameterfunctiontype to the user.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getparameterfunctiontype   wci.getparameterfunctiontype
Line 2140: Line 2040:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.44.�wci.getparameterfunctiontype parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2149: Line 2047:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 A row of data describing the parameterfunctiontype. A row of data describing the parameterfunctiontype.
- 
-**Table�4.45.�wci.getparameterfunctiontype return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2161: Line 2057:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to get information about the parameterfunctiontype "accumulated": An example to get information about the parameterfunctiontype "accumulated":
Line 2167: Line 2063:
   SELECT wci.getparameterfunctiontype ( 'accumulated' );   SELECT wci.getparameterfunctiontype ( 'accumulated' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addparameterfunctiontype   * wci.addparameterfunctiontype
  
-===== wci.getPlaceDefinition =====+==== wci.getPlaceDefinition ====
  
 The function wci.getPlaceDefinition lists the place definitions defined in the database that match the search criteria and are available in the namespace. The function wci.getPlaceDefinition lists the place definitions defined in the database that match the search criteria and are available in the namespace.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getplacedefinition   wci.getplacedefinition
Line 2186: Line 2082:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.46.�wci.getPlaceDefinition parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2195: Line 2089:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of place definitions. The list of place definitions.
- 
-**Table�4.47.�wci.getPlaceDefinition return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2213: Line 2105:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the place definitions matching the name "oslo": An example to list the place definitions matching the name "oslo":
Line 2223: Line 2115:
   SELECT wci.getplacedefinition ( 'os%' );   SELECT wci.getplacedefinition ( 'os%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2234: Line 2126:
   * wci.setplacename   * wci.setplacename
  
-===== wci.getPlaceName =====+==== wci.getPlaceName ====
  
 The function wci.getPlaceName lists the place names defined in the database that match the search criteria and are available in the namespace. The function wci.getPlaceName lists the place names defined in the database that match the search criteria and are available in the namespace.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getplacename   wci.getplacename
Line 2260: Line 2152:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.48.�wci.getPlaceName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2276: Line 2166:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of place grids. The list of place grids.
- 
-**Table�4.49.�wci.getPlaceName return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2289: Line 2177:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the placenames matching "osl": An example to list the placenames matching "osl":
Line 2298: Line 2186:
  
   SELECT wci.getplacename ( 248,   SELECT wci.getplacename ( 248,
-    400, +              400, 
-     0.5, +       0.5, 
-     0.5, +       0.5, 
-     35.6, +       35.6, 
-     -25.4, +       -25.4, 
-     "+proj=longlat +a=6367470.0 +towgs84=0,0,0 +no_defs" );+       "+proj=longlat +a=6367470.0 +towgs84=0,0,0 +no_defs" );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2316: Line 2204:
   * wci.setplacename   * wci.setplacename
  
-===== wci.getPlacePoint =====+==== wci.getPlacePoint ====
  
 The function wci.getPlacePoint lists all the place points defined in the database that match the search criteria and are available in the namespace. The function wci.getPlacePoint lists all the place points defined in the database that match the search criteria and are available in the namespace.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getplacepoint   wci.getplacepoint
Line 2331: Line 2219:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.50.�wci.getPlacePoint parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2340: Line 2226:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of place points. The list of place points.
- 
-**Table�4.51.�wci.getPlacePoint return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2358: Line 2242:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the place points matching the name "oslo": An example to list the place points matching the name "oslo":
Line 2368: Line 2252:
   SELECT wci.getplacepoint ( 'os%' );   SELECT wci.getplacepoint ( 'os%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2379: Line 2263:
   * wci.setplacename   * wci.setplacename
  
-===== wci.getPlaceRegularGrid =====+==== wci.getPlaceRegularGrid ====
  
 The function wci.getPlaceRegularGrid lists the place grids defined in the database that match the search criteria and are available in the namespace. The function wci.getPlaceRegularGrid lists the place grids defined in the database that match the search criteria and are available in the namespace.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getplaceregulargrid   wci.getplaceregulargrid
Line 2394: Line 2278:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.52.�wci.getPlaceRegularGrid parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2403: Line 2285:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of place grids. The list of place grids.
- 
-**Table�4.53.�wci.getPlaceDefinition return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2428: Line 2308:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the place grid matching the name "hirlam 10 grid": An example to list the place grid matching the name "hirlam 10 grid":
Line 2438: Line 2318:
   SELECT wci.getplaceregulargrid ( 'hirlam%' );   SELECT wci.getplaceregulargrid ( 'hirlam%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2449: Line 2329:
   * wci.setplacename   * wci.setplacename
  
-===== wci.getSrid =====+==== wci.getSrid ====
  
 The function wci.getSrid lists all the spatial reference ID's defined in the database that match the search criteria and are available in the namespace. The function wci.getSrid lists all the spatial reference ID's defined in the database that match the search criteria and are available in the namespace.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getsrid   wci.getsrid
Line 2464: Line 2344:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.54.�wci.getSrid parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2473: Line 2351:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of SRIDs. The list of SRIDs.
- 
-**Table�4.55.�wci.getSrid return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2488: Line 2364:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list the SRID's with longitude/latitude projections: An example to list the SRID's with longitude/latitude projections:
Line 2494: Line 2370:
   SELECT wci.getsrid ( '%+proj=longlat%' );   SELECT wci.getsrid ( '%+proj=longlat%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2505: Line 2381:
   * wci.setplacename   * wci.setplacename
  
-===== wci.getunit =====+==== wci.getunit ====
  
 The function wci.getunit lists all the units defined in the database that match the search criteria. The function wci.getunit lists all the units defined in the database that match the search criteria.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getunit   wci.getunit
Line 2520: Line 2396:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.56.�wci.getunit parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2529: Line 2403:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of units. The list of units.
- 
-**Table�4.57.�wci.getunit return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2545: Line 2417:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list all units with pressure (Pascal): An example to list all units with pressure (Pascal):
Line 2551: Line 2423:
   SELECT wci.getunit ( '%Pa%' );   SELECT wci.getunit ( '%Pa%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addunit   * wci.addunit
  
-===== wci.getValueParameter =====+==== wci.getValueParameter ====
  
 The function wci.getValueParameter lists all the value parameters defined in the database that match the search criteria. The function wci.getValueParameter lists all the value parameters defined in the database that match the search criteria.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have read access to the database.   * The user must have read access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.getvalueparameter   wci.getvalueparameter
Line 2570: Line 2442:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.58.�wci.getvalueparameter parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2579: Line 2449:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The list of valueparameters. The list of valueparameters.
- 
-**Table�4.59.�wci.getvalueparameter return row** 
  
 ^ Attribute ^ Description ^ ^ Attribute ^ Description ^
Line 2593: Line 2461:
 \\ \\
  
-==== Example ====+=== Example ===
  
 An example to list all value parameters based on temperature: An example to list all value parameters based on temperature:
Line 2599: Line 2467:
   SELECT wci.getvalueparameter ( '%temperature%' );   SELECT wci.getvalueparameter ( '%temperature%' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addvalueparameter   * wci.addvalueparameter
  
-===== wci.read =====+==== wci.read ====
  
 wci.read is the function that fetches MHO data from the database, and as such is the core of the WDB Call Interface. The function takes the user's search parameters as input and returns data as either individual point, or as a reference to a complete data grid (a Grid ID - shortened as GId). wci.read is the function that fetches MHO data from the database, and as such is the core of the WDB Call Interface. The function takes the user's search parameters as input and returns data as either individual point, or as a reference to a complete data grid (a Grid ID - shortened as GId).
Line 2609: Line 2477:
 The function is overloaded, and exists in two almost identical versions, depending on the return type required. The function is overloaded, and exists in two almost identical versions, depending on the return type required.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have access to group role wdb_read   * The user must have access to group role wdb_read
   * The user must have called wci.begin   * The user must have called wci.begin
  
-==== Syntax ====+=== Syntax ===
  
   wci.read   wci.read
Line 2640: Line 2508:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.60.�wci.read parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2656: Line 2522:
 \\ \\
  
->Geospatial definitions are defined using well-known-text. Only POINTs and POLYGONs are currently supported.+Geospatial definitions are defined using well-known-text. Only POINTs and POLYGONs are currently supported.
  
-==== Expected Result ====+=== Expected Result ===
  
 Depending on the returnType specified: Depending on the returnType specified:
Line 2665: Line 2531:
   * wci.returngid   * wci.returngid
  
-==== Examples ====+=== Examples ===
  
 The following query returns Hirlam 8 data from the database using a wci.read: The following query returns Hirlam 8 data from the database using a wci.read:
Line 2682: Line 2548:
 The above query returns Hirlam 8 data pressure and temperature data for the point closest to 10 degrees East, 60 degrees North that is valid for the twenty four hour time period of the 6th of April, 1980 and which was created (has the reference time) for the 5th of April, 12:00. The query returns all data that fulfills the above qualifications regardless of level, but only the latest version (dataversion) of the data available. Values will be returned as point data. The above query returns Hirlam 8 data pressure and temperature data for the point closest to 10 degrees East, 60 degrees North that is valid for the twenty four hour time period of the 6th of April, 1980 and which was created (has the reference time) for the 5th of April, 12:00. The query returns all data that fulfills the above qualifications regardless of level, but only the latest version (dataversion) of the data available. Values will be returned as point data.
  
-==== See Also ====+=== See Also ===
  
   * wci.begin   * wci.begin
Line 2689: Line 2555:
   * wci.write   * wci.write
  
-===== wci.setDataProviderName =====+==== wci.setDataProviderName ====
  
 The function wci.setDataProviderName allows an administrator to set the data provider name of a data provider in the currently selected namespace of WDB. If another data provider name has already been set for the data provider in the namespace, this function will overwrite the old name. The function wci.setDataProviderName allows an administrator to set the data provider name of a data provider in the currently selected namespace of WDB. If another data provider name has already been set for the data provider in the namespace, this function will overwrite the old name.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.setdataprovidername   wci.setdataprovidername
Line 2706: Line 2572:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.61.�wci.setDataProviderName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2717: Line 2581:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 No return. No return.
  
-==== Example ====+=== Example ===
  
 To rename the data provider with the canonical name "michael" to "michel", we would use: To rename the data provider with the canonical name "michael" to "michel", we would use:
Line 2727: Line 2591:
   SELECT wci.setdataprovidername( 'michael', 'michel' );   SELECT wci.setdataprovidername( 'michael', 'michel' );
  
-==== See Also ====+=== See Also ===
  
   * wci.adddataprovider   * wci.adddataprovider
Line 2735: Line 2599:
   * wci.getdataprovidername   * wci.getdataprovidername
  
-===== wci.setLevelParameterName =====+==== wci.setLevelParameterName ====
  
 The function wci.setLevelParameterName allows an administrator to set the name of a level parameter in the currently selected namespace of WDB. If another level parameter name has already been set in the namespace, this function will overwrite the old name. The function wci.setLevelParameterName allows an administrator to set the name of a level parameter in the currently selected namespace of WDB. If another level parameter name has already been set in the namespace, this function will overwrite the old name.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.setlevelparametername   wci.setlevelparametername
Line 2751: Line 2615:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.62.�wci.setLevelParameterName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2761: Line 2623:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 No return. No return.
  
-==== Example ====+=== Example ===
  
 To rename the parameter with the canonical name "hybrid level" to "HL", we would use: To rename the parameter with the canonical name "hybrid level" to "HL", we would use:
Line 2771: Line 2633:
   SELECT wci.setlevelparametername( 'hybrid level', 'HL' );   SELECT wci.setlevelparametername( 'hybrid level', 'HL' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addcodelevelparameter   * wci.addcodelevelparameter
Line 2777: Line 2639:
   * wci.getlevelparameter   * wci.getlevelparameter
  
-===== wci.setPlaceName =====+==== wci.setPlaceName ====
  
 The function wci.setPlaceName allows an administrator to set the place name of a place definition in the currently selected namespace of WDB. If another place name has already been set for the place definition in the namespace, this function will overwrite the old name. The function wci.setPlaceName allows an administrator to set the place name of a place definition in the currently selected namespace of WDB. If another place name has already been set for the place definition in the namespace, this function will overwrite the old name.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative access to the database.   * The user must have administrative access to the database.
  
-==== Syntax ====+=== Syntax ===
  
   wci.setPlaceName   wci.setPlaceName
Line 2793: Line 2655:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.63.�wci.setPlaceName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2803: Line 2663:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 None. None.
  
-==== Example ====+=== Example ===
  
 An example to set the name of the Hirlam 10 grid in the database: An example to set the name of the Hirlam 10 grid in the database:
Line 2813: Line 2673:
   SELECT wci.setplacename ( 'grid(5.75 -13.25, 0.1 0.1, 248 400, 50001)', 'hirlam 10km grid' );   SELECT wci.setplacename ( 'grid(5.75 -13.25, 0.1 0.1, 248 400, 50001)', 'hirlam 10km grid' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addplacepoint   * wci.addplacepoint
Line 2823: Line 2683:
   * wci.getplaceregulargrid   * wci.getplaceregulargrid
  
-===== wci.setValueParameterName =====+==== wci.setValueParameterName ====
  
 The function wci.setValueParameterName allows an administrator to set the name of a value parameter in the currently selected namespace of WDB. If another value parameter name has already been set in the namespace, this function will overwrite the old name. The function wci.setValueParameterName allows an administrator to set the name of a value parameter in the currently selected namespace of WDB. If another value parameter name has already been set in the namespace, this function will overwrite the old name.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.   * The user must have administrative rights to the database; i.e., either be the system administrator or a member of the WDB_ADMIN user group.
  
-==== Syntax ====+=== Syntax ===
  
   wci.setvalueparametername   wci.setvalueparametername
Line 2839: Line 2699:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.64.�wci.setValueParameterName parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2849: Line 2707:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 No return. No return.
  
-==== Example ====+=== Example ===
  
 To rename the parameter with the canonical name "air temperature" to "2TM", we would use: To rename the parameter with the canonical name "air temperature" to "2TM", we would use:
Line 2859: Line 2717:
   SELECT wci.setvalueparametername( 'air temperature', '2TM' );   SELECT wci.setvalueparametername( 'air temperature', '2TM' );
  
-==== See Also ====+=== See Also ===
  
   * wci.addcodevalueparameter   * wci.addcodevalueparameter
Line 2867: Line 2725:
   * wci.getvalueparameter   * wci.getvalueparameter
  
-===== wci.version =====+==== wci.version ====
  
 wci.version is a simple function that permits the user to retrieve version information about the WDB system. wci.version is a simple function that permits the user to retrieve version information about the WDB system.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must have access to group role wdb_read   * The user must have access to group role wdb_read
  
-==== Syntax ====+=== Syntax ===
  
   wci.version ( )   wci.version ( )
  
-==== Parameters ====+=== Parameters ===
  
 None. None.
  
-==== Expected Result ====+=== Expected Result ===
  
 The function returns a text with a string that describes the version of the WDB system in the PostgreSQL database. The function returns a text with a string that describes the version of the WDB system in the PostgreSQL database.
  
-==== Examples ====+=== Examples ===
  
 The following query returns the WDB version: The following query returns the WDB version:
Line 2895: Line 2753:
 The result is a single row of the text type containing the WDB version string. The result is a single row of the text type containing the WDB version string.
  
-==== See Also ====+=== See Also ===
  
   * wci.begin   * wci.begin
  
-===== wci.write =====+==== wci.write ====
  
 wci.write is function that can be utilized to write MHO data into the database. wci.write is function that can be utilized to write MHO data into the database.
Line 2905: Line 2763:
 The function is overloaded, and exists in several different versions depending on the input utilized. The function is overloaded, and exists in several different versions depending on the input utilized.
  
-==== Prerequisites ====+=== Prerequisites ===
  
   * The user must be connected to the database   * The user must be connected to the database
Line 2911: Line 2769:
   * The user must have called wci.begin   * The user must have called wci.begin
  
-==== Syntax ====+=== Syntax ===
  
   wci.write   wci.write
Line 2944: Line 2802:
   )   )
  
-==== Parameters ==== +=== Parameters ===
- +
-**Table�4.65.�wci.write parameters**+
  
 ^ Parameter ^ Description ^ ^ Parameter ^ Description ^
Line 2962: Line 2818:
 \\ \\
  
-==== Expected Result ====+=== Expected Result ===
  
 The valueid of the inserted row. The valueid of the inserted row.
  
-==== See Also ====+=== See Also ===
  
   * wci.read   * wci.read
Line 2972: Line 2828:
   * wci.end   * wci.end
  
-===== Chapter�5.�Data Type Reference ===== +===== Data Type Reference =====
- +
-**Table of Contents** +
- +
-[[#id2900847|wci.browsedataprovider]][[#id2900963|wci.browseplace]][[#id2901078|wci.browsereferencetime]][[#id2901165|wci.browsevalidtime]][[#id2901266|wci.browsevalueparameter]][[#id2901367|wci.browselevelparameter]][[#id2901496|wci.infodataprovider]][[#id2901634|wci.infoplace]][[#id2901766|wci.inforegulargrid]][[#id2901942|wci.infovalueparameter]][[#id2902029|wci.infolevelparameter]][[#id2902116|wci.returnFloat]][[#id2902476|wci.returnGid]]+
  
 This section provides an overview of the data types that are returned from the database through WCI; in particular the return rows used by the wci.read and wci.write calls. This section provides an overview of the data types that are returned from the database through WCI; in particular the return rows used by the wci.read and wci.write calls.
  
-===== wci.browsedataprovider =====+==== wci.browsedataprovider ====
  
 The wci.browsedataprovider data type is a simple row type used to return summarized information about the data providers of the rows currently stored in the database. The following table describes the attributes. The wci.browsedataprovider data type is a simple row type used to return summarized information about the data providers of the rows currently stored in the database. The following table describes the attributes.
- 
-**Table�5.1.�wci.browsedataprovider** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 2994: Line 2844:
 \\ \\
  
-===== wci.browseplace =====+==== wci.browseplace ====
  
 The wci.browseplace data type is a simple row type used to return summarized information about the placenames of the rows currently stored in the database. The following table describes the attributes. The wci.browseplace data type is a simple row type used to return summarized information about the placenames of the rows currently stored in the database. The following table describes the attributes.
- 
-**Table�5.2.�wci.browseplace** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3008: Line 2856:
 \\ \\
  
-===== wci.browsereferencetime =====+==== wci.browsereferencetime ====
  
 The wci.browsereferencetime data type is a simple row type used to return summarized information about the referencetime of the rows currently stored in the database. The following table describes the attributes. The wci.browsereferencetime data type is a simple row type used to return summarized information about the referencetime of the rows currently stored in the database. The following table describes the attributes.
- 
-**Table�5.3.�wci.browsereferencetime** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3020: Line 2866:
 \\ \\
  
-===== wci.browsevalidtime =====+==== wci.browsevalidtime ====
  
 The wci.browsevalidtime data type is a simple row type used to return summarized information about the validtime of the rows currently stored in the database. The following table describes the attributes. The wci.browsevalidtime data type is a simple row type used to return summarized information about the validtime of the rows currently stored in the database. The following table describes the attributes.
- 
-**Table�5.4.�wci.browsevalidtime** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3033: Line 2877:
 \\ \\
  
-===== wci.browsevalueparameter =====+==== wci.browsevalueparameter ====
  
 The wci.browsevalueparameter data type is a simple row type used to return summarized information about the valueparameters currently used by the rows in the database. The following table describes the attributes. The wci.browsevalueparameter data type is a simple row type used to return summarized information about the valueparameters currently used by the rows in the database. The following table describes the attributes.
- 
-**Table�5.5.�wci.browsevalueparameter** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3046: Line 2888:
 \\ \\
  
-===== wci.browselevelparameter =====+==== wci.browselevelparameter ====
  
 The wci.browselevelparameter data type is a simple row type used to return summarized information about the levelparameters and level values currently stored by the rows in the database. The following table describes the attributes. The wci.browselevelparameter data type is a simple row type used to return summarized information about the levelparameters and level values currently stored by the rows in the database. The following table describes the attributes.
- 
-**Table�5.6.�wci.browselevelparameter** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3061: Line 2901:
 \\ \\
  
-===== wci.infodataprovider =====+==== wci.infodataprovider ====
  
 The wci.infodataprovider data type is a simple row type used to return metadata information about the dataproviders that can be stored in the database. The following table describes the attributes. The wci.infodataprovider data type is a simple row type used to return metadata information about the dataproviders that can be stored in the database. The following table describes the attributes.
- 
-**Table�5.7.�wci.infodataprovider** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3076: Line 2914:
 \\ \\
  
-===== wci.infoplace =====+==== wci.infoplace ====
  
 The wci.infoplace data type is a simple row type used to return metadata information about the place definitions that can be stored in the database. The following table describes the attributes. The wci.infoplace data type is a simple row type used to return metadata information about the place definitions that can be stored in the database. The following table describes the attributes.
- 
-**Table�5.8.�wci.infoplace** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3091: Line 2927:
 \\ \\
  
-===== wci.inforegulargrid =====+==== wci.inforegulargrid ====
  
 The wci.inforegulargrid data type is a simple row type used to return detailed metadata information about the place definitions of the grid type that can be stored in the database. The following table describes the attributes. The wci.inforegulargrid data type is a simple row type used to return detailed metadata information about the place definitions of the grid type that can be stored in the database. The following table describes the attributes.
- 
-**Table�5.9.�wci.infoplace** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3109: Line 2943:
 \\ \\
  
-===== wci.infovalueparameter =====+==== wci.infovalueparameter ====
  
 The wci.infovalueparameter data type is a simple row type used to return metadata information about the value parameters that can be stored in the database. The following table describes the attributes. The wci.infovalueparameter data type is a simple row type used to return metadata information about the value parameters that can be stored in the database. The following table describes the attributes.
- 
-**Table�5.10.�wci.infovalueparameter** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3121: Line 2953:
 \\ \\
  
-===== wci.infolevelparameter =====+==== wci.infolevelparameter ====
  
 The wci.infolevelparameter data type is a simple row type used to return metadata information about the level parameters that can be stored in the database. The following table describes the attributes. The wci.infolevelparameter data type is a simple row type used to return metadata information about the level parameters that can be stored in the database. The following table describes the attributes.
- 
-**Table�5.11.�wci.infolevelparameter** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3133: Line 2963:
 \\ \\
  
-===== wci.returnFloat =====+==== wci.returnFloat ====
  
 The wci.returnFloat data type is a simple row type used for returning floating-point data to the user from the wci.read call. The following table describes the attributes that are returned from wci.returnFloat; including the ordering of the attributes in the type. The wci.returnFloat data type is a simple row type used for returning floating-point data to the user from the wci.read call. The following table describes the attributes that are returned from wci.returnFloat; including the ordering of the attributes in the type.
- 
-**Table�5.12.�wci.returnFloat** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3163: Line 2991:
 \\ \\
  
-===== wci.returnGid =====+==== wci.returnGid ====
  
 The wci.returnGid data type is a simple row type used for returning data to the user from the wci.read call. The following table describes the attributes that are returned from wci.returnGid; including the ordering of the attributes in the type. The wci.returnGid data type is a simple row type used for returning data to the user from the wci.read call. The following table describes the attributes that are returned from wci.returnGid; including the ordering of the attributes in the type.
- 
-**Table�5.13.�wci.returnGid** 
  
 ^ Order ^ Attribute ^ Description ^ ^ Order ^ Attribute ^ Description ^
Line 3193: Line 3019:
 \\ \\
  
-===== Chapter�6.�Examples ===== +===== Examples =====
- +
-You can find a number of examples using SQL, perl, java, and C++ in the source package of WDB, under the examples directory. +
- +
-===== Chapter�7.�Frequently Asked Questions =====+
  
-This page is for a list of frequently asked questions about WCI.+You can find a number of examples using SQL, perl, java, R-script and C++ in the source package of WDB, under the examples directory.
  
-===== Chapter�8.�Known Problems, Bugs, and Limitations =====+===== Frequently Asked Questions =====
  
-**Table of Contents**+This section is for a list of frequently asked questions about WCI.
  
-[[#id2902877|Limit of 100,000 rows returned by wci.read from a single grid]]+===== Known Problems, Bugs, and Limitations =====
  
 The following page describes some of the known problems and limitations of the WCI interface, and how to deal with them. The following page describes some of the known problems and limitations of the WCI interface, and how to deal with them.
  
-===== Limit of 100,000 rows returned by wci.read from a single grid =====+=== Limit of 100,000 rows returned by wci.read from a single grid ===
  
 The wci.read function is limited to returning no more than 100,000 rows from a single grid operation. If you need to retrieve a greater number of values from one grid in the database, you should use wci.fetch to retrieve the Grid object directly and perform the retrieval manually. The wci.read function is limited to returning no more than 100,000 rows from a single grid operation. If you need to retrieve a greater number of values from one grid in the database, you should use wci.fetch to retrieve the Grid object directly and perform the retrieval manually.
  
  • wdb/manuals/wdb_call_interface.1333544198.txt.gz
  • Last modified: 2022-05-31 09:23:29
  • (external edit)