TSTool / Datastore Reference / Overview
Introduction
This reference section of the documentation provides information about datastores:
- databases - must be accessible via ODBC/JDBC connection
- file databases - typically optimized for a use, such as HEC-DSS used with Army Corps and other software
- files - simple files, including model files such as the State of Colorado's StateMod model
- web services - SOAP and REST web services
A "datastore" is a data management component that saves time series and other data. TSTool originally used the term "input type" for some formats such as data files and HydroBase database. However, the newer "datastore" design has since been implemented to provide more flexibility in configuring data access. Newer databases and web services are treated as "datastores", whereas older files are treated as "input types". The "input type" notation is retained in the software, pending migration to datastores - datastores and input types can be selected in the TSTool interface when browsing data. A software design goal is to move all input types to "file datastores" so that terminology is consistent.
Time series, tables, and other data objects can be read from datastores using Read commands.
Some datastores can also be written to, using Write commands.
Datastores containing time series have general characteristics that can be handled with general software features.
For example time series identifier commands (TSIDs) are used to uniquely identify time series in
a datastore and result in an automatic data read from the datastore.
However, some datastores have specific characteristics that are difficult to support in a general way,
in which case Read command parameters or datastore configuration properties are used to control software behavior.
Datastore List
The following datastores (and input types) are listed in alphabetical order by datastore name.
| Datastore (link to documentation) | Technology | Spatial Extent | Contents | Documentation Status |
|---|---|---|---|---|
| ColoradoHydroBaseRest | Web service (REST) | Colorado | Historical and real-time data | New - in process |
| Colorado SMS (legacy) OBSOLETE |
Database (SQL Server) | Colorado | Real-time data | not yet migrated - no longer used |
| ColoradoWaterHBGuest OBSOLETE |
Web service (SOAP) | Colorado | Historical data | Migrated |
| ColoradoWaterSMS OBSOLETE |
Web service (SOAP) | Colorado | Real-time data | Migrated |
| DateValue | File (text) | No limit | General time series format | Migrated |
| Delft FEWS PI XML | File (text) | No limit | Delft FEWS software file | Migrated |
| GenericDatabase | Database (any ODBC) | No limit | Any SQL database | Migrated |
| HEC-DSS File | File database (binary) | No limit | General time series database | Migrated |
| HydroBase | Database (SQL Server) | Colorado | Colorado water resources (datastore version) | Migrated |
| HydroBase (legacy) | Database (SQL Server) | Colorado | Colorado water resources (input type version) | Use HydroBase datastore documentation. |
| HydroJSON | File (text) | No limit | HydroJSON time series format | Migrated |
| MODSIM | File (text) | No limit | MODSIM modeling software data file | Migrated |
| NRCS AWDB | Web service (SOAP) | USA | Snow, reservoir, climate, other | Migrated |
| NDFD | File (text) | No limit | National Digital Forecast Database. | not yet migrated (placeholder) |
| NWS Card OBSOLETE |
File (text) | No limit | General time series format (hour interval) | not yet migrated - being phased out |
| NWSRFS ESP Ensemble OBSOLETE |
File (binary) | No limit | Ensembles of time series (hour interval) | not yet migrated - being phased out |
| NWSRFS FS5Files OBSOLETE |
File database (binary) | No limit | National Weather Service River Forecast System | not yet migrated - being phased out |
| RCC ACIS | Web service (REST) | USA | Precipitation, temperature, other climate | Migrated |
| Reclamation HDB | Database (Oracle) | USA | Water resources | Migrated |
| Reclamation Pisces | Database (MySQL) | USA | Water resources | Migrated |
| RiversideDB | Database (SQL Server) | No limit | Hydrologic modeling database. | Has been removed from TSTool as of version 13 |
| RiverWare | File (text) | No limit | RiverWare modeling software data file | Migrated |
| StateCU | File (text) | No limit | StateCU modeling software data file | Migrated |
| StateCUB - StateCU Output | File (binary) | No limit | StateCU modeling software data file | Migrated |
| StateMod | File (text) | No limit | StateMod modeling software data file | Migrated |
| StateModB - StateMod Output | File (binary) | No limit | StateMod modeling software data file | Migrated |
| USGS NWIS Daily | Web service (REST) | No limit | Water and other data (day interval) | Migrated |
| USGS NWIS Groundwater | Web service (REST) | No limit | Groundwater and other data | Migrated |
| USGS NWIS Instantaneous | Web service (REST) | No limit | Water and other data (instantaneous interval) | Migrated |
| USGS NWIS RDB | File (text) | No limit | RDB format for USGS data (see USGS above) | Migrated |
| WaterML | File (text) | No limit | WaterML format for USGS data (see USGS above) | not yet migrated (placeholder) |
| WaterML2 | File (text) | No limit | WaterML format for USGS data (see USGS above) | not yet migrated (placeholder) |
| WaterOneFlow | Web service (SOAP) | No limit | Web service for CUAHSI | not yet migrated |
Datastore Configuration
Datastores are configured using datastore configuration files, which are described in the specific appendix.
The system/TSTool.cfg file located in the software installation folder provides properties to enable/disable
datastores globally, which turns off software features (such as Commands menu for commands
related to the datastore).
A similar file can be created in the users's .tstool/NN/system folder to configure TSTool for each major version.
Built-in (default) datastore configuration files are located in the software installation system folder.
User datastore configuration files are located in the .tstool/NN/datastores folder.
The user configuration files override the installation configuration files.
For example, a datastore configuration file for datastore named abc will take precedence over
a built-in datastore that is also named abc.
This allows, for example, providing a more specific configuration for:
- database version for HydroBase datastore database installed on user's computer
- API key for ColoradoHydroBaseRest web services for the specific user
Use the View / Datastores menu in TSTool to view datastores that are enabled.
Use the Tools / Options menu in TSTool to change TSTool configuration. If necessary, edit configuration files with a text editor.