The cl-influxdb Reference Manual

Table of Contents

The cl-influxdb Reference Manual

This is the cl-influxdb Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:24:32 2020 GMT+0.

1 Introduction

CL-INFLUXDB

This package is a native Common Lisp interface for the InfluxDB time series database.

InfluxDB is a scalable time series database.

News

CL-INFLUXDB has been upgraded to support influxdb version 1

The interface cl-influxdb that works with version 0.8 and below has been changed to cl-influxdb-v8 specific information regarding the v8 interface can be obtained by reading README-v8.md.The interface that works with 0.9 is now cl-influxdb.

One of the major changes starting in version 0.9 and above is that much functionality including most administrative functions have been pulled into the InfluxDB query language. Therefor many of the administrative interface functions have been removed from this interface.

Installation

cl-influxdb is distributed via Quicklisp. It can also be obtained via it's [github repository] (http://github.com/mmaul/cl-influxdb)

Usage

For query and administrative commands see the InfluxDB Documentation. All administrative commands are issued via the query method.

Load library and create a instance of class INFLUXDB, using the default is user = root, password = root, host = 127.0.0.1, port = 8086.

(ql:quickload :cl-influxdb)       

To load "cl-influxdb":
  Load 1 ASDF system:
    cl-influxdb

; Loading "cl-influxdb"
..........
(:CL-INFLUXDB)

(defpackage #:cl-influxdb-example
  (:use #:cl #:cl-influxdb
        ))

#<PACKAGE "CL-INFLUXDB-EXAMPLE">

(in-package :cl-influxdb-example)

#<PACKAGE "CL-INFLUXDB-EXAMPLE">

Lets create a instance of class INFLUXDB to get started the default is user = root, password = root, host = 127.0.0.1, port = 8086.

