The cqlcl Reference Manual

Table of Contents

The cqlcl Reference Manual

This is the cqlcl Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:04:21 2019 GMT+0.

1 Introduction

CQLCL

A Common Lisp client to Cassandra using the native protocol (V2)

Installation

QuickLisp is probably the most sane way to install CL libraries. Ensure you have this set up and working.

cd $QUICKLISP_HOME/local-projects
git clone https://github.com/AeroNotix/cqlcl.git
sbcl --eval "(ql:quickload :cqlcl)"

This will install all required dependencies.

API

(defparameter *cxn* (cqlcl:make-connection))
(let ((create-keyspace "CREATE KEYSPACE cqlcl
                        WITH replication = {
                            'class': 'SimpleStrategy', 'replication_factor': '1'
                        }"))
  (query *cxn* create-keyspace))
;; T
;; "CREATED: cqlcl."
(let ((create-table "CREATE TABLE cqlcl.readme (
                         id uuid PRIMARY KEY,
                         name text,
                         value int
                     )"))
    (query *cxn* create-table))
;; T
;; "CREATED: cqlcl.readme

(query *cxn* "SELECT * FROM cqlcl.readme")
;; NIL

(prepare *cxn* "INSERT INTO cqlcl.readme (id, name, value) VALUES(?, ?, ?)")
;; No value

(execute *cxn* "INSERT INTO cqlcl.readme (id, name, value) VALUES(?, ?, ?)"
    (uuid:make-v4-uuid) "HELLO" 123)
;; No value
(execute *cxn* "INSERT INTO cqlcl.readme (id, name, value) VALUES(?, ?, ?)"
    (uuid:make-v4-uuid) "HELLO" 123)
;; No value
(execute *cxn* "INSERT INTO cqlcl.readme (id, name, value) VALUES(?, ?, ?)"
    (uuid:make-v4-uuid) "HELLO" 123)
;; No value

(query *cxn* "SELECT * FROM cqlcl.readme")

((B16805B2-FDA8-4DF5-811B-77F46FFE2BBB "HELLO" 123)
 (DF0922E4-BB82-4C59-A32C-CBFD859CC3AD "HELLO" 123)
 (43B0683F-8372-4BFC-B2CB-93706360A2D7 "HELLO" 123))

Type mappings

| Cassandra type | CL type | |:--------------------- |:------- | | ascii | string | | bigint | integer | | blob | byte-vector | | boolean | boolean | | counter | not implemented | | decimal | float | | double | float | | float | float | | inet | cqlcl:ip | | int | integer | | timestamp | integer | | timeuuid | uuid:uuid | | uuid | uuid:uuid | | varchar/text | string | | varint | not implemented | | list | list | | set | list | | map | hashtbale | | custom | not implemented |

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cqlcl

Author

Aaron France

License

BSD

Description

CQLv2 binary protocol

Version

0.0.1

Defsystem Dependency

fiveam

Dependencies

• pooler
• alexandria
• flexi-streams
• uuid
• split-sequence
• bordeaux-threads
• lparallel
• usocket

Source

cqlcl.asd (file)

Components

• package.lisp (file)
• util.lisp (file)
• constants.lisp (file)
• types.lisp (file)
• headers.lisp (file)
• protocol.lisp (file)
• conn.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cqlcl.asd

Location

cqlcl.asd

Systems

cqlcl (system)

3.1.2 cqlcl/package.lisp

Parent

cqlcl (system)

Location

package.lisp

Packages

cqlcl

3.1.3 cqlcl/util.lisp

Dependency

package.lisp (file)

Parent

cqlcl (system)

Location

util.lisp

Exported Definitions

make-stream-from-byte-vector (function)

Internal Definitions

• drain-stream (function)
• empty? (function)
• juxt (function)
• rev-hash (macro)
• while (macro)

3.1.4 cqlcl/constants.lisp

Dependency

util.lisp (file)

Parent

cqlcl (system)

Location

constants.lisp

Exported Definitions

• +consistency-digit-to-name+ (special variable)
• +consistency-name-to-digit+ (special variable)

Internal Definitions

• +default-version+ (special variable)
• +error-codes+ (special variable)
• +global-tables-spec+ (special variable)
• +has-more-pages+ (special variable)
• +header-length+ (special variable)
• +message-types+ (special variable)
• +no-meta-data+ (special variable)
• +op-code-digit-to-name+ (special variable)
• +op-code-name-to-digit+ (special variable)
• +option-id+ (special variable)
• +packet-type-index+ (special variable)
• +request+ (special variable)
• +response+ (special variable)
• +result-type+ (special variable)

3.1.5 cqlcl/types.lisp

Dependency

constants.lisp (file)

Parent

cqlcl (system)

Location

types.lisp

Exported Definitions

• ip= (function)
• make-bigint (function)
• make-ipv4 (function)
• make-ipv6 (function)
• make-varint (function)
• write-int (function)
• write-short (function)

Internal Definitions

• addr (method)
• (setf addr) (method)
• addr (method)
• (setf addr) (method)
• anumber (class)
• bigint (class)
• byte-array-to-ip (function)
• byte-array-to-ipv4 (function)
• byte-array-to-ipv6 (function)
• bytes-to-integer (function)
• define-binary-write (macro)
• ip (class)
• ip-to-byte-array (generic function)
• ip-to-byte-array (method)
• ip-to-byte-array (method)
• ip-to-integer (generic function)
• ip-to-integer (method)
• ip-to-integer (method)
• ipv4 (class)
• ipv6 (class)
• make-in-memory-output-stream (function)
• min-bytes (function)
• parse-ip-from-string (function)
• read-bigint (function)
• read-int (function)
• read-ipv6 (function)
• read-octet (function)
• read-short (function)
• read-sized (function)
• val (method)
• (setf val) (method)
• varint (class)
• write-bigint (function)
• write-ipv6 (function)
• write-octet (function)
• write-sized (function)

3.1.6 cqlcl/headers.lisp

Dependency

types.lisp (file)

Parent

cqlcl (system)

Location

headers.lisp

Exported Definitions

• msg (method)
• (setf msg) (method)

Internal Definitions

• body (method)
• (setf body) (method)
• code (method)
• (setf code) (method)
• compression (method)
• (setf compression) (method)
• consistency (method)
• (setf consistency) (method)
• cql-vsn (method)
• (setf cql-vsn) (method)
• cs (method)
• (setf cs) (method)
• error-response (class)
• execute-header (class)
• extra (method)
• (setf extra) (method)
• header (class)
• id (method)
• (setf id) (method)
• op (method)
• (setf op) (method)
• options-header (class)
• opts (method)
• (setf opts) (method)
• parse-already-exists (function)
• parse-colspec (function)
• parse-colspecs (function)
• parse-error-packet (function)
• parse-header (function)
• parse-metadata (function)
• parse-prepared (function)
• parse-read-timeout (function)
• parse-result-packet (function)
• parse-row (function)
• parse-rows (function)
• parse-rows* (function)
• parse-schema-change (function)
• parse-set-keyspace (function)
• parse-supported-packet (function)
• parse-unavailable-exception (function)
• parse-write-timeout (function)
• prepare-header (class)
• prepared-query (class)
• ps (method)
• (setf ps) (method)
• ptype (method)
• (setf ptype) (method)
• qid (method)
• (setf qid) (method)
• qid (method)
• (setf qid) (method)
• qs (method)
• (setf qs) (method)
• qs (method)
• (setf qs) (method)
• query-header (class)
• row-flag-set? (function)
• startup-header (class)
• tracing (method)
• (setf tracing) (method)
• vals (method)
• (setf vals) (method)
• vsn (method)
• (setf vsn) (method)

3.1.7 cqlcl/protocol.lisp

Dependency

headers.lisp (file)

Parent

cqlcl (system)

Location

protocol.lisp

Exported Definitions

• encode-value (generic function)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• parse-boolean (function)
• parse-bytes (function)
• parse-consistency (function)
• parse-int (function)
• parse-ip (function)
• parse-short (function)
• parse-short-bytes (function)
• parse-string (function)
• parse-string-map (function)
• parse-uuid (function)

Internal Definitions

• *executing* (special variable)
• *unread-size* (special variable)
• *write-short-lengths* (special variable)
• *write-wide-lengths* (special variable)
• +option-id-to-parser+ (special variable)
• as-bytes (function)
• as-flags (macro)
• as-string (function)
• encode-values (function)
• make-parse-coll (function)
• make-parse-map (function)
• not-implemented (function)
• parse-bigint (function)
• parse-bytes* (function)
• parse-map (function)
• parse-option (function)
• parse-option-list (function)
• parse-string-list (function)
• parse-string-multimap (function)
• parse-timestamp (function)
• parse-varint (function)
• write-length (function)

3.1.8 cqlcl/conn.lisp

Dependency

protocol.lisp (file)

Parent

cqlcl (system)

Location

conn.lisp

Exported Definitions

• conn-options (method)
• (setf conn-options) (method)
• execute (generic function)
• execute (method)
• make-connection (function)
• next-stream-id (generic function)
• next-stream-id (method)
• options (generic function)
• options (method)
• prepare (generic function)
• prepare (method)
• query (generic function)
• query (method)
• read-single-packet (generic function)
• read-single-packet (method)
• return-stream-id (generic function)
• return-stream-id (method)
• used-streams (method)
• (setf used-streams) (method)
• with-next-stream-id (macro)

Internal Definitions

• async-connection (class)
• conn (method)
• (setf conn) (method)
• connection (class)
• mutex (method)
• (setf mutex) (method)
• next-stream-id* (function)
• pending-queries (method)
• (setf pending-queries) (method)
• pqs (method)
• (setf pqs) (method)
• startup (generic function)
• startup (method)

4 Packages

Packages are listed by definition order.

4.1 cqlcl

Source

package.lisp (file)

Use List

• bordeaux-threads
• lparallel
• split-sequence
• uuid
• common-lisp

Exported Definitions

• +consistency-digit-to-name+ (special variable)
• +consistency-name-to-digit+ (special variable)
• conn-options (generic function)
• conn-options (method)
• (setf conn-options) (method)
• (setf conn-options) (generic function)
• encode-value (generic function)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• encode-value (method)
• execute (generic function)
• execute (method)
• ip= (function)
• make-bigint (function)
• make-connection (function)
• make-ipv4 (function)
• make-ipv6 (function)
• make-stream-from-byte-vector (function)
• make-varint (function)
• msg (generic function)
• msg (method)
• (setf msg) (method)
• (setf msg) (generic function)
• next-stream-id (generic function)
• next-stream-id (method)
• options (generic function)
• options (method)
• parse-boolean (function)
• parse-bytes (function)
• parse-consistency (function)
• parse-int (function)
• parse-ip (function)
• parse-short (function)
• parse-short-bytes (function)
• parse-string (function)
• parse-string-map (function)
• parse-uuid (function)
• prepare (generic function)
• prepare (method)
• query (generic function)
• query (method)
• read-single-packet (generic function)
• read-single-packet (method)
• return-stream-id (generic function)
• return-stream-id (method)
• used-streams (generic function)
• used-streams (method)
• (setf used-streams) (method)
• (setf used-streams) (generic function)
• with-next-stream-id (macro)
• write-int (function)
• write-short (function)

Internal Definitions

• *executing* (special variable)
• *unread-size* (special variable)
• *write-short-lengths* (special variable)
• *write-wide-lengths* (special variable)
• +default-version+ (special variable)
• +error-codes+ (special variable)
• +global-tables-spec+ (special variable)
• +has-more-pages+ (special variable)
• +header-length+ (special variable)
• +message-types+ (special variable)
• +no-meta-data+ (special variable)
• +op-code-digit-to-name+ (special variable)
• +op-code-name-to-digit+ (special variable)
• +option-id+ (special variable)
• +option-id-to-parser+ (special variable)
• +packet-type-index+ (special variable)
• +request+ (special variable)
• +response+ (special variable)
• +result-type+ (special variable)
• addr (generic function)
• addr (method)
• (setf addr) (method)
• addr (method)
• (setf addr) (method)
• (setf addr) (generic function)
• anumber (class)
• as-bytes (function)
• as-flags (macro)
• as-string (function)
• async-connection (class)
• bigint (class)
• body (generic function)
• body (method)
• (setf body) (method)
• (setf body) (generic function)
• byte-array-to-ip (function)
• byte-array-to-ipv4 (function)
• byte-array-to-ipv6 (function)
• bytes-to-integer (function)
• code (generic function)
• code (method)
• (setf code) (method)
• (setf code) (generic function)
• compression (generic function)
• compression (method)
• (setf compression) (method)
• (setf compression) (generic function)
• conn (generic function)
• conn (method)
• (setf conn) (method)
• (setf conn) (generic function)
• connection (class)
• consistency (generic function)
• consistency (method)
• (setf consistency) (method)
• (setf consistency) (generic function)
• cql-vsn (generic function)
• cql-vsn (method)
• (setf cql-vsn) (method)
• (setf cql-vsn) (generic function)
• cs (generic function)
• cs (method)
• (setf cs) (method)
• (setf cs) (generic function)
• define-binary-write (macro)
• drain-stream (function)
• empty? (function)
• encode-values (function)
• error-response (class)
• execute-header (class)
• extra (generic function)
• extra (method)
• (setf extra) (method)
• (setf extra) (generic function)
• header (class)
• id (generic function)
• id (method)
• (setf id) (method)
• (setf id) (generic function)
• ip (class)
• ip-to-byte-array (generic function)
• ip-to-byte-array (method)
• ip-to-byte-array (method)
• ip-to-integer (generic function)
• ip-to-integer (method)
• ip-to-integer (method)
• ipv4 (class)
• ipv6 (class)
• juxt (function)
• make-in-memory-output-stream (function)
• make-parse-coll (function)
• make-parse-map (function)
• min-bytes (function)
• mutex (generic function)
• mutex (method)
• (setf mutex) (method)
• (setf mutex) (generic function)
• next-stream-id* (function)
• not-implemented (function)
• op (generic function)
• op (method)
• (setf op) (method)
• (setf op) (generic function)
• options-header (class)
• opts (generic function)
• opts (method)
• (setf opts) (method)
• (setf opts) (generic function)
• parse-already-exists (function)
• parse-bigint (function)
• parse-bytes* (function)
• parse-colspec (function)
• parse-colspecs (function)
• parse-error-packet (function)
• parse-header (function)
• parse-ip-from-string (function)
• parse-map (function)
• parse-metadata (function)
• parse-option (function)
• parse-option-list (function)
• parse-prepared (function)
• parse-read-timeout (function)
• parse-result-packet (function)
• parse-row (function)
• parse-rows (function)
• parse-rows* (function)
• parse-schema-change (function)
• parse-set-keyspace (function)
• parse-string-list (function)
• parse-string-multimap (function)
• parse-supported-packet (function)
• parse-timestamp (function)
• parse-unavailable-exception (function)
• parse-varint (function)
• parse-write-timeout (function)
• pending-queries (generic function)
• pending-queries (method)
• (setf pending-queries) (method)
• (setf pending-queries) (generic function)
• pqs (generic function)
• pqs (method)
• (setf pqs) (method)
• (setf pqs) (generic function)
• prepare-header (class)
• prepared-query (class)
• ps (generic function)
• ps (method)
• (setf ps) (method)
• (setf ps) (generic function)
• ptype (generic function)
• ptype (method)
• (setf ptype) (method)
• (setf ptype) (generic function)
• qid (generic function)
• qid (method)
• (setf qid) (method)
• qid (method)
• (setf qid) (method)
• (setf qid) (generic function)
• qs (generic function)
• qs (method)
• (setf qs) (method)
• qs (method)
• (setf qs) (method)
• (setf qs) (generic function)
• query-header (class)
• read-bigint (function)
• read-int (function)
• read-ipv6 (function)
• read-octet (function)
• read-short (function)
• read-sized (function)
• rev-hash (macro)
• row-flag-set? (function)
• startup (generic function)
• startup (method)
• startup-header (class)
• tracing (generic function)
• tracing (method)
• (setf tracing) (method)
• (setf tracing) (generic function)
• val (generic function)
• val (method)
• (setf val) (method)
• (setf val) (generic function)
• vals (generic function)
• vals (method)
• (setf vals) (method)
• (setf vals) (generic function)
• varint (class)
• vsn (generic function)
• vsn (method)
• (setf vsn) (method)
• (setf vsn) (generic function)
• while (macro)
• write-bigint (function)
• write-ipv6 (function)
• write-length (function)
• write-octet (function)
• write-sized (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: +consistency-digit-to-name+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +consistency-name-to-digit+

Package

cqlcl

Source

constants.lisp (file)

5.1.2 Macros

Macro: with-next-stream-id VAR ACONN &body BODY

Package

cqlcl

Source

conn.lisp (file)

5.1.3 Functions

Function: ip= IP1 IP2

Package

cqlcl

Source

types.lisp (file)

Function: make-bigint N

Package

cqlcl

Source

types.lisp (file)

Function: make-connection &key CONNECTION-TYPE HOST PORT

Package

cqlcl

Source

conn.lisp (file)

Function: make-ipv4 ADDR

Package

cqlcl

Source

types.lisp (file)

Function: make-ipv6 ADDR

Package

cqlcl

Source

types.lisp (file)

Function: make-stream-from-byte-vector BV

Package

cqlcl

Source

util.lisp (file)

Function: make-varint N

Package

cqlcl

Source

types.lisp (file)

Function: parse-boolean STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-bytes STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-consistency STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-int STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-ip STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-short STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-short-bytes STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-string STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-string-map STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-uuid STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: write-int value0 stream1

Package

cqlcl

Source

types.lisp (file)

Function: write-short value0 stream1

Package

cqlcl

Source

types.lisp (file)

5.1.4 Generic functions

Generic Function: conn-options OBJECT

Generic Function: (setf conn-options) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: conn-options (CONNECTION connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf conn-options) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

conn.lisp (file)

Generic Function: encode-value VALUE STREAM

Encodes a value into the CQL wire format.

Package

cqlcl

Source

protocol.lisp (file)

Methods

Method: encode-value (VALUE ipv6) STREAM

Method: encode-value (VALUE ipv4) STREAM

Method: encode-value (VALUE uuid) STREAM

Method: encode-value (VALUE symbol) STREAM

Method: encode-value (VALUE vector) STREAM

Method: encode-value (VALUE null) STREAM

Method: encode-value (VALUE hash-table) STREAM

Method: encode-value (VALUE string) STREAM

Method: encode-value (VALUE bigint) STREAM

Method: encode-value (VALUE varint) STREAM

Method: encode-value (VALUE integer) STREAM

Method: encode-value (VALUES list) STREAM

Method: encode-value (HEADER execute-header) STREAM

Method: encode-value (HEADER prepare-header) STREAM

Method: encode-value (HEADER query-header) STREAM

Method: encode-value (HEADER startup-header) STREAM

Method: encode-value (HEADER options-header) STREAM

Method: encode-value (VALUE header) STREAM around

Generic Function: execute CONNECTION STATEMENT &rest VALUES

Executes a prepared statement with bound values.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: execute (CONN connection) (STATEMENT string) &rest VALUES

Generic Function: msg OBJECT

Generic Function: (setf msg) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: msg (ERROR-RESPONSE error-response)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf msg) NEW-VALUE (ERROR-RESPONSE error-response)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: next-stream-id CONNECTION

Returns the next available stream id for a connection.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: next-stream-id (CONN async-connection)

Generic Function: options CONNECTION

Sends an option request.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: options (CONN connection)

Generic Function: prepare CONNECTION STATEMENT

Prepares a statement.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: prepare (CONN connection) (STATEMENT string)

Generic Function: query CONNECTION STATEMENT

Executes a query with no bound values.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: query (CONN connection) (STATEMENT string)

Generic Function: read-single-packet CONNECTION

Reads a single CQL reply packet from a CQL connection.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: read-single-packet (CONN connection)

Generic Function: return-stream-id CONNECTION ID

Returns a stream id to the pool of ids.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: return-stream-id (CONN async-connection) (I integer)

Generic Function: used-streams OBJECT

Generic Function: (setf used-streams) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: used-streams (ASYNC-CONNECTION async-connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf used-streams) NEW-VALUE (ASYNC-CONNECTION async-connection)

automatically generated writer method

Source

conn.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *executing*

Package

cqlcl

Source

protocol.lisp (file)

Special Variable: *unread-size*

Package

cqlcl

Source

protocol.lisp (file)

Special Variable: *write-short-lengths*

Package

cqlcl

Source

protocol.lisp (file)

Special Variable: *write-wide-lengths*

Package

cqlcl

Source

protocol.lisp (file)

Special Variable: +default-version+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +error-codes+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +global-tables-spec+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +has-more-pages+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +header-length+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +message-types+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +no-meta-data+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +op-code-digit-to-name+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +op-code-name-to-digit+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +option-id+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +option-id-to-parser+

Package

cqlcl

Source

protocol.lisp (file)

Special Variable: +packet-type-index+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +request+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +response+

Package

cqlcl

Source

constants.lisp (file)

Special Variable: +result-type+

Package

cqlcl

Source

constants.lisp (file)

5.2.2 Macros

Macro: as-flags &rest VALUES

Package

cqlcl

Source

protocol.lisp (file)

Macro: define-binary-write NAME SIZE

Package

cqlcl

Source

types.lisp (file)

Macro: rev-hash HT

Package

cqlcl

Source

util.lisp (file)

Macro: while CONDITION &rest BODY

Package

cqlcl

Source

util.lisp (file)

5.2.3 Functions

Function: as-bytes S

Package

cqlcl

Source

protocol.lisp (file)

Function: as-string BV

Package

cqlcl

Source

protocol.lisp (file)

Function: byte-array-to-ip BYTES

Package

cqlcl

Source

types.lisp (file)

Function: byte-array-to-ipv4 BYTES

Package

cqlcl

Source

types.lisp (file)

Function: byte-array-to-ipv6 BYTES

Package

cqlcl

Source

types.lisp (file)

Function: bytes-to-integer BV

Package

cqlcl

Source

types.lisp (file)

Function: drain-stream STREAM

Package

cqlcl

Source

util.lisp (file)

Function: empty? THING

Package

cqlcl

Source

util.lisp (file)

Function: encode-values VALUES STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: juxt &rest FUNS

Package

cqlcl

Source

util.lisp (file)

Function: make-in-memory-output-stream ()

Package

cqlcl

Source

types.lisp (file)

Function: make-parse-coll VALUE-FN

Package

cqlcl

Source

protocol.lisp (file)

Function: make-parse-map VALUE-FN

Package

cqlcl

Source

protocol.lisp (file)

Function: min-bytes N

Package

cqlcl

Source

types.lisp (file)

Function: next-stream-id* USED-STREAMS

Package

cqlcl

Source

conn.lisp (file)

Function: not-implemented STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-already-exists STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-bigint STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-bytes* STREAM SIZE &optional POST-PROCESS

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-colspec NAME-PREFIXES? STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-colspecs GLOBAL-TABLES-SPEC COL-COUNT STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-error-packet STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-header HEADER

Package

cqlcl

Source

headers.lisp (file)

Function: parse-ip-from-string IP DELIMITER BYTE-SPEC &optional RADIX

Package

cqlcl

Source

types.lisp (file)

Function: parse-map STREAM VALUE-FN

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-metadata STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-option STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-option-list STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-prepared STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-read-timeout STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-result-packet STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-row COL-SPECS STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-rows STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-rows* COL-SPECS STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-schema-change STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-set-keyspace STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-string-list STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-string-multimap STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-supported-packet STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-timestamp STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-unavailable-exception STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: parse-varint STREAM &optional SIZE

Package

cqlcl

Source

protocol.lisp (file)

Function: parse-write-timeout STREAM

Package

cqlcl

Source

headers.lisp (file)

Function: read-bigint stream1 &key SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: read-int stream1 &key SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: read-ipv6 stream1 &key SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: read-octet stream1 &key SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: read-short stream1 &key SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: read-sized N STREAM &optional SIGNED?

Package

cqlcl

Source

types.lisp (file)

Function: row-flag-set? FLAGS FLAG

Package

cqlcl

Source

headers.lisp (file)

Function: write-bigint value0 stream1

Package

cqlcl

Source

types.lisp (file)

Function: write-ipv6 value0 stream1

Package

cqlcl

Source

types.lisp (file)

Function: write-length THING STREAM

Package

cqlcl

Source

protocol.lisp (file)

Function: write-octet value0 stream1

Package

cqlcl

Source

types.lisp (file)

Function: write-sized VALUE N STREAM

Package

cqlcl

Source

types.lisp (file)

5.2.4 Generic functions

Generic Function: addr OBJECT

Generic Function: (setf addr) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: addr (IPV6 ipv6)

automatically generated reader method

Source

types.lisp (file)

Method: (setf addr) NEW-VALUE (IPV6 ipv6)

automatically generated writer method

Source

types.lisp (file)

Method: addr (IPV4 ipv4)

automatically generated reader method

Source

types.lisp (file)

Method: (setf addr) NEW-VALUE (IPV4 ipv4)

automatically generated writer method

Source

types.lisp (file)

Generic Function: body OBJECT

Generic Function: (setf body) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: body (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf body) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: code OBJECT

Generic Function: (setf code) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: code (ERROR-RESPONSE error-response)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf code) NEW-VALUE (ERROR-RESPONSE error-response)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: compression OBJECT

Generic Function: (setf compression) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: compression (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf compression) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: conn OBJECT

Generic Function: (setf conn) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: conn (CONNECTION connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf conn) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

conn.lisp (file)

Generic Function: consistency OBJECT

Generic Function: (setf consistency) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: consistency (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf consistency) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: cql-vsn OBJECT

Generic Function: (setf cql-vsn) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: cql-vsn (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf cql-vsn) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: cs OBJECT

Generic Function: (setf cs) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: cs (PREPARED-QUERY prepared-query)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf cs) NEW-VALUE (PREPARED-QUERY prepared-query)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: extra OBJECT

Generic Function: (setf extra) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: extra (ERROR-RESPONSE error-response)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf extra) NEW-VALUE (ERROR-RESPONSE error-response)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: id OBJECT

Generic Function: (setf id) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: id (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf id) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: ip-to-byte-array IP

Returns a byte array representing an IP Address.

Package

cqlcl

Source

types.lisp (file)

Methods

Method: ip-to-byte-array (IP ipv6)

Method: ip-to-byte-array (IP ipv4)

Generic Function: ip-to-integer IP

Encodes an integer into an integer

Package

cqlcl

Source

types.lisp (file)

Methods

Method: ip-to-integer (IP ipv6)

Method: ip-to-integer (IP ipv4)

Generic Function: mutex OBJECT

Generic Function: (setf mutex) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: mutex (ASYNC-CONNECTION async-connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf mutex) NEW-VALUE (ASYNC-CONNECTION async-connection)

automatically generated writer method

Source

conn.lisp (file)

Generic Function: op OBJECT

Generic Function: (setf op) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: op (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf op) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: opts OBJECT

Generic Function: (setf opts) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: opts (STARTUP-HEADER startup-header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf opts) NEW-VALUE (STARTUP-HEADER startup-header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: pending-queries OBJECT

Generic Function: (setf pending-queries) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: pending-queries (ASYNC-CONNECTION async-connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf pending-queries) NEW-VALUE (ASYNC-CONNECTION async-connection)

automatically generated writer method

Source

conn.lisp (file)

Generic Function: pqs OBJECT

Generic Function: (setf pqs) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: pqs (CONNECTION connection)

automatically generated reader method

Source

conn.lisp (file)

Method: (setf pqs) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

conn.lisp (file)

Generic Function: ps OBJECT

Generic Function: (setf ps) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: ps (PREPARE-HEADER prepare-header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf ps) NEW-VALUE (PREPARE-HEADER prepare-header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: ptype OBJECT

Generic Function: (setf ptype) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: ptype (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf ptype) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: qid OBJECT

Generic Function: (setf qid) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: qid (PREPARED-QUERY prepared-query)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf qid) NEW-VALUE (PREPARED-QUERY prepared-query)

automatically generated writer method

Source

headers.lisp (file)

Method: qid (EXECUTE-HEADER execute-header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf qid) NEW-VALUE (EXECUTE-HEADER execute-header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: qs OBJECT

Generic Function: (setf qs) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: qs (PREPARED-QUERY prepared-query)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf qs) NEW-VALUE (PREPARED-QUERY prepared-query)

automatically generated writer method

Source

headers.lisp (file)

Method: qs (QUERY-HEADER query-header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf qs) NEW-VALUE (QUERY-HEADER query-header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: startup CONNECTION &key VERSION COMPRESSION

Sends a startup request.

Package

cqlcl

Source

conn.lisp (file)

Methods

Method: startup (CONN connection) &key VERSION COMPRESSION

Generic Function: tracing OBJECT

Generic Function: (setf tracing) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: tracing (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf tracing) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: val OBJECT

Generic Function: (setf val) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: val (ANUMBER anumber)

automatically generated reader method

Source

types.lisp (file)

Method: (setf val) NEW-VALUE (ANUMBER anumber)

automatically generated writer method

Source

types.lisp (file)

Generic Function: vals OBJECT

Generic Function: (setf vals) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: vals (EXECUTE-HEADER execute-header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf vals) NEW-VALUE (EXECUTE-HEADER execute-header)

automatically generated writer method

Source

headers.lisp (file)

Generic Function: vsn OBJECT

Generic Function: (setf vsn) NEW-VALUE OBJECT

Package

cqlcl

Methods

Method: vsn (HEADER header)

automatically generated reader method

Source

headers.lisp (file)

Method: (setf vsn) NEW-VALUE (HEADER header)

automatically generated writer method

Source

headers.lisp (file)

5.2.5 Classes

Class: anumber ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• varint (class)
• bigint (class)

Direct methods

• val (method)
• val (method)

Direct slots

Slot: value

Initargs

:val

Initform

0

Readers

val (generic function)

Writers

(setf val) (generic function)

Class: async-connection ()

Package

cqlcl

Source

conn.lisp (file)

Direct superclasses

connection (class)

Direct methods

• return-stream-id (method)
• next-stream-id (method)
• mutex (method)
• mutex (method)
• pending-queries (method)
• pending-queries (method)
• used-streams (method)
• used-streams (method)

Direct slots

Slot: used-streams

Readers

used-streams (generic function)

Writers

(setf used-streams) (generic function)

Slot: pending-queries

Initform

(make-hash-table :test (function equal))

Readers

pending-queries (generic function)

Writers

(setf pending-queries) (generic function)

Slot: mutex

Initform

(bordeaux-threads:make-lock)

Readers

mutex (generic function)

Writers

(setf mutex) (generic function)

Class: bigint ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

anumber (class)

Direct methods

encode-value (method)

Class: connection ()

Package

cqlcl

Source

conn.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

async-connection (class)

Direct methods

• execute (method)
• query (method)
• prepare (method)
• startup (method)
• options (method)
• read-single-packet (method)
• initialize-instance (method)
• conn-options (method)
• conn-options (method)
• pqs (method)
• pqs (method)
• conn (method)
• conn (method)

Direct slots

Slot: conn

Initargs

:conn

Readers

conn (generic function)

Writers

(setf conn) (generic function)

Slot: prepared-queries

Initform

(make-hash-table :test (function equal))

Readers

pqs (generic function)

Writers

(setf pqs) (generic function)

Slot: conn-options

Initargs

:options

Readers

conn-options (generic function)

Writers

(setf conn-options) (generic function)

Class: error-response ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• extra (method)
• extra (method)
• msg (method)
• msg (method)
• code (method)
• code (method)

Direct slots

Slot: code

Initargs

:code

Readers

code (generic function)

Writers

(setf code) (generic function)

Slot: msg

Initargs

:msg

Readers

msg (generic function)

Writers

(setf msg) (generic function)

Slot: extra

Initargs

:extra

Readers

extra (generic function)

Writers

(setf extra) (generic function)

Class: execute-header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

header (class)

Direct methods

• encode-value (method)
• vals (method)
• vals (method)
• qid (method)
• qid (method)

Direct slots

Slot: query-id

Initargs

:qid

Initform

(error "prepared query id required.")

Readers

qid (generic function)

Writers

(setf qid) (generic function)

Slot: values

Initargs

:vals

Initform

(error "values required.")

Readers

vals (generic function)

Writers

(setf vals) (generic function)

Class: header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• options-header (class)
• startup-header (class)
• query-header (class)
• prepare-header (class)
• execute-header (class)

Direct methods

• encode-value (method)
• body (method)
• body (method)
• op (method)
• op (method)
• id (method)
• id (method)
• tracing (method)
• tracing (method)
• consistency (method)
• consistency (method)
• compression (method)
• compression (method)
• cql-vsn (method)
• cql-vsn (method)
• vsn (method)
• vsn (method)
• ptype (method)
• ptype (method)

Direct slots

Slot: ptype

Initargs

:ptype

Initform

cqlcl::+request+

Readers

ptype (generic function)

Writers

(setf ptype) (generic function)

Slot: version

Initargs

:vsn

Initform

cqlcl::+default-version+

Readers

vsn (generic function)

Writers

(setf vsn) (generic function)

Slot: cql-version

Initargs

:cql-vsn

Initform

"3.0.0"

Readers

cql-vsn (generic function)

Writers

(setf cql-vsn) (generic function)

Slot: compression

Initargs

:compression

Readers

compression (generic function)

Writers

(setf compression) (generic function)

Slot: consistency

Initargs

:consistency

Initform

:quorum

Readers

consistency (generic function)

Writers

(setf consistency) (generic function)

Slot: tracing

Initargs

:tracing

Readers

tracing (generic function)

Writers

(setf tracing) (generic function)

Slot: stream-id

Initargs

:id

Initform

0

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: op-code

Initargs

:op

Initform

:error

Readers

op (generic function)

Writers

(setf op) (generic function)

Slot: body

Initargs

:body

Readers

body (generic function)

Writers

(setf body) (generic function)

Class: ip ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• ipv4 (class)
• ipv6 (class)

Class: ipv4 ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

ip (class)

Direct methods

• encode-value (method)
• ip-to-integer (method)
• ip-to-byte-array (method)
• addr (method)
• addr (method)

Direct slots

Slot: addr

Initargs

:addr

Initform

"0.0.0.0"

Readers

addr (generic function)

Writers

(setf addr) (generic function)

Class: ipv6 ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

ip (class)

Direct methods

• encode-value (method)
• ip-to-integer (method)
• ip-to-byte-array (method)
• addr (method)
• addr (method)

Direct slots

Slot: addr

Initargs

:addr

Initform

"0:0:0:0:0:0:0:0"

Readers

addr (generic function)

Writers

(setf addr) (generic function)

Class: options-header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

header (class)

Direct methods

encode-value (method)

Class: prepare-header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

header (class)

Direct methods

• encode-value (method)
• ps (method)
• ps (method)

Direct slots

Slot: prepare-string

Initargs

:ps

Initform

(error "prepare string required.")

Readers

ps (generic function)

Writers

(setf ps) (generic function)

Class: prepared-query ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• cs (method)
• cs (method)
• qid (method)
• qid (method)
• qs (method)
• qs (method)

Direct slots

Slot: query-string

Initargs

:qs

Readers

qs (generic function)

Writers

(setf qs) (generic function)

Slot: query-id

Initargs

:qid

Readers

qid (generic function)

Writers

(setf qid) (generic function)

Slot: col-specs

Initargs

:cs

Readers

cs (generic function)

Writers

(setf cs) (generic function)

Class: query-header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

header (class)

Direct methods

• encode-value (method)
• qs (method)
• qs (method)

Direct slots

Slot: query-string

Initargs

:qs

Initform

(error "query string required.")

Readers

qs (generic function)

Writers

(setf qs) (generic function)

Class: startup-header ()

Package

cqlcl

Source

headers.lisp (file)

Direct superclasses

header (class)

Direct methods

• encode-value (method)
• opts (method)
• opts (method)

Direct slots

Slot: options

Initargs

:opts

Readers

opts (generic function)

Writers

(setf opts) (generic function)

Class: varint ()

Package

cqlcl

Source

types.lisp (file)

Direct superclasses

anumber (class)

Direct methods

encode-value (method)

Appendix A Indexes

A.1 Concepts