• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

/home/swipl/lib/swipl/library/redis.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl -- Error generating support
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl -- Event service
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • uid.pl
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • filesex.pl -- Extended operations on files
      • doc_http.pl -- Documentation server
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • uri.pl -- Process URIs
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl -- Prolog syntax colouring support.
      • record.pl -- Access compound arguments by name
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl -- Ordered set manipulation
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • memfile.pl
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • atom.pl -- Operations on atoms
      • porter_stem.pl
      • solution_sequences.pl -- Modify solution sequences
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • process.pl -- Create processes and redirect I/O
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • time.pl -- Time and alarm library
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • sha.pl -- SHA secure hashes
      • crypt.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl -- Non-backtrackable sets
      • xsdp_types.pl -- XML-Schema primitive types
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rdf.pl -- RDF/XML parser
      • sgml_write.pl -- XML/SGML writer module
      • archive.pl -- Access several archive formats
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dialect.pl -- Support multiple Prolog dialects
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • rbtrees.pl -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • yall.pl -- Lambda expressions
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • random.pl -- Random numbers
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • 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
      • pprint.pl -- Pretty Print Prolog terms
      • modules.pl -- Module utility predicates
      • lazy_lists.pl -- Lazy list handling
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl -- Dict utilities
      • backcomp.pl -- Backward compatibility
      • paxos.pl -- A Replicated Data Store
      • doc_latex.pl -- PlDoc LaTeX backend
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • prolog_debug.pl -- User level debugging tools
      • streampool.pl -- Input multiplexing
      • stomp.pl -- STOMP client.
      • date.pl -- Process dates and times
      • statistics.pl -- Get information about resource usage
      • listing.pl -- List programs and pretty print clauses
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • unicode.pl -- Unicode string handling
      • heaps.pl -- heaps/priority queues
      • files.pl
      • optparse.pl -- command line parsing
      • threadutil.pl -- Interactive thread utilities
      • edit.pl -- Editor interface
      • help.pl -- Text based manual
      • fastrw.pl -- Fast reading and writing of terms
      • redis.pl -- Redis client
        • redis_server/3
        • redis_connect/1
        • redis_connect/3
        • redis_disconnect/1
        • redis_disconnect/2
        • redis/2
        • redis/3
        • redis/1
        • redis_write/2
        • redis_read/2
        • redis_get_list/3
        • redis_get_list/4
        • redis_set_list/3
        • redis_get_hash/3
        • redis_set_hash/3
        • redis_array_dict/3
        • redis_scan/3
        • redis_sscan/4
        • redis_hscan/4
        • redis_zscan/4
        • redis_current_command/2
        • redis_current_command/3
        • redis_property/2
        • redis_subscribe/4
        • redis_subscribe/2
        • redis_unsubscribe/2
        • redis_current_subscription/2
      • prolog_stack.pl -- Examine the Prolog stack
      • editline.pl -- BSD libedit based command line editing
      • odbc.pl
      • jpl.pl -- A Java interface for SWI Prolog 7.x
      • zip.pl -- Access resource ZIP archives
      • hashtable.pl -- Hash tables
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • isub.pl -- isub: a string similarity measure
      • terms.pl -- Term manipulation
      • check.pl -- Consistency checking
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_autoload.pl -- Autoload all dependencies
      • shell.pl -- Elementary shell commands
      • wfs.pl -- Well Founded Semantics interface
      • portray_text.pl -- Portray text
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • strings.pl -- String utilities
      • plunit.pl -- Unit Testing
      • xmlenc.pl -- XML encryption library
      • prolog_metainference.pl -- Infer meta-predicate properties
      • c14n2.pl -- C14n2 canonical XML documents
      • charsio.pl -- I/O on Lists of Character Codes
      • make.pl -- Reload modified source files
      • writef.pl -- Old-style formatted write
      • qsave.pl -- Save current program as a state or executable
      • sort.pl
      • tables.pl -- XSB interface to tables
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl -- Conditional coroutining
      • intercept.pl -- Intercept and signal interface
      • term_to_json.pl
      • mqi.pl
      • increval.pl -- Incremental dynamic predicate modification
      • explain.pl -- Describe Prolog Terms
      • prolog_wrap.pl -- Wrapping predicates
      • win_menu.pl -- Console window menu
      • tty.pl -- Terminal operations
      • test_cover.pl -- Clause coverage analysis
      • table.pl
      • udp_broadcast.pl -- A UDP broadcast proxy
      • xmldsig.pl -- XML Digital signature
      • redis_streams.pl -- Using Redis streams
      • yaml.pl -- Process YAML data
      • prolog_trace.pl -- Print access to predicates
      • prolog_stream.pl -- A stream with Prolog callbacks
      • base32.pl -- Base32 encoding and decoding
      • doc_files.pl -- Create stand-alone documentation files
      • prolog_history.pl -- Per-directory persistent commandline history
      • readline.pl -- GNU readline interface
      • coinduction.pl -- Co-Logic Programming
      • codesio.pl -- I/O on Lists of Character Codes
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • rlimit.pl
      • double_metaphone.pl -- Phonetic string matching
      • oset.pl -- Ordered set manipulation
      • cgi.pl -- Read CGI parameters
      • pdt_console.pl
      • pwp.pl -- Prolog Well-formed Pages
 redis(+Connection, +Command, -Reply) is semidet
