...
Element | Description | Notes |
|---|---|---|
<short_descrip> | Short description |
|
<long_descrip> | Long description |
|
<sql> | SQL code used for the query | The expression "$db" will be substituted for the database being documented. Other expressions of the form %{text} will be substituted at run time by bioq_query.pl. Expression of the form ${var} according the variable assignments in the file specified in the --dbdoc-xml-var-file option to dbdoc_util.pl. |
<order_by> | SQL code used to sort the results | This will sort the results of the query rather than sort the entire source table prior to the query. If one actually includes an ORDER BY in the query code, then then entire source table will be sorted first. Do not use aliases here as shown in the example above. |
<where_cond> | The WHERE condition to use in the query. | Do NOT include the word "WHERE". It will be inserted. |
<column_map> | Indicates which columns in the query correspond to certain standard columns like snp_id. Example: snp_id:QTBL.snp_id (refers to alias QTBL). This is used, for example, in LD PROXY lookups. | Columns must be referred to using table names and/or aliases used in the query. This is a comma-separate list of <reference name>:<column name> values. The <column name> must include the alias used in the query, such as DBSNP.snp_id. |
...