Programmer Guide/Command Reference/QUERY: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import) |
No edit summary |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
The <code>QUERY</code> command, although similar to the <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code> command, offers the programmer more choice in how to search. It returns the zero-based index of the first entry matching the search criteria, or an empty string if the search criteria were not matched. | |||
#pos := QUERY [ /i ] [ /t ] [ /m=<var>matchtype</var> ] [[Programmer_Guide/Command_Reference_Options/-|/-]] <var>table</var> <var>startentry</var> <var>field</var> <var>querystring</var> | |||
#pos := QUERY /m=find <var>table</var> <var>startentry</var> <var>cepr</var> [ <var>copr</var> <var>cexpr</var> ... ] [ /t ] // works like <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FINDEXPR|SET table FIND]]</code> | |||
;<var>matchtype</var>: one of the keywords <code>regular</code>, <code>wildcard</code>, <code>substring</code>, <code>full</code>, and <code>find</code>. | |||
;<var>matchtype</var> | |||
: | |||
;<var>table</var>: the table to search. | |||
;<var>startentry</var>: the zero-based index of the entry at with which to start the search. | |||
;<var>field</var>: the table field to search. | |||
;<var>querystring</var>: the string to search for. | |||
;<var>cexpr</var>, <var>copr</var> <var>cexpr</var>: see <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FINDEXPR|SET table FIND]]</code>. | |||
;<code>/i</code>: The search will be case insensitive (by default, it is case sensitive). | |||
;<code>/t</code>: only tagged table entries will be considered. | |||
;<code>/m=regular</code> | |||
:<var>querystring</var> will be considered a POSIX regular expression. | :<var>querystring</var> will be considered a POSIX regular expression. | ||
;<code>/m=wildcard</code> | |||
;< | :<var>querystring</var> will be considered an {{STX}} wildcard expression (just like <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code>). | ||
;<code>/m=substring</code>: All characters in <var>querystring</var> will be considered autonomous, i.e. naming themselves. The <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code> command will find the first entry of which <var>querystring</var> is a substring. | |||
:<var>querystring</var> will be considered an | ;<code>/m=full</code>:All characters in <var>querystring</var> will be considered autonomous, i.e. naming themselves. The <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code> command will find the first entry whose content is exactly identical to <var>querystring</var> (with the possible exception of case). | ||
;<code>[[Programmer_Guide/Command_Reference_Options/-|/-]]</code>: You should always use the [[Programmer_Guide/Command_Reference_Options/-|/-]] "non-option" option before the first argument in order not to cause arguments to be mistaken for options. | |||
;< | |||
:All characters in <var>querystring</var> will be considered autonomous, i.e. naming themselves. The <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code> command will find the first entry of which <var>querystring</var> is a substring. | |||
;< | |||
:All characters in <var>querystring</var> will be considered autonomous, i.e. naming themselves. The <code>[[Programmer Guide/Command Reference/FIND|FIND]]</code> command will find the first entry whose content is exactly identical to <var>querystring</var> (with the possible exception of case). | |||
;< | |||
:You should always use the /- "non-option" option before the first argument in order not to cause arguments to be mistaken for options. | |||
Latest revision as of 11:47, 16 May 2018
The QUERY command, although similar to the FIND command, offers the programmer more choice in how to search. It returns the zero-based index of the first entry matching the search criteria, or an empty string if the search criteria were not matched.
#pos := QUERY [ /i ] [ /t ] [ /m=matchtype ] /- table startentry field querystring
#pos := QUERY /m=find table startentry cepr [ copr cexpr ... ] [ /t ] // works like SET table FIND
- matchtype
- one of the keywords
regular,wildcard,substring,full, andfind.
- table
- the table to search.
- startentry
- the zero-based index of the entry at with which to start the search.
- field
- the table field to search.
- querystring
- the string to search for.
- cexpr, copr cexpr
- see
SET table FIND. /i- The search will be case insensitive (by default, it is case sensitive).
/t- only tagged table entries will be considered.
/m=regular- querystring will be considered a POSIX regular expression.
/m=wildcard- querystring will be considered an STx wildcard expression (just like
FIND). /m=substring- All characters in querystring will be considered autonomous, i.e. naming themselves. The
FINDcommand will find the first entry of which querystring is a substring. /m=full- All characters in querystring will be considered autonomous, i.e. naming themselves. The
FINDcommand will find the first entry whose content is exactly identical to querystring (with the possible exception of case). /-- You should always use the /- "non-option" option before the first argument in order not to cause arguments to be mistaken for options.
