This is the cl-influxdb Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:20:14 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-influxdbCommon lisp binding for InfluxDB
Mike Maul <mike.maul@gmail.com>
MIT
cl-json (system).
drakma (system).
do-urlencode (system).
cl-annot (system).
flexi-streams (system).
usocket (system).
package.lisp (file).
cl-influxdb.lisp (file).
cl-influxdb-v8.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-influxdb/cl-influxdb.asdcl-influxdb/package.lispcl-influxdb/cl-influxdb.lispcl-influxdb/cl-influxdb-v8.lispcl-influxdb/cl-influxdb.lisppackage.lisp (file).
cl-influxdb (system).
close-reuseable-connection (method).
command-fail (condition).
create-database (method).
delete-database (method).
get-database-list (method).
get-series (function).
headers (reader method).
influxdb (class).
influxdb-cmd (method).
influxdb-data (structure).
influxdb-data-columns (reader).
(setf influxdb-data-columns) (writer).
influxdb-data-key (reader).
(setf influxdb-data-key) (writer).
influxdb-data-points (reader).
(setf influxdb-data-points) (writer).
influxdb-data-tags (reader).
(setf influxdb-data-tags) (writer).
influxdb-udp-socket (function).
influxdb.baseurl (reader method).
(setf influxdb.baseurl) (writer method).
influxdb.cookie-jar (reader method).
(setf influxdb.cookie-jar) (writer method).
influxdb.database (reader method).
(setf influxdb.database) (writer method).
influxdb.headers (reader method).
(setf influxdb.headers) (writer method).
influxdb.host (reader method).
(setf influxdb.host) (writer method).
influxdb.password (reader method).
(setf influxdb.password) (writer method).
influxdb.port (reader method).
(setf influxdb.port) (writer method).
influxdb.retention-policy (reader method).
(setf influxdb.retention-policy) (writer method).
influxdb.reuse-connection (reader method).
(setf influxdb.reuse-connection) (writer method).
influxdb.scheme (reader method).
(setf influxdb.scheme) (writer method).
influxdb.stream (reader method).
(setf influxdb.stream) (writer method).
influxdb.user (reader method).
(setf influxdb.user) (writer method).
influxdb.write-consistency (reader method).
(setf influxdb.write-consistency) (writer method).
initialize-instance (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).
assert-valid-time-precision (function).
body (reader method).
cmd-stream (reader 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 (reader method).
reason-phrase (reader method).
replace-all (function).
status-code (reader method).
symbol-keyword-or-string (function).
text (reader method).
uri (reader method).
cl-influxdb/cl-influxdb-v8.lispcl-influxdb.lisp (file).
cl-influxdb (system).
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 (reader method).
influxdb (class).
influxdb.baseurl (reader method).
(setf influxdb.baseurl) (writer method).
influxdb.cookie-jar (reader method).
(setf influxdb.cookie-jar) (writer method).
influxdb.database (reader method).
(setf influxdb.database) (writer method).
influxdb.headers (reader method).
(setf influxdb.headers) (writer method).
influxdb.host (reader method).
(setf influxdb.host) (writer method).
influxdb.password (reader method).
(setf influxdb.password) (writer method).
influxdb.port (reader method).
(setf influxdb.port) (writer method).
influxdb.reuse-connection (reader method).
(setf influxdb.reuse-connection) (writer method).
influxdb.stream (reader method).
(setf influxdb.stream) (writer method).
influxdb.user (reader method).
(setf influxdb.user) (writer method).
initialize-instance (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).
assert-valid-time-precision (function).
body (reader method).
cmd-stream (reader method).
force-raft-compaction (method).
influxdb-cmd (method).
must-close (reader method).
reason-phrase (reader method).
status-code (reader method).
symbol-keyword-or-string (function).
text (reader method).
uri (reader method).
Packages are listed by definition order.
cl-influxdbcl-annot.
cl-annot.class.
common-lisp.
drakma.
flexi-streams.
json.
close-reuseable-connection (generic function).
command-fail (condition).
create-database (generic function).
delete-database (generic function).
get-database-list (generic function).
get-series (function).
headers (generic reader).
influxdb (class).
influxdb-cmd (generic function).
influxdb-data (structure).
influxdb-data-columns (reader).
(setf influxdb-data-columns) (writer).
influxdb-data-key (reader).
(setf influxdb-data-key) (writer).
influxdb-data-points (reader).
(setf influxdb-data-points) (writer).
influxdb-data-tags (reader).
(setf influxdb-data-tags) (writer).
influxdb-udp-socket (function).
influxdb.baseurl (generic reader).
(setf influxdb.baseurl) (generic writer).
influxdb.cookie-jar (generic reader).
(setf influxdb.cookie-jar) (generic writer).
influxdb.database (generic reader).
(setf influxdb.database) (generic writer).
influxdb.headers (generic reader).
(setf influxdb.headers) (generic writer).
influxdb.host (generic reader).
(setf influxdb.host) (generic writer).
influxdb.password (generic reader).
(setf influxdb.password) (generic writer).
influxdb.port (generic reader).
(setf influxdb.port) (generic writer).
influxdb.retention-policy (generic reader).
(setf influxdb.retention-policy) (generic writer).
influxdb.reuse-connection (generic reader).
(setf influxdb.reuse-connection) (generic writer).
influxdb.scheme (generic reader).
(setf influxdb.scheme) (generic writer).
influxdb.stream (generic reader).
(setf influxdb.stream) (generic writer).
influxdb.user (generic reader).
(setf influxdb.user) (generic writer).
influxdb.write-consistency (generic reader).
(setf influxdb.write-consistency) (generic writer).
invalid-time-precision (condition).
list-servers (generic function).
make-influxdb-data (function).
ping (generic function).
print-run (macro).
query (generic function).
switch-database (generic function).
switch-user (generic function).
write-points (generic function).
assert-valid-time-precision (function).
body (generic reader).
cmd-stream (generic reader).
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 reader).
reason-phrase (generic reader).
replace-all (function).
status-code (generic reader).
symbol-keyword-or-string (function).
text (generic reader).
uri (generic reader).
cl-influxdb-v8cl-annot.
cl-annot.class.
common-lisp.
drakma.
flexi-streams.
json.
add-cluster-admin (generic function).
add-database-user (generic function).
alter-database-admin (generic function).
close-reuseable-connection (generic function).
command-fail (condition).
create-continuous-queries (generic function).
create-database (generic function).
create-shard (generic function).
delete-cluster-admin (generic function).
delete-continuous-queries (generic function).
delete-database (generic function).
delete-database-user (generic function).
delete-series (generic function).
drop-shard (generic function).
get-database-list (generic function).
get-database-users (generic function).
get-list-cluster-admins (generic function).
get-shards (generic function).
headers (generic reader).
influxdb (class).
influxdb.baseurl (generic reader).
(setf influxdb.baseurl) (generic writer).
influxdb.cookie-jar (generic reader).
(setf influxdb.cookie-jar) (generic writer).
influxdb.database (generic reader).
(setf influxdb.database) (generic writer).
influxdb.headers (generic reader).
(setf influxdb.headers) (generic writer).
influxdb.host (generic reader).
(setf influxdb.host) (generic writer).
influxdb.password (generic reader).
(setf influxdb.password) (generic writer).
influxdb.port (generic reader).
(setf influxdb.port) (generic writer).
influxdb.reuse-connection (generic reader).
(setf influxdb.reuse-connection) (generic writer).
influxdb.stream (generic reader).
(setf influxdb.stream) (generic writer).
influxdb.user (generic reader).
(setf influxdb.user) (generic writer).
interfaces (generic function).
invalid-time-precision (condition).
list-continuous-queries (generic function).
list-servers (generic function).
ping (generic function).
print-run (macro).
query (generic function).
set-database-admin (generic function).
switch-database (generic function).
switch-user (generic function).
unset-database-admin (generic function).
update-cluster-admin-password (generic function).
update-database-user-password (generic function).
write-points (generic function).
assert-valid-time-precision (function).
body (generic reader).
cmd-stream (generic reader).
force-raft-compaction (generic function).
influxdb-cmd (generic function).
must-close (generic reader).
reason-phrase (generic reader).
status-code (generic reader).
symbol-keyword-or-string (function).
text (generic reader).
uri (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Transforms results from query into an alist with keys :status :name :columns :values
key.
tags.
Returns UDP socket for use with write-points using UDP
command-fail)) ¶command-fail)) ¶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
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
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)
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
error.
:status-code
This slot is read-only.
common-lisp.
:stream
This slot is read-only.
:must-close
This slot is read-only.
:reason-phrase
This slot is read-only.
error.
:status-code
This slot is read-only.
common-lisp.
:stream
This slot is read-only.
:must-close
This slot is read-only.
:reason-phrase
This slot is read-only.
error.
text.
error.
text.
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)
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
close-reuseable-connection.
create-database.
delete-database.
get-database-list.
influxdb-cmd.
(setf influxdb.baseurl).
influxdb.baseurl.
(setf influxdb.cookie-jar).
influxdb.cookie-jar.
(setf influxdb.database).
influxdb.database.
(setf influxdb.headers).
influxdb.headers.
(setf influxdb.host).
influxdb.host.
(setf influxdb.password).
influxdb.password.
(setf influxdb.port).
influxdb.port.
(setf influxdb.retention-policy).
influxdb.retention-policy.
(setf influxdb.reuse-connection).
influxdb.reuse-connection.
(setf influxdb.scheme).
influxdb.scheme.
(setf influxdb.stream).
influxdb.stream.
(setf influxdb.user).
influxdb.user.
(setf influxdb.write-consistency).
influxdb.write-consistency.
initialize-instance.
list-servers.
ping.
query.
switch-database.
switch-user.
write-points.
"http"
:scheme
"127.0.0.1"
:host
8086
:port
"root"
:user
"root"
:password
:database
:retention-policy
:write-consistency
:reuse-connection
(quote (:content-type "application/json" :accept "text/plain"))
drakma.
(make-instance (quote drakma:cookie-jar))
common-lisp.
InfluxDB connection
add-cluster-admin.
add-database-user.
alter-database-admin.
close-reuseable-connection.
create-continuous-queries.
create-database.
create-shard.
delete-cluster-admin.
delete-continuous-queries.
delete-database.
delete-database-user.
delete-series.
drop-shard.
force-raft-compaction.
get-database-list.
get-database-users.
get-list-cluster-admins.
get-shards.
influxdb-cmd.
(setf influxdb.baseurl).
influxdb.baseurl.
(setf influxdb.cookie-jar).
influxdb.cookie-jar.
(setf influxdb.database).
influxdb.database.
(setf influxdb.headers).
influxdb.headers.
(setf influxdb.host).
influxdb.host.
(setf influxdb.password).
influxdb.password.
(setf influxdb.port).
influxdb.port.
(setf influxdb.reuse-connection).
influxdb.reuse-connection.
(setf influxdb.stream).
influxdb.stream.
(setf influxdb.user).
influxdb.user.
initialize-instance.
interfaces.
list-continuous-queries.
list-servers.
ping.
query.
set-database-admin.
switch-database.
switch-user.
unset-database-admin.
update-cluster-admin-password.
update-database-user-password.
write-points.
"127.0.0.1"
:host
8086
:port
"root"
:user
"root"
:password
:database
:reuse-connection
(quote (:content-type "application/json" :accept "text/plain"))
drakma.
(make-instance (quote drakma:cookie-jar))
common-lisp.
Returns a new string in which all the occurences of the part is replaced with replacement.
Takes symbol keyword or string and returns a string representation
In the case of symbols and keywords the returned string is down cased.
Takes symbol keyword or string and returns a string representation
In the case of symbols and keywords the returned string is down cased.
command-fail)) ¶command-fail)) ¶command-fail)) ¶command-fail)) ¶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
command-fail)) ¶command-fail)) ¶command-fail)) ¶command-fail)) ¶command-fail)) ¶command-fail)) ¶invalid-time-precision)) ¶text.
invalid-time-precision)) ¶text.
command-fail)) ¶uri.
command-fail)) ¶uri.
| Jump to: | (
A B C D E F G H I L M P Q R S T U W |
|---|
| Jump to: | (
A B C D E F G H I L M P Q R S T U W |
|---|
| Jump to: | B C D H K M P R S T U W |
|---|
| Jump to: | B C D H K M P R S T U W |
|---|
| Jump to: | C F I P S |
|---|
| Jump to: | C F I P S |
|---|