Execute a redis Command on Connnection. Next, bind Reply to the returned result. Command is a callable term whose functor is the name of the Redis command and whose arguments are translated to Redis arguments according to the rules below. Note that all text is always represented using UTF-8 encoding.
  • Atomic values are emitted verbatim
  • A term A:B:... where all arguments are either atoms, strings or integers (no floats) is translated into a string "A:B:...". This is a common shorthand for representing Redis keys.
  • A term Term as prolog is emitted as "\u0000T\u0000" followed by Term in canonical form.
  • Any other term is emitted as write/1.

Reply is either a plain term (often a variable) or a term Value as Type. In the latter form, Type dictates how the Redis bulk reply is translated to Prolog. The default equals to auto, i.e., as a number of the content satisfies the Prolog number syntax and as an atom otherwise.

  • status(Atom) Returned if the server replies with + Status. Atom is the textual value of Status converted to lower case, e.g., status(ok) or status(pong).
  • nil This atom is returned for a NIL/NULL value. Note that if the reply is only nil, redis/3 fails. The nil value may be embedded inside lists or maps.
  • A number Returned if the server replies an integer (":Int"), double (",Num") or big integer ("(Num")
  • A string Returned on a bulk reply. Bulk replies are supposed to be in UTF-8 encoding. The the bulk reply starts with "\u0000T\u0000" it is supposed to be a Prolog term. Note that this intepretation means it is not possible to read arbitrary binary blobs.
  • A list of replies. A list may also contain nil. If Reply as a whole would be nil the call fails.
  • A list of pairs. This is returned for the redis version 3 protocol "%Map". Both the key and value respect the same rules as above.

Redis bulk replies are translated depending on the as Type as explained above.

string
string(Encoding)
Create a SWI-Prolog string object interpreting the blob as following Encoding. Encoding is a restricted set of SWI-Prolog's encodings: bytes (iso_latin_1), utf8 and text (the current locale translation).
atom
atom(Encoding)
As above, producing an atom.
codes
codes(Encoding)
As above, producing a list of integers (Unicode code points)
chars
chars(Encoding)
As above, producing a list of one-character atoms.
integer
float
rational
number
Interpret the bytes as a string representing a number. If the string does not represent a number of the requested type a type_error(Type, String) is raised.
tagged_integer
Same as integer, but demands the value to be between the Prolog flags min_tagged_integer and max_tagged_integer, allowing the value to be used as a dict key.
auto
Same as auto(atom, number)
auto(AsText, AsNumber)
If the bulk string confirms the syntax of AsNumber, convert the value to the requested numberical type. Else convert the value to text according to AsText. This is similar to the Prolog predicate name/2.
dict_key
Alias for auto(atom,tagged_integer). This allows the value to be used as a key for a SWI-Prolog dict.
pairs(AsKey, AsValue)
Convert a map or array of even length into pairs for which the key satisfies AsKey and the value AsValue. The pairs type can also be applied to a Redis array. In this case the array length must be even. This notably allows fetching a Redis hash as pairs using HGETALL using version 2 of the Redis protocol.
dict(AsKey, AsValue)
Similar to pairs(AsKey, AsValue), but convert the resulting pair list into a SWI-Prolog dict. AsKey must convert to a valid dict key, i.e., an atom or tagged integer. See dict_key.
dict(AsValue)
Shorthand for dict(dict_key, AsValue).

Here are some simple examples

?- redis(default, set(a, 42), X).
X = status("OK").
?- redis(default, get(a), X).
X = "42".
?- redis(default, get(a), X as integer).
X = 42.
?- redis(default, get(a), X as float).
X = 42.0.
?- redis(default, set(swipl:version, 8)).
true.
?- redis(default, incr(swipl:version), X).
X = 9.
Errors
- redis_error(Code, String)
ClioPatria (version V3.1.1-42-gd6a756b-DIRTY)