/usr/lib/swipl/library/pengines.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl
      • socket.pl
      • predicate_options.pl
      • shlib.pl
      • option.pl
      • uid.pl
      • unix.pl
      • syslog.pl
      • thread_pool.pl
      • gensym.pl
      • settings.pl
      • arithmetic.pl
      • main.pl
      • readutil.pl
      • ssl.pl
      • crypto.pl
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
        • create_pool/1
        • pengine_create/1
        • pengine_ask/3
        • pengine_next/2
        • pengine_stop/2
        • pengine_abort/1
        • pengine_destroy/1
        • pengine_destroy/2
        • pengine_self/1
        • pengine_application/1
        • current_pengine_application/1
        • pengine_property/2
        • pengine_output/1
        • pengine_debug/2
        • pengine_done/0
        • prepare_module/3
        • prepare_goal/3
        • not_sandboxed/2
        • pengine_pull_response/2
        • pengine_input/2
        • pengine_respond/3
        • pengine_event_loop/2
        • pengine_rpc/2
        • pengine_rpc/3
        • prompt/3
        • output/2
        • portray_blob/2
        • write_result/3
        • add_error_details/3
        • event_to_json/3
        • authentication_hook/3
        • pengine_user/1
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • tables.pl -- XSB interface to tables
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • statistics.pl -- Get information about resource usage
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • when.pl -- Conditional coroutining
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • quintus.pl -- Quintus compatibility
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • doc_latex.pl -- PlDoc LaTeX backend
      • crypt.pl
      • thread.pl -- High level thread primitives
      • xmlenc.pl -- XML encryption library
      • help.pl -- Text based manual
      • writef.pl -- Old-style formatted write
      • sgml_write.pl -- XML/SGML writer module
      • explain.pl -- Describe Prolog Terms
      • threadutil.pl -- Interactive thread utilities
      • redis.pl -- Redis client
      • hashtable.pl -- Hash tables
      • prolog_debug.pl -- User level debugging tools
      • c14n2.pl -- C14n2 canonical XML documents
      • pwp.pl -- Prolog Well-formed Pages
      • streampool.pl -- Input multiplexing
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl -- Consistency checking
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • odbc.pl
      • stomp.pl -- STOMP client.
      • prolog_trace.pl -- Print access to predicates
      • optparse.pl -- command line parsing
      • macros.pl -- Macro expansion
      • rdf_parser.pl
      • rewrite_term.pl
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • doc_files.pl -- Create stand-alone documentation files
      • fastrw.pl -- Fast reading and writing of terms
      • make.pl -- Reload modified source files
      • system.pl -- System utilities
      • zip.pl -- Access resource ZIP archives
      • table.pl
      • prolog_profile.pl -- Execution profiler
      • shell.pl -- Elementary shell commands
      • test_cover.pl -- Clause coverage analysis
      • unicode.pl -- Unicode string handling
      • streams.pl -- Manage Prolog streams
      • redis_streams.pl -- Using Redis streams
      • increval.pl -- Incremental dynamic predicate modification
 pengine_ask(+NameOrID, @Query, +Options) is det
Asks pengine NameOrID a query Query.

Options is a list of options:

template(+Template)
Template is a variable (or a term containing variables) shared with the query. By default, the template is identical to the query.
chunk(+Integer)
Retrieve solutions in chunks of Integer rather than one by one. 1 means no chunking (default). Other integers indicate the maximum number of solutions to retrieve in one chunk.
bindings(+Bindings)
Sets the global variable '$variable_names' to a list of Name = Var terms, providing access to the actual variable names.

Any remaining options are passed to pengine_send/3.

Note that the predicate pengine_ask/3 is deterministic, even for queries that have more than one solution. Also, the variables in Query will not be bound. Instead, results will be returned in the form of event terms.

success(ID, Terms, Projection, Time, More)
ID is the id of the pengine that succeeded in solving the query. Terms is a list holding instantiations of Template. Projection is a list of variable names that should be displayed. Time is the CPU time used to produce the results and finally, More is either true or false, indicating whether we can expect the pengine to be able to return more solutions or not, would we call pengine_next/2.
failure(ID)
ID is the id of the pengine that failed for lack of a solutions.
error(ID, Term)
ID is the id of the pengine throwing the exception. Term is the exception's error term.
output(ID, Term)
ID is the id of a pengine running the query that called pengine_output/1. Term is the term that was passed in the first argument of pengine_output/1 when it was called.
prompt(ID, Term)
ID is the id of the pengine that called pengine_input/2 and Term is the prompt.

Defined in terms of pengine_send/3, like so:

pengine_ask(ID, Query, Options) :-
    partition(pengine_ask_option, Options, AskOptions, SendOptions),
    pengine_send(ID, ask(Query, AskOptions), SendOptions).