(defparameter influxdb  (make-instance 'influxdb :database "cl_influxdb_example" :user "root" :password "root"))    

INFLUXDB

Create a database, or if the database already exists handle the command-fail condition.

(handler-case (create-database influxdb "cl_influxdb_example" ) (command-fail (e) e))

T

Data is writtent by populating a influxdb-data structure and writing it to the database

(write-points influxdb 
    (make-influxdb-data :key :response_times :tags '((:host . "server1") (:region . "one")) 
        :columns '(:t1 :v1 :c1) 
        :points '((1394761721 "Y" 1.0 1442377210) 
                  (1394761722 "X" 2.0 1442377211)))
                  :time-precision :s)

T

(query influxdb "select time,v1,c1,t1 from response_times;")

((:RESULTS
  ((:SERIES
    ((:NAME . "response_times") (:COLUMNS "time" "v1" "c1" "t1")
     (:VALUES ("2015-09-16T04:20:10Z" "Y" 1 1394761721)
      ("2015-09-16T04:20:11Z" "X" 2 1394761722)))))))

Now clean up and drop the database

(query influxdb "drop database cl_influxdb_example")

((:RESULTS NIL))

License

The MIT License (MIT)

Copyright (c) 2014-2016 Michael Maul

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

2 Systems

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

2.1 cl-influxdb

Author

Mike Maul <mike.maul@gmail.com>

License

MIT

Description

Common lisp binding for InfluxDB

Dependencies

• cl-json
• drakma
• do-urlencode
• cl-annot
• flexi-streams
• usocket

Source

cl-influxdb.asd (file)

Components

• package.lisp (file)
• cl-influxdb.lisp (file)
• cl-influxdb-v8.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 cl-influxdb.asd

Location

cl-influxdb.asd

Systems

cl-influxdb (system)

3.1.2 cl-influxdb/package.lisp

Parent

cl-influxdb (system)

Location

package.lisp

Packages

• cl-influxdb
• cl-influxdb-v8

3.1.3 cl-influxdb/cl-influxdb.lisp

Dependency

package.lisp (file)

Parent

cl-influxdb (system)

Location

cl-influxdb.lisp

Exported Definitions

• close-reuseable-connection (method)
• command-fail (condition)
• create-database (method)
• delete-database (method)
• get-database-list (method)
• get-series (function)
• headers (method)
• influxdb (class)
• influxdb-cmd (method)
• influxdb-data (structure)
• influxdb-data-columns (function)
• (setf influxdb-data-columns) (function)
• influxdb-data-key (function)
• (setf influxdb-data-key) (function)
• influxdb-data-points (function)
• (setf influxdb-data-points) (function)
• influxdb-data-tags (function)
• (setf influxdb-data-tags) (function)
• influxdb-udp-socket (function)
• influxdb.baseurl (method)
• (setf influxdb.baseurl) (method)
• influxdb.cookie-jar (method)
• (setf influxdb.cookie-jar) (method)
• influxdb.database (method)
• (setf influxdb.database) (method)
• influxdb.headers (method)
• (setf influxdb.headers) (method)
• influxdb.host (method)
• (setf influxdb.host) (method)
• influxdb.password (method)
• (setf influxdb.password) (method)
• influxdb.port (method)
• (setf influxdb.port) (method)
• influxdb.retention-policy (method)
• (setf influxdb.retention-policy) (method)
• influxdb.reuse-connection (method)
• (setf influxdb.reuse-connection) (method)
• influxdb.scheme (method)
• (setf influxdb.scheme) (method)
• influxdb.stream (method)
• (setf influxdb.stream) (method)
• influxdb.user (method)
• (setf influxdb.user) (method)
• influxdb.write-consistency (method)
• (setf influxdb.write-consistency) (method)
• invalid-time-precision (condition)
• list-servers (method)
• make-influxdb-data (function)
• ping (method)
• print-run (macro)
• query (method)
• switch-database (method)
• switch-user (method)
• write-points (method)

Internal Definitions

• assert-valid-time-precision (function)
• body (method)
• cmd-stream (method)
• copy-influxdb-data (function)
• encode-data (function)
• encode-influxdb-data (function)
• influxdb-data-p (function)
• influxdb-key-tag-fmt (function)
• influxdb-value-fmt (function)
• must-close (method)
• reason-phrase (method)
• replace-all (function)
• status-code (method)
• symbol-keyword-or-string (function)
• text (method)
• uri (method)

3.1.4 cl-influxdb/cl-influxdb-v8.lisp

Dependency

cl-influxdb.lisp (file)

Parent

cl-influxdb (system)

Location

cl-influxdb-v8.lisp

Exported Definitions

• add-cluster-admin (method)
• add-database-user (method)
• alter-database-admin (method)
• close-reuseable-connection (method)
• command-fail (condition)
• create-continuous-queries (method)
• create-database (method)
• create-shard (method)
• delete-cluster-admin (method)
• delete-continuous-queries (method)
• delete-database (method)
• delete-database-user (method)
• delete-series (method)
• drop-shard (method)
• get-database-list (method)
• get-database-users (method)
• get-list-cluster-admins (method)
• get-shards (method)
• headers (method)
• influxdb (class)
• influxdb.baseurl (method)
• (setf influxdb.baseurl) (method)
• influxdb.cookie-jar (method)
• (setf influxdb.cookie-jar) (method)
• influxdb.database (method)
• (setf influxdb.database) (method)
• influxdb.headers (method)
• (setf influxdb.headers) (method)
• influxdb.host (method)
• (setf influxdb.host) (method)
• influxdb.password (method)
• (setf influxdb.password) (method)
• influxdb.port (method)
• (setf influxdb.port) (method)
• influxdb.reuse-connection (method)
• (setf influxdb.reuse-connection) (method)
• influxdb.stream (method)
• (setf influxdb.stream) (method)
• influxdb.user (method)
• (setf influxdb.user) (method)
• interfaces (method)
• invalid-time-precision (condition)
• list-continuous-queries (method)
• list-servers (method)
• ping (method)
• print-run (macro)
• query (method)
• set-database-admin (method)
• switch-database (method)
• switch-user (method)
• unset-database-admin (method)
• update-cluster-admin-password (method)
• update-database-user-password (method)
• write-points (method)

Internal Definitions

• assert-valid-time-precision (function)
• body (method)
• cmd-stream (method)
• force-raft-compaction (method)
• influxdb-cmd (method)
• must-close (method)
• reason-phrase (method)
• status-code (method)
• symbol-keyword-or-string (function)
• text (method)
• uri (method)

4 Packages

Packages are listed by definition order.

4.1 cl-influxdb

Source

package.lisp (file)

Use List

• flexi-streams
• cl-annot.class
• cl-annot
• drakma
• json
• common-lisp

Exported Definitions

• close-reuseable-connection (generic function)
• close-reuseable-connection (method)
• command-fail (condition)
• create-database (generic function)
• create-database (method)
• delete-database (generic function)
• delete-database (method)
• get-database-list (generic function)
• get-database-list (method)
• get-series (function)
• headers (generic function)
• headers (method)
• influxdb (class)
• influxdb-cmd (generic function)
• influxdb-cmd (method)
• influxdb-data (structure)
• influxdb-data-columns (function)
• (setf influxdb-data-columns) (function)
• influxdb-data-key (function)
• (setf influxdb-data-key) (function)
• influxdb-data-points (function)
• (setf influxdb-data-points) (function)
• influxdb-data-tags (function)
• (setf influxdb-data-tags) (function)
• influxdb-udp-socket (function)
• influxdb.baseurl (generic function)
• influxdb.baseurl (method)
• (setf influxdb.baseurl) (method)
• (setf influxdb.baseurl) (generic function)
• influxdb.cookie-jar (generic function)
• influxdb.cookie-jar (method)
• (setf influxdb.cookie-jar) (method)
• (setf influxdb.cookie-jar) (generic function)
• influxdb.database (generic function)
• influxdb.database (method)
• (setf influxdb.database) (method)
• (setf influxdb.database) (generic function)
• influxdb.headers (generic function)
• influxdb.headers (method)
• (setf influxdb.headers) (method)
• (setf influxdb.headers) (generic function)
• influxdb.host (generic function)
• influxdb.host (method)
• (setf influxdb.host) (method)
• (setf influxdb.host) (generic function)
• influxdb.password (generic function)
• influxdb.password (method)
• (setf influxdb.password) (method)
• (setf influxdb.password) (generic function)
• influxdb.port (generic function)
• influxdb.port (method)
• (setf influxdb.port) (method)
• (setf influxdb.port) (generic function)
• influxdb.retention-policy (generic function)
• influxdb.retention-policy (method)
• (setf influxdb.retention-policy) (method)
• (setf influxdb.retention-policy) (generic function)
• influxdb.reuse-connection (generic function)
• influxdb.reuse-connection (method)
• (setf influxdb.reuse-connection) (method)
• (setf influxdb.reuse-connection) (generic function)
• influxdb.scheme (generic function)
• influxdb.scheme (method)
• (setf influxdb.scheme) (method)
• (setf influxdb.scheme) (generic function)
• influxdb.stream (generic function)
• influxdb.stream (method)
• (setf influxdb.stream) (method)
• (setf influxdb.stream) (generic function)
• influxdb.user (generic function)
• influxdb.user (method)
• (setf influxdb.user) (method)
• (setf influxdb.user) (generic function)
• influxdb.write-consistency (generic function)
• influxdb.write-consistency (method)
• (setf influxdb.write-consistency) (method)
• (setf influxdb.write-consistency) (generic function)
• invalid-time-precision (condition)
• list-servers (generic function)
• list-servers (method)
• make-influxdb-data (function)
• ping (generic function)
• ping (method)
• print-run (macro)
• query (generic function)
• query (method)
• switch-database (generic function)
• switch-database (method)
• switch-user (generic function)
• switch-user (method)
• write-points (generic function)
• write-points (method)

Internal Definitions

• assert-valid-time-precision (function)
• body (generic function)
• body (method)
• cmd-stream (generic function)
• cmd-stream (method)
• copy-influxdb-data (function)
• encode-data (function)
• encode-influxdb-data (function)
• influxdb-data-p (function)
• influxdb-key-tag-fmt (function)
• influxdb-value-fmt (function)
• must-close (generic function)
• must-close (method)
• reason-phrase (generic function)
• reason-phrase (method)
• replace-all (function)
• status-code (generic function)
• status-code (method)
• symbol-keyword-or-string (function)
• text (generic function)
• text (method)
• uri (generic function)
• uri (method)

4.2 cl-influxdb-v8

Source

package.lisp (file)

Use List

• flexi-streams
• cl-annot.class
• cl-annot
• drakma
• json
• common-lisp

Exported Definitions

• add-cluster-admin (generic function)
• add-cluster-admin (method)
• add-database-user (generic function)
• add-database-user (method)
• alter-database-admin (generic function)
• alter-database-admin (method)
• close-reuseable-connection (generic function)
• close-reuseable-connection (method)
• command-fail (condition)
• create-continuous-queries (generic function)
• create-continuous-queries (method)
• create-database (generic function)
• create-database (method)
• create-shard (generic function)
• create-shard (method)
• delete-cluster-admin (generic function)
• delete-cluster-admin (method)
• delete-continuous-queries (generic function)
• delete-continuous-queries (method)
• delete-database (generic function)
• delete-database (method)
• delete-database-user (generic function)
• delete-database-user (method)
• delete-series (generic function)
• delete-series (method)
• drop-shard (generic function)
• drop-shard (method)
• get-database-list (generic function)
• get-database-list (method)
• get-database-users (generic function)
• get-database-users (method)
• get-list-cluster-admins (generic function)
• get-list-cluster-admins (method)
• get-shards (generic function)
• get-shards (method)
• headers (generic function)
• headers (method)
• influxdb (class)
• influxdb.baseurl (generic function)
• influxdb.baseurl (method)
• (setf influxdb.baseurl) (method)
• (setf influxdb.baseurl) (generic function)
• influxdb.cookie-jar (generic function)
• influxdb.cookie-jar (method)
• (setf influxdb.cookie-jar) (method)
• (setf influxdb.cookie-jar) (generic function)
• influxdb.database (generic function)
• influxdb.database (method)
• (setf influxdb.database) (method)
• (setf influxdb.database) (generic function)
• influxdb.headers (generic function)
• influxdb.headers (method)
• (setf influxdb.headers) (method)
• (setf influxdb.headers) (generic function)
• influxdb.host (generic function)
• influxdb.host (method)
• (setf influxdb.host) (method)
• (setf influxdb.host) (generic function)
• influxdb.password (generic function)
• influxdb.password (method)
• (setf influxdb.password) (method)
• (setf influxdb.password) (generic function)
• influxdb.port (generic function)
• influxdb.port (method)
• (setf influxdb.port) (method)
• (setf influxdb.port) (generic function)
• influxdb.reuse-connection (generic function)
• influxdb.reuse-connection (method)
• (setf influxdb.reuse-connection) (method)
• (setf influxdb.reuse-connection) (generic function)
• influxdb.stream (generic function)
• influxdb.stream (method)
• (setf influxdb.stream) (method)
• (setf influxdb.stream) (generic function)
• influxdb.user (generic function)
• influxdb.user (method)
• (setf influxdb.user) (method)
• (setf influxdb.user) (generic function)
• interfaces (generic function)
• interfaces (method)
• invalid-time-precision (condition)
• list-continuous-queries (generic function)
• list-continuous-queries (method)
• list-servers (generic function)
• list-servers (method)
• ping (generic function)
• ping (method)
• print-run (macro)
• query (generic function)
• query (method)
• set-database-admin (generic function)
• set-database-admin (method)
• switch-database (generic function)
• switch-database (method)
• switch-user (generic function)
• switch-user (method)
• unset-database-admin (generic function)
• unset-database-admin (method)
• update-cluster-admin-password (generic function)
• update-cluster-admin-password (method)
• update-database-user-password (generic function)
• update-database-user-password (method)
• write-points (generic function)
• write-points (method)

Internal Definitions

• assert-valid-time-precision (function)
• body (generic function)
• body (method)
• cmd-stream (generic function)
• cmd-stream (method)
• force-raft-compaction (generic function)
• force-raft-compaction (method)
• influxdb-cmd (generic function)
• influxdb-cmd (method)
• must-close (generic function)
• must-close (method)
• reason-phrase (generic function)
• reason-phrase (method)
• status-code (generic function)
• status-code (method)
• symbol-keyword-or-string (function)
• text (generic function)
• text (method)
• uri (generic function)
• uri (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: print-run HEADER &rest CODE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Macro: print-run HEADER &rest CODE

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

5.1.2 Functions

Function: get-series QUERY-RESULTS

Transforms results from query into an alist with keys :status :name :columns :values

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-data-columns INSTANCE

Function: (setf influxdb-data-columns) VALUE INSTANCE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-data-key INSTANCE

Function: (setf influxdb-data-key) VALUE INSTANCE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-data-points INSTANCE

Function: (setf influxdb-data-points) VALUE INSTANCE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-data-tags INSTANCE

Function: (setf influxdb-data-tags) VALUE INSTANCE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-udp-socket HOST PORT

Returns UDP socket for use with write-points using UDP

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: make-influxdb-data &key (KEY KEY) (TAGS TAGS) (COLUMNS COLUMNS) (POINTS POINTS)

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

5.1.3 Generic functions

Generic Function: add-cluster-admin SELF USER PASSWORD

Package

cl-influxdb-v8

Methods

Method: add-cluster-admin (SELF influxdb) USER PASSWORD

Source

cl-influxdb-v8.lisp (file)

Generic Function: add-database-user SELF USER PASSWORD

Package

cl-influxdb-v8

Methods

Method: add-database-user (SELF influxdb) USER PASSWORD

Source

cl-influxdb-v8.lisp (file)

Generic Function: alter-database-admin SELF USER IS-ADMIN

Package

cl-influxdb-v8

Methods

Method: alter-database-admin (SELF influxdb) USER IS-ADMIN

Source

cl-influxdb-v8.lisp (file)

Generic Function: close-reuseable-connection SELF

Package

cl-influxdb

Methods

Method: close-reuseable-connection (SELF influxdb)

When using :resue-connection this connection should be called to close the stream. If :reuse-connection is not set then this is unnecessary.

- return NIL
- arguments INFLUXDB instance

Source

cl-influxdb.lisp (file)

Generic Function: close-reuseable-connection SELF

Package

cl-influxdb-v8

Methods

Method: close-reuseable-connection (SELF influxdb)

When using :resue-connection this connection should be called to close the stream. If :reuse-connection is not set then this is unnecessary.

Source

cl-influxdb-v8.lisp (file)

Generic Function: create-continuous-queries SELF QUERY

Package

cl-influxdb-v8

Methods

Method: create-continuous-queries (SELF influxdb) QUERY

Source

cl-influxdb-v8.lisp (file)

Generic Function: create-database SELF DATABASE

Package

cl-influxdb

Methods

Method: create-database (SELF influxdb) DATABASE

Creates a database named DATABASE.

-return multiple values CONTENT, REASON, STREAM On failure raises COMMAND-FAIL condition -arguments
- INFLUXDB
- database database name

Source

cl-influxdb.lisp (file)

Generic Function: create-database SELF DATABASE

Package

cl-influxdb-v8

Methods

Method: create-database (SELF influxdb) DATABASE

Creates a database named DATABASE.

Returns multiple values CONTENT, REASON, STREAM On failure raises COMMAND-FAIL condition

Source

cl-influxdb-v8.lisp (file)

Generic Function: create-shard SELF SHARD

Package

cl-influxdb-v8

Methods

Method: create-shard (SELF influxdb) SHARD

Source

cl-influxdb-v8.lisp (file)

Generic Function: delete-cluster-admin SELF USER

Package

cl-influxdb-v8

Methods

Method: delete-cluster-admin (SELF influxdb) USER

Source

cl-influxdb-v8.lisp (file)

Generic Function: delete-continuous-queries SELF ID

Package

cl-influxdb-v8

Methods

Method: delete-continuous-queries (SELF influxdb) ID

Source

cl-influxdb-v8.lisp (file)

Generic Function: delete-database SELF DATABASE

Package

cl-influxdb

Methods

Method: delete-database (SELF influxdb) DATABASE

deletes a database named DATABASE.

-return multiple values CONTENT, REASON, STREAM On failure raises COMMAND-FAIL condition -arguments
- INFLUXDB
- database database name

Source

cl-influxdb.lisp (file)

Generic Function: delete-database SELF DATABASE

Package

cl-influxdb-v8

Methods

Method: delete-database (SELF influxdb) DATABASE

deletes a database named DATABASE.

Returns multiple values CONTENT, REASON, STREAM On failure raises COMMAND-FAIL condition

Source

cl-influxdb-v8.lisp (file)

Generic Function: delete-database-user SELF USER

Package

cl-influxdb-v8

Methods

Method: delete-database-user (SELF influxdb) USER

Source

cl-influxdb-v8.lisp (file)

Generic Function: delete-series SELF SERIES

Package

cl-influxdb-v8

Methods

Method: delete-series (SELF influxdb) SERIES

Source

cl-influxdb-v8.lisp (file)

Generic Function: drop-shard SELF ID

Package

cl-influxdb-v8

Methods

Method: drop-shard (SELF influxdb) ID

Source

cl-influxdb-v8.lisp (file)

Generic Function: get-database-list SELF

Package

cl-influxdb

Methods

Method: get-database-list (SELF influxdb)

Get list of defined databases

-return list of defined databases
On failure raises COMMAND-FAIL condition -arguments
- INFLUXDB
- database database name

Source

cl-influxdb.lisp (file)

Generic Function: get-database-list SELF

Package

cl-influxdb-v8

Methods

Method: get-database-list (SELF influxdb)

Returns list of defined databases
On Failure COMMAND-FAIL condtion is invoked

Source

cl-influxdb-v8.lisp (file)

Generic Function: get-database-users SELF

Package

cl-influxdb-v8

Methods

Method: get-database-users (SELF influxdb)

Source

cl-influxdb-v8.lisp (file)

Generic Function: get-list-cluster-admins SELF

Package

cl-influxdb-v8

Methods

Method: get-list-cluster-admins (SELF influxdb)

Source

cl-influxdb-v8.lisp (file)

Generic Function: get-shards SELF

Package

cl-influxdb-v8

Methods

Method: get-shards (SELF influxdb)

Source

cl-influxdb-v8.lisp (file)

Generic Function: headers CONDITION

Package

cl-influxdb

Methods

Method: headers (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: headers CONDITION

Package

cl-influxdb-v8

Methods

Method: headers (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb-cmd SELF ARG-LIST &key DATA PARAMS METHOD OK-STATUS-CODE DEBUG

Package

cl-influxdb

Methods

Method: influxdb-cmd (SELF influxdb) ARG-LIST &key DATA PARAMS METHOD OK-STATUS-CODE DEBUG

Submits influxdb command defined by ARG-LIST which the contains elements of
the path after after the base influxdb URL. Certain commands require a
specific HTTP method method should be one of :GET :POST :DELETE.
Thd DATA argument should be a lisp object representation of a JSON
object. See examples.lisp write-response-times and refer to CL-JSON
documentation for ENCODE-TO-STRING. PARAMS is an alist of paramater
which will be encoded in the HTTP request (they do not need to be url-encoded).

Where N is the number of worker threads which should generally be the number of CPU cores.

- return: Returns multiple values CONTENT, REASON
On failure raises COMMAND-FAIL condition
- arguments:
- influxdb instance
- arg-list - list of elements that will be translated into path components when building the URL for the influxdb API endpoint
- data - data to be put in the Post body if it is a list contents is encoded into a json string, if data is of type influxdb-data it is encoded using the InfluxDB Line Protocol.
- method - request method :get, :post
- ok-status-code - Status code indicating success of operation

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.baseurl OBJECT

Generic Function: (setf influxdb.baseurl) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.baseurl (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.baseurl) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.baseurl OBJECT

Generic Function: (setf influxdb.baseurl) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.baseurl (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.baseurl) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.cookie-jar OBJECT

Generic Function: (setf influxdb.cookie-jar) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.cookie-jar (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.cookie-jar) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.cookie-jar OBJECT

Generic Function: (setf influxdb.cookie-jar) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.cookie-jar (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.cookie-jar) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.database OBJECT

Generic Function: (setf influxdb.database) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.database (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.database) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.database OBJECT

Generic Function: (setf influxdb.database) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.database (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.database) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.headers OBJECT

Generic Function: (setf influxdb.headers) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.headers (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.headers) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.headers OBJECT

Generic Function: (setf influxdb.headers) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.headers (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.headers) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.host OBJECT

Generic Function: (setf influxdb.host) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.host (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.host) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.host OBJECT

Generic Function: (setf influxdb.host) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.host (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.host) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.password OBJECT

Generic Function: (setf influxdb.password) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.password (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.password) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.password OBJECT

Generic Function: (setf influxdb.password) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.password (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.password) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.port OBJECT

Generic Function: (setf influxdb.port) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.port (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.port) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.port OBJECT

Generic Function: (setf influxdb.port) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.port (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.port) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.retention-policy OBJECT

Generic Function: (setf influxdb.retention-policy) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.retention-policy (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.retention-policy) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.reuse-connection OBJECT

Generic Function: (setf influxdb.reuse-connection) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.reuse-connection (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.reuse-connection) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.reuse-connection OBJECT

Generic Function: (setf influxdb.reuse-connection) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.reuse-connection (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.reuse-connection) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.scheme OBJECT

Generic Function: (setf influxdb.scheme) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.scheme (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.scheme) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.stream OBJECT

Generic Function: (setf influxdb.stream) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.stream (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.stream) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.stream OBJECT

Generic Function: (setf influxdb.stream) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.stream (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.stream) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.user OBJECT

Generic Function: (setf influxdb.user) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.user (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.user) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: influxdb.user OBJECT

Generic Function: (setf influxdb.user) NEW-VALUE OBJECT

Package

cl-influxdb-v8

Methods

Method: influxdb.user (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb-v8.lisp (file)

Method: (setf influxdb.user) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb.write-consistency OBJECT

Generic Function: (setf influxdb.write-consistency) NEW-VALUE OBJECT

Package

cl-influxdb

Methods

Method: influxdb.write-consistency (INFLUXDB influxdb)

automatically generated reader method

Source

cl-influxdb.lisp (file)

Method: (setf influxdb.write-consistency) NEW-VALUE (INFLUXDB influxdb)

automatically generated writer method

Source

cl-influxdb.lisp (file)

Generic Function: interfaces SELF

Package

cl-influxdb-v8

Methods

Method: interfaces (SELF influxdb)

fetch current list of available interfaces

Source

cl-influxdb-v8.lisp (file)

Generic Function: list-continuous-queries SELF

Package

cl-influxdb-v8

Methods

Method: list-continuous-queries (SELF influxdb)

Source

cl-influxdb-v8.lisp (file)

Generic Function: list-servers SELF

Package

cl-influxdb

Methods

Method: list-servers (SELF influxdb)

cluster config endpoints

-return list of defined databases
On failure raises COMMAND-FAIL condition -arguments
- INFLUXDB
- database database name

Source

cl-influxdb.lisp (file)

Generic Function: list-servers SELF

Package

cl-influxdb-v8

Methods

Method: list-servers (SELF influxdb)

cluster config endpoints

Source

cl-influxdb-v8.lisp (file)

Generic Function: ping SELF

Package

cl-influxdb

Methods

Method: ping (SELF influxdb)

healthcheck

-return t on success
On failure raises COMMAND-FAIL condition -arguments
- INFLUXDB

Source

cl-influxdb.lisp (file)

Generic Function: ping SELF

Package

cl-influxdb-v8

Methods

Method: ping (SELF influxdb)

healthcheck

Source

cl-influxdb-v8.lisp (file)

Generic Function: query SELF QUERY-TXT &key TIME-PRECISION CHUNKED RETENTION-POLICY DEBUG

Package

cl-influxdb

Methods

Method: query (SELF influxdb) QUERY-TXT &key TIME-PRECISION CHUNKED RETENTION-POLICY DEBUG

When TIME-PRECISION is not of ’n’ ’s’ ’m’ or ’u’ INVALID-TIME-PRECISION is invoked On Failure COMMAND-FAIL condtion is invoked
On Success Values lisp representation of JSON and a reason STRING are areturned

Source

cl-influxdb.lisp (file)

Generic Function: query SELF QUERY-TXT &key TIME-PRECISION CHUNKED DEBUG

Package

cl-influxdb-v8

Methods

Method: query (SELF influxdb) QUERY-TXT &key TIME-PRECISION CHUNKED DEBUG

When TIME-PRECISION is not of ’s’ ’m’ or ’u’ INVALID-TIME-PRECISION is invoked On Failure COMMAND-FAIL condtion is invoked
On Success Values lisp representation of JSON and a reason STRING are areturned

Source

cl-influxdb-v8.lisp (file)

Generic Function: set-database-admin SELF USER

Package

cl-influxdb-v8

Methods

Method: set-database-admin (SELF influxdb) USER

Source

cl-influxdb-v8.lisp (file)

Generic Function: switch-database SELF DATABASE

Package

cl-influxdb

Methods

Method: switch-database (SELF influxdb) DATABASE

Source

cl-influxdb.lisp (file)

Generic Function: switch-database SELF DATABASE

Package

cl-influxdb-v8

Methods

Method: switch-database (SELF influxdb) DATABASE

Source

cl-influxdb-v8.lisp (file)

Generic Function: switch-user SELF USER PASSWORD

Package

cl-influxdb

Methods

Method: switch-user (SELF influxdb) USER PASSWORD

Source

cl-influxdb.lisp (file)

Generic Function: switch-user SELF USER PASSWORD

Package

cl-influxdb-v8

Methods

Method: switch-user (SELF influxdb) USER PASSWORD

Source

cl-influxdb-v8.lisp (file)

Generic Function: unset-database-admin SELF USER

Package

cl-influxdb-v8

Methods

Method: unset-database-admin (SELF influxdb) USER

Source

cl-influxdb-v8.lisp (file)

Generic Function: update-cluster-admin-password SELF PASSWORD

Package

cl-influxdb-v8

Methods

Method: update-cluster-admin-password (SELF influxdb) PASSWORD

Source

cl-influxdb-v8.lisp (file)

Generic Function: update-database-user-password SELF PASSWORD &optional USER

Package

cl-influxdb-v8

Methods

Method: update-database-user-password (SELF influxdb) PASSWORD &optional USER

Changes database user password. If no user is spe3cified the current users password is change the new password is also updated in the influxdb instance.

Source

cl-influxdb-v8.lisp (file)

Generic Function: write-points SELF DATA &key TIME-PRECISION WRITE-CONSISTENCY RETENTION-POLICY UDP-SOCKET DEBUG

Package

cl-influxdb

Methods

Method: write-points (SELF influxdb) DATA &key TIME-PRECISION WRITE-CONSISTENCY RETENTION-POLICY UDP-SOCKET DEBUG

Write points to the database refered by influxdb
- return
On Failure COMMAND-FAIL condtion is invoked
On Success Values T and a reason STRING are are returned

- arguments
- data - INFLUXDB-DATA struct containing the point data to be written, see
documention for INFLUXDB-DATA for more information.
- time-precision - Time precision should be one of
- ’n’ nanoseconds since unix epoch
- ’u’ microseconds since unix epoch
- ’s’ seconds since unix epoch
- ’m’ miniutes since unix epoch
When TIME-PRECISION is not of ’s’ ’m’ ’u’ ’n’or ’us’ INVALID-TIME-PRECISION is invoked - retention-policy - name of the defined retention policy to use (See InfluxDB docs)
- write-consistency - Only relevant when using clusters can be one of one,quorum,all,any
- udp-socket - When present uses supplied influxdb-udp-scket to send data. The total size
of the data should be less than 65536 (can vary with OS and settings)

Source

cl-influxdb.lisp (file)

Generic Function: write-points SELF DATA &key TIME-PRECISION DEBUG

Package

cl-influxdb-v8

Methods

Method: write-points (SELF influxdb) DATA &key TIME-PRECISION DEBUG

data is lisp representation of JSON object of the form
(
(
:name: <series name>
:columns (<list of column names)
:points: (
(<row value list 1>)
...
(<row value listn>)
)
)
)

Time precision should be one of
’u’ microsecond
’s’ second
’m’ miniute
When TIME-PRECISION is not of ’s’ ’m’ ’u’ ’ms’or ’us’ INVALID-TIME-PRECISION is invoked On Failure COMMAND-FAIL condtion is invoked
On Success Values T and a reason STRING are areturned

Source

cl-influxdb-v8.lisp (file)

5.1.4 Conditions

Condition: command-fail ()

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Direct superclasses

error (condition)

Direct methods

• reason-phrase (method)
• must-close (method)
• cmd-stream (method)
• uri (method)
• headers (method)
• status-code (method)
• body (method)

Direct slots

Slot: body-or-stream

Initargs

:body-or-stream

Readers

body (generic function)

Slot: status-code

Initargs

:status-code

Readers

status-code (generic function)

Slot: headers

Initargs

:headers

Readers

headers (generic function)

Slot: uri

Initargs

:uri

Readers

uri (generic function)

Slot: stream

Initargs

:stream

Readers

cmd-stream (generic function)

Slot: must-close

Initargs

:must-close

Readers

must-close (generic function)

Slot: reason-phrase

Initargs

:reason-phrase

Readers

reason-phrase (generic function)

Condition: command-fail ()

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

Direct superclasses

error (condition)

Direct methods

• reason-phrase (method)
• must-close (method)
• cmd-stream (method)
• uri (method)
• headers (method)
• status-code (method)
• body (method)

Direct slots

Slot: body-or-stream

Initargs

:body-or-stream

Readers

body (generic function)

Slot: status-code

Initargs

:status-code

Readers

status-code (generic function)

Slot: headers

Initargs

:headers

Readers

headers (generic function)

Slot: uri

Initargs

:uri

Readers

uri (generic function)

Slot: stream

Initargs

:stream

Readers

cmd-stream (generic function)

Slot: must-close

Initargs

:must-close

Readers

must-close (generic function)

Slot: reason-phrase

Initargs

:reason-phrase

Readers

reason-phrase (generic function)

Condition: invalid-time-precision ()

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Direct superclasses

error (condition)

Direct methods

text (method)

Direct slots

Slot: text

Initargs

:text

Readers

text (generic function)

Condition: invalid-time-precision ()

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

Direct superclasses

error (condition)

Direct methods

text (method)

Direct slots

Slot: text

Initargs

:text

Readers

text (generic function)

5.1.5 Structures

Structure: influxdb-data ()

See InfluxDB documentation for details of components.
- key - series name, (can be string or keyword or symbol)
tags - assoc list of tags and values (can be string or keyword or symbol)
columns - List of column names for values (can be string or keyword or symbol)
points - List lists or vector of vectors values values can be string, boolean or numeric The last element of the list can optionally be a timestamp of precision secons, microseconds or minutes since the unix epoch. If no timestamp is provided the system time is used. It is important to not that the tags and timestamp act as a primary key of sorts. So providing multiple points with no time stamp will result as the last value being stored in the database. The time precision is specified either when creating the INFLUXDB instance or during the call to write-points.
example:
(make-influxdb-data :key :a
:tags ’((:host . "server1") (:aregion . "one"))
:columns ’(v1 v2 v3)
:points ’((1 1.0 "Y" 1442371010000000)

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: key

Readers

influxdb-data-key (function)

Writers

(setf influxdb-data-key) (function)

Slot: tags

Readers

influxdb-data-tags (function)

Writers

(setf influxdb-data-tags) (function)

Slot: columns

Readers

influxdb-data-columns (function)

Writers

(setf influxdb-data-columns) (function)

Slot: points

Readers

influxdb-data-points (function)

Writers

(setf influxdb-data-points) (function)

5.1.6 Classes

Class: influxdb ()

InfluxDB connection

- retention-policy - name of the defined retention policy to use (See InfluxDB docs) - write-consistency - Only relevant when using clusters can be one of one,quorum,all,any

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• switch-user (method)
• switch-database (method)
• list-servers (method)
• ping (method)
• get-database-list (method)
• delete-database (method)
• create-database (method)
• query (method)
• write-points (method)
• close-reuseable-connection (method)
• influxdb-cmd (method)
• initialize-instance (method)
• influxdb.stream (method)
• influxdb.stream (method)
• influxdb.cookie-jar (method)
• influxdb.cookie-jar (method)
• influxdb.baseurl (method)
• influxdb.baseurl (method)
• influxdb.headers (method)
• influxdb.headers (method)
• influxdb.reuse-connection (method)
• influxdb.reuse-connection (method)
• influxdb.write-consistency (method)
• influxdb.write-consistency (method)
• influxdb.retention-policy (method)
• influxdb.retention-policy (method)
• influxdb.database (method)
• influxdb.database (method)
• influxdb.password (method)
• influxdb.password (method)
• influxdb.user (method)
• influxdb.user (method)
• influxdb.port (method)
• influxdb.port (method)
• influxdb.host (method)
• influxdb.host (method)
• influxdb.scheme (method)
• influxdb.scheme (method)

Direct slots

Slot: scheme

Initargs

:scheme

Initform

"http"

Readers

influxdb.scheme (generic function)

Writers

(setf influxdb.scheme) (generic function)

Slot: host

Initargs

:host

Initform

"127.0.0.1"

Readers

influxdb.host (generic function)

Writers

(setf influxdb.host) (generic function)

Slot: port

Initargs

:port

Initform

8086

Readers

influxdb.port (generic function)

Writers

(setf influxdb.port) (generic function)

Slot: user

Initargs

:user

Initform

"root"

Readers

influxdb.user (generic function)

Writers

(setf influxdb.user) (generic function)

Slot: password

Initargs

:password

Initform

"root"

Readers

influxdb.password (generic function)

Writers

(setf influxdb.password) (generic function)

Slot: database

Initargs

:database

Readers

influxdb.database (generic function)

Writers

(setf influxdb.database) (generic function)

Slot: retention-policy

Initargs

:retention-policy

Readers

influxdb.retention-policy (generic function)

Writers

(setf influxdb.retention-policy) (generic function)

Slot: write-consistency

Initargs

:write-consistency

Readers

influxdb.write-consistency (generic function)

Writers

(setf influxdb.write-consistency) (generic function)

Slot: reuse-connection

Initargs

:reuse-connection

Readers

influxdb.reuse-connection (generic function)

Writers

(setf influxdb.reuse-connection) (generic function)

Slot: headers

Initform

(quote (:content-type "application/json" :accept "text/plain"))

Readers

influxdb.headers (generic function)

Writers

(setf influxdb.headers) (generic function)

Slot: baseurl

Readers

influxdb.baseurl (generic function)

Writers

(setf influxdb.baseurl) (generic function)

Slot: cookie-jar

Initform

(make-instance (quote drakma:cookie-jar))

Readers

influxdb.cookie-jar (generic function)

Writers

(setf influxdb.cookie-jar) (generic function)

Slot: stream

Readers

influxdb.stream (generic function)

Writers

(setf influxdb.stream) (generic function)

Class: influxdb ()

InfluxDB connection

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• delete-database-user (method)
• update-database-user-password (method)
• add-database-user (method)
• get-database-users (method)
• unset-database-admin (method)
• set-database-admin (method)
• alter-database-admin (method)
• delete-cluster-admin (method)
• update-cluster-admin-password (method)
• add-cluster-admin (method)
• get-list-cluster-admins (method)
• switch-user (method)
• switch-database (method)
• drop-shard (method)
• get-shards (method)
• create-shard (method)
• list-servers (method)
• interfaces (method)
• force-raft-compaction (method)
• ping (method)
• delete-continuous-queries (method)
• create-continuous-queries (method)
• list-continuous-queries (method)
• get-database-list (method)
• delete-database (method)
• create-database (method)
• delete-series (method)
• query (method)
• write-points (method)
• close-reuseable-connection (method)
• influxdb-cmd (method)
• initialize-instance (method)
• influxdb.stream (method)
• influxdb.stream (method)
• influxdb.cookie-jar (method)
• influxdb.cookie-jar (method)
• influxdb.baseurl (method)
• influxdb.baseurl (method)
• influxdb.headers (method)
• influxdb.headers (method)
• influxdb.reuse-connection (method)
• influxdb.reuse-connection (method)
• influxdb.database (method)
• influxdb.database (method)
• influxdb.password (method)
• influxdb.password (method)
• influxdb.user (method)
• influxdb.user (method)
• influxdb.port (method)
• influxdb.port (method)
• influxdb.host (method)
• influxdb.host (method)

Direct slots

Slot: host

Initargs

:host

Initform

"127.0.0.1"

Readers

influxdb.host (generic function)

Writers

(setf influxdb.host) (generic function)

Slot: port

Initargs

:port

Initform

8086

Readers

influxdb.port (generic function)

Writers

(setf influxdb.port) (generic function)

Slot: user

Initargs

:user

Initform

"root"

Readers

influxdb.user (generic function)

Writers

(setf influxdb.user) (generic function)

Slot: password

Initargs

:password

Initform

"root"

Readers

influxdb.password (generic function)

Writers

(setf influxdb.password) (generic function)

Slot: database

Initargs

:database

Readers

influxdb.database (generic function)

Writers

(setf influxdb.database) (generic function)

Slot: reuse-connection

Initargs

:reuse-connection

Readers

influxdb.reuse-connection (generic function)

Writers

(setf influxdb.reuse-connection) (generic function)

Slot: headers

Initform

(quote (:content-type "application/json" :accept "text/plain"))

Readers

influxdb.headers (generic function)

Writers

(setf influxdb.headers) (generic function)

Slot: baseurl

Readers

influxdb.baseurl (generic function)

Writers

(setf influxdb.baseurl) (generic function)

Slot: cookie-jar

Initform

(make-instance (quote drakma:cookie-jar))

Readers

influxdb.cookie-jar (generic function)

Writers

(setf influxdb.cookie-jar) (generic function)

Slot: stream

Readers

influxdb.stream (generic function)

Writers

(setf influxdb.stream) (generic function)

5.2 Internal definitions

5.2.1 Functions

Function: assert-valid-time-precision TVAL

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: assert-valid-time-precision TVAL

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

Function: copy-influxdb-data INSTANCE

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: encode-data DATA

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: encode-influxdb-data DATA

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-data-p OBJECT

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-key-tag-fmt V

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: influxdb-value-fmt V

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: replace-all STRING PART REPLACEMENT &key TEST

Returns a new string in which all the occurences of the part is replaced with replacement.

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: symbol-keyword-or-string V

Takes symbol keyword or string and returns a string representation
In the case of symbols and keywords the returned string is down cased.

Package

cl-influxdb

Source

cl-influxdb.lisp (file)

Function: symbol-keyword-or-string V

Takes symbol keyword or string and returns a string representation
In the case of symbols and keywords the returned string is down cased.

Package

cl-influxdb-v8

Source

cl-influxdb-v8.lisp (file)

5.2.2 Generic functions

Generic Function: body CONDITION

Package

cl-influxdb

Methods

Method: body (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: body CONDITION

Package

cl-influxdb-v8

Methods

Method: body (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: cmd-stream CONDITION

Package

cl-influxdb

Methods

Method: cmd-stream (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: cmd-stream CONDITION

Package

cl-influxdb-v8

Methods

Method: cmd-stream (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: force-raft-compaction SELF

Package

cl-influxdb-v8

Methods

Method: force-raft-compaction (SELF influxdb)

force a raft log compaction

Source

cl-influxdb-v8.lisp (file)

Generic Function: influxdb-cmd SELF ARG-LIST &key DATA PARAMS METHOD OK-STATUS-CODE DEBUG

Package

cl-influxdb-v8

Methods

Method: influxdb-cmd (SELF influxdb) ARG-LIST &key DATA PARAMS METHOD OK-STATUS-CODE DEBUG

Submits influxdb command defined by ARG-LIST which the contains elements of the path after after the base influxdb URL. Certain commands require a specific HTTP method method should be one of :GET :POST :DELETE.
Thd DATA argument should be a lisp object representation of a JSON
object. See examples.lisp write-response-times and refer to CL-JSON documentation for ENCODE-TO-STRING. PARAMS is an alist of paramater
which will be encoded in the HTTP request (they do not need to be url-encoded).

Returns multiple values CONTENT, REASON
On failure raises COMMAND-FAIL condition

Source

cl-influxdb-v8.lisp (file)

Generic Function: must-close CONDITION

Package

cl-influxdb

Methods

Method: must-close (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: must-close CONDITION

Package

cl-influxdb-v8

Methods

Method: must-close (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: reason-phrase CONDITION

Package

cl-influxdb

Methods

Method: reason-phrase (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: reason-phrase CONDITION

Package

cl-influxdb-v8

Methods

Method: reason-phrase (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: status-code CONDITION

Package

cl-influxdb

Methods

Method: status-code (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: status-code CONDITION

Package

cl-influxdb-v8

Methods

Method: status-code (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Generic Function: text CONDITION

Package

cl-influxdb

Methods

Method: text (CONDITION invalid-time-precision)

Source

cl-influxdb.lisp (file)

Generic Function: text CONDITION

Package

cl-influxdb-v8

Methods

Method: text (CONDITION invalid-time-precision)

Source

cl-influxdb-v8.lisp (file)

Generic Function: uri CONDITION

Package

cl-influxdb

Methods

Method: uri (CONDITION command-fail)

Source

cl-influxdb.lisp (file)

Generic Function: uri CONDITION

Package

cl-influxdb-v8

Methods

Method: uri (CONDITION command-fail)

Source

cl-influxdb-v8.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions