all-queries
FunctionDescription: Returns a list of (the IDs of) all queries Syntax: (all-queries)
Arguments:
all-rules
FunctionDescription: This is the rule equivalent ofall-queries, Page 117.
all-substrates
FunctionDescription: Returns a list of all substrates. A substrate is the internal (ABox) represen-tation that nRQL needs in order to answer queries. A substrate has a type and a corresponding Racer ABox. For each ABox and type there is at most one substrate
Syntax: (all-substrate) Arguments:
Values: A list of (abox type-of-substrate) entries, denoting the name of the substrate (which is identical to the name of the associated ABox) as well as the type of the substrate.
Remarks: .
See also: reset-all-substrates, Page 122,describe-all-substrates, Page 118
delete-all-substrates
FunctionDescription: Deletes all substrates Syntax: (delete-all-substrates) Arguments:
Values: :okay-all-substrates-deleted.
See also: reset-all-substrates, Page 122, reset-nrql-engine, Page 123, all-substrates, Page 117,describe-all-substrates, Page 118
describe-all-queries
FunctionDescription: Applies describe-query, Page 119 to the result of all-queries, Page 117 and returns it
Syntax: (describe-all-queries) Arguments: rewritten-p- t.
describe-all-rules
FunctionDescription: This is the rule equivalent ofdescribe-all-queries, Page 118.
describe-all-substrates
FunctionDescription: Mapsdescribe-substrate, Page 211overall-substrates, Page 117 Syntax: (describe-all-substrates)
Arguments:
Values: A list containing the results of describe-substrate, Page 211 applied to the substrates in all-substrates, Page 117.
Remarks: .
See also: describe-substrate, Page 211
describe-query
FunctionDescription: Returns a description of the query id
Syntax: (describe-query id &optional rewritten-p) Arguments: id - the ID of the query, or:last or:last-query.
rewritten-p- t.
Values: A list of three items: The query identify, the current status description (see describe-query-status, Page 119), and either the rewritten or original syntactic query.
Remarks: This function uses describe-query-status, Page 119, query-head, Page 122 (or original-query-head, Page 121) and query-body, Page 122 (or original-query-body, Page120) to create the description.
See also: describe-all-queries, Page 118
describe-query-status
FunctionDescription: Describes the current status of the queryid- whether the query is ready (to run), running, waiting (sleeping), or terminated
Syntax: (describe-query-status id)
Arguments: id - the ID of the query, or:last or:last-query.
Values: A list of status symbols describing the current status of the query.
See also: describe-all-queries, Page 118
describe-rule
FunctionDescription: This is the rule equivalent ofdescribe-all-queries, Page 118.
describe-rule-status
FunctionDescription: This is the rule equivalent ofdescribe-query-status, Page 119.
exit-server
FunctionDescription: Exists the current RacerPro server. Command only works if RacerPro is running in unsafe mode.
full-reset
FunctionDescription: Simply calls (reset-nrql-engine :full-reset-p t), see reset-nrql-engine, Page 123.
get-nrql-version
FunctionDescription: Returns the nRQL version number.
get-substrate-type
FunctionDescription: Returns the type (class) of the substrates that nRQL creates internally on request
Syntax: (get-substrate-type) Arguments:
Values: the type (class), a symbol.
See also: set-substrate-type, Page 124, describe-query-processing-mode, Page 183
in-unsafe-mode?
FunctionDescription: Check whether RacerPro is running in unsafe mode..
original-query-body
FunctionDescription: Like query-body, Page 122, but the original body is returned.
original-query-head
FunctionDescription: Like query-head, Page 122, but the original head is returned.
original-rule-antecedence
FunctionDescription: Likerule-antecedence, Page123, but the original antecedence is returned.
This is the rule equivalent oforiginal-query-body, Page120.
original-rule-consequence
FunctionDescription: Likerule-consequence, Page124, but the original consequence is returned.
This is the rule equivalent oforiginal-query-head, Page121.
prepare-nrql-engine
FunctionDescription: Prepares the internal index structures of the nRQL engine for query an-swering on the ABox argumentabox. Usually, there is no need to call this function. The function will be called automatically before the first query to argumentabox is executed. Thus, answering the first query to argumentabox might take considerably longer than subsequent queries to that ABox. For benchmarking purposes, the nRQL engine should thus be prepared using this function (or withprepare-racer-engine, Page83) before the first query is executed
Syntax: (prepare-nrql-engine abox &rest args) Arguments: abox - (current-abox).
args - seewith-nrql-settings, Page 199.
Values: The (name of the) ABox abox is returned.
See also: reset-nrql-engine, Page 123,prepare-racer-engine, Page 83
query-body
FunctionDescription: Returns the (possibly rewritten) body of the query id Syntax: (query-body id)
Arguments: id - the ID of the query, or:last or:last-query.
Values: The (possibly rewritten) body of the query.
See also: original-query-body, Page 120,query-head, Page122
query-head
FunctionDescription: Returns the (possibly rewritten) head of the query id Syntax: (query-head id)
Arguments: id - the ID of the query, or:last or:last-query.
Values: The (possibly rewritten) head of the query.
Remarks: Note that individuals in the original query head are usually yreplaced by representative variables.
See also: original-query-head, Page 121,query-body, Page122
reset-all-substrates
FunctionDescription: Resets all substrates Syntax: (reset-all-substrates) Arguments:
Values: :okay-all-substrates-reset.
Remarks: Does not delete anything from the server.
See also: delete-all-substrates, Page 118, reset-nrql-engine, Page 123, all-substrates, Page 117,describe-all-substrates, Page 118
reset-nrql-engine
FunctionDescription: Aborts all (active) queries and rules using abort-all-queries, Page 136, abort-all-rules, Page 136, then resets the internal caches of the nRQL engine using reset-all-substrates, Page 122), and finally calls restore-standard-settings, Page 194.
Iffull-reset-p=tis given, nRQL will delete all TBoxes (as well as the as-sociated ABoxes) usingdelete-all-tboxes, Page??), delete all the queries and rules using delete-all-queries, Page 125, delete-all-rules, Page 126, deletes all substrates (as well as the associated QBoxes) and associated defined queries
Syntax: (reset-nrql-engine &key full-reset-p)
Arguments: full-reset-p, defaultnil - pass t if you really want to reset the nRQL engine fully - note that this will delete everything from the RacerPro server.
Values: :okay-full-reset or:okay-engine-reset.
See also: reset-nrql-engine, Page 123,restore-standard-settings, Page 194
rule-antecedence
FunctionDescription: Returns the (possibly rewritten) antecedence of the rule id This is the rule equivalent of query-body, Page122.
Syntax: (rule-antecedence id)
Arguments: id - the ID of the rule, or:lastor:last-rule.
Values: The (possibly rewritten) antecedence of the rule.
See also: Rule equivalent of query-body, Page 122. original-rule-antecedence, Page 121,rule-consequence, Page 124
rule-consequence
FunctionDescription: Returns the (possibly rewritten) rule consequence of the rule idThis is the rule equivalent ofquery-head, Page 122.
Syntax: (rule-consequence id)
Arguments: (first id the ID of the rule, or :last or :last-rule) - nil.
Values: The (possibly rewritten) consequence of the rule.
See also: Rule equivalent of query-head, Page 122. original-rule-consequence, Page 121,rule-antecedence, Page 123
set-substrate-type
FunctionDescription: Determines the type (class) of the substrates that nRQL creates internally on request
Syntax: (set-substrate-type type-of-substrate)
Arguments: type-of-substrate - a substrate type (class), one of:
data-substrate, mirror-data-substrate, rcc-substrate, rcc-mirror-substrate.
Values: :okay or:ignored.
See also: get-substrate-type, Page 120, describe-query-processing-mode, Page 183