db_info

db_info(gpt, key[, column_name])

Returns metadata about the database retrieval which generated gpt.

Parameters

  • gpt (Geopoints) – input geopoints

  • key (str) – the metadata key

  • column_name (str) – name of the column if key is “column”

Return type

str or list of str

key specifies the piece of information to extract; possible values are:

  • “name”: the name of the database system, e.g. ODB

  • “path”: the path to the database

  • “query”: a list of str containing the multi-line data query

  • “column”: the name of the database column used to populate a given element of the geopoints. In this case column_name must be provided, naming the geopoints element of interest - possible values are “lat”, “lon”, “level”, “date”, “time”, “value” and “value”.

  • “alias”: similar to “column” above, but returns the name of the database alias used instead of the full column name

Note

This information is derived from the DB_INFO section (if it exists) in the geopoints file header. See Storing Data Origin Information in a Geopoints File.