imap_data_access.io.query

Query the data archive for files matching the parameters.

Before running the query it will be checked if a version ‘latest’ command was passed and that at least one other parameter was passed. After the query is run, if a ‘latest’ was passed then the query results will be filtered before being returned.

param table:

The desired table for the query to be performed against. Defaults to the science table.

type table:

str, optional

param instrument:

Instrument name (e.g. mag)

type instrument:

str, optional

param data_level:

Data level (e.g. l1a)

type data_level:

str, optional

param descriptor:

Descriptor of the data product / product name (e.g. burst)

type descriptor:

str, optional

param start_date:

Start date in YYYYMMDD format. Note this is to search for all files with start dates on or after this value.

type start_date:

str, optional

param end_date:

End date in YYYYMMDD format. Note this is to search for all files with start dates before the requested end_date.

type end_date:

str, optional

param ingestion_start_date:

Ingestion start date in YYYYMMDD format. Note this is to search for all files with ingestion start dates on or after this value.

type ingestion_start_date:

str, optional

param ingestion_end_date:

Ingestion end date in YYYYMMDD format. Note this is to search for all files with ingestion start dates before the requested end_date.

type ingestion_end_date:

str, optional

param repointing:

Repointing string, in the format ‘repoint00000’.

type repointing:

str, optional

param version:

Science data version in the format vMMM.mmmm (full) or the deprecated minor-only vXXX. latest returns the latest version of a file per dataset. For science files this is a convenience that maps to minor_version (and major_version for the full form); prefer major_version / minor_version for new code.

type version:

str, optional

param major_version:

Science major version to filter on. When omitted, science queries default to the latest major version (with all of its minor versions).

type major_version:

str or int, optional

param minor_version:

Science minor version to filter on.

type minor_version:

str or int, optional

param extension:

File extension (cdf, pkts)

type extension:

str, optional

returns:

List of files matching the query

rtype:

list