A datatype describing the details of each database available to search against. More...

#include <blast_service.h>

Data Fields
const char *	di_name_s
	The name of the database to display to the user. More...

const char *	di_filename_s
	The filename for the database. More...

const char *	di_description_s
	The description of the database to display to the user. More...

const char *	di_search_description_s
	The description to use for indexing in the Grassroots search service. More...

const char *	di_download_uri_s
	The URI to download any associated resources for this database. More...

const char *	di_info_uri_s
	The URI to for any supplementary information about the database. More...

bool	di_active_flag
	Sets whether the database defaults to being searched against or not. More...

DatabaseType	di_type
	The DatabaseType for this database. More...

const char *	di_scaffold_key_s
	The key used to get the scaffold name for any hits from BLAST searches from within the "BlastOutput2.report.results.search.hits.description" field of the search result in single file JSON format. More...

const char *	di_scaffold_regex_s
	The regular expression used to get the scaffold name for the value associated with the value retrieved from di_scaffold_key_s. More...

Detailed Description

A datatype describing the details of each database available to search against.

Field Documentation

◆ di_name_s

const char* di_name_s

The name of the database to display to the user.

◆ di_filename_s

const char* di_filename_s

The filename for the database.

◆ di_description_s

const char* di_description_s

The description of the database to display to the user.

◆ di_search_description_s

const char* di_search_description_s

The description to use for indexing in the Grassroots search service.

◆ di_download_uri_s

const char* di_download_uri_s

The URI to download any associated resources for this database.

◆ di_info_uri_s

const char* di_info_uri_s

The URI to for any supplementary information about the database.

◆ di_active_flag

bool di_active_flag

Sets whether the database defaults to being searched against or not.

◆ di_type

DatabaseType di_type

The DatabaseType for this database.

◆ di_scaffold_key_s

const char* di_scaffold_key_s

The key used to get the scaffold name for any hits from BLAST searches from within the "BlastOutput2.report.results.search.hits.description" field of the search result in single file JSON format.

This defaults to "id".

◆ di_scaffold_regex_s

const char* di_scaffold_regex_s

The regular expression used to get the scaffold name for the value associated with the value retrieved from di_scaffold_key_s.

This defaults to NULL which means to treat the entire value as the scaffold name.

The documentation for this struct was generated from the following file:

blast_service.h

Data Fields