This is the ThingsDB documentation for version v0, click here for the latest version!
Returns information about the node in the selected scope. See scopes for more information on how to target a specific node scope.
Like all other info(..) functions, this function returns mpdata which can be loaded to extract one or more properties. See example 2.
Value | Description |
---|---|
archive_files | Number of archive files. May decrease after a full store during away mode. |
archived_in_memory | Number of events which are archived in memory. |
cache_expiration_time | Time in seconds when a query expires in cache. Cleanup takes place when in away mode. |
cached_names | Number of names cached in memory. |
cached_queries | Number of queries the node has in stored in cache. |
client_port | Listening for client TCP socket connections on this port. |
connected_clients | Number of connected clients to the node. |
db_stored_event_id | Last stored event Id in full database store. |
events_in_queue | Events which are pending in the queue. |
global_committed_event_id | Lowest known committed event Id by all nodes. |
global_stored_event_id | Lowest known stored event Id by all nodes. |
http_api_port | Listening to this HTTP port for API calls. |
http_status_port | Listening to this HTTP port for status, readiness and liveness requests. |
ip_support | Enabled IP support. May be IPv4/IPv6 or both. |
libcleri_version | Cleri language parser library version. |
libpcre2_version | PCRE regular expression library version. |
libuv_version | UV asynchronous library version. |
local_committed_event_id | Last committed event Id on the node. |
local_stored_event_id | Last stored event Id on disk. Store takes place when in away mode. |
log_level | Current log level for the node. May be changed at runtime using set_log_level(..) |
msgpack_version | MessagePack data protocol library version. |
next_event_id | Next free event Id. |
next_thing_id | Next free things Id. |
node_id | The id which is assigned to the node. |
node_name | This node will publish itself to other nodes using the node name. This can be an IP address, hostname, or a fully qualified domain name (FQDN) of the node. |
node_port | Listening for node TCP socket connections on this port. |
python_interpreter | Displays the Python interpreter which the node is using to run Python modules. |
result_size_limit | Result size limit is checked when packing properties for a thing. If, at the check moment, the packed data size exceeds the limit, packing stops and an RESULT_TOO_LARGE error will be returned. This limit is set in bytes and is used to prevent a huge amount of data, typically when a high deep value is used. See the configuration page to configure this limit. |
scheduled_backups | Number of backups scheduled on this node. Only repeated backups or backups which are planned in the future are included. |
status | Current status of the ThingsDB node. |
storage_path | Path used for storing ThingsDB data. |
syntax_version | Language or syntax version. A new version of ThingsDB might also have a new language version. |
threshold_query_cache | Queries with a length equal or larger than this value will be cached by the node. See the configuration page to configure this threshold. |
uptime | Uptime of the node in seconds. |
version | Version of ThingsDB. |
yajl_version | JSON parser library version. |
zone | Zone number to which the node is assigned. May be changed in the ThingsDB configuration file. |
This function does not generate an event.
node_info()
None
Returns mpdata about the node. Which node is defined by the scope.
This code returns info for the connected node:
node_info();
Example return value in JSON format
{
"archive_files": 1,
"archived_in_memory": 0,
"cache_expiration_time": 900,
"cached_names": 36,
"cached_queries": 23,
"client_port": 9200,
"connected_clients": 1,
"db_stored_event_id": 1,
"events_in_queue": 0,
"global_committed_event_id": 2,
"global_stored_event_id": 2,
"node_name": "node0.local",
"http_api_port": 9210,
"http_status_port": "disabled",
"ip_support": "ALL",
"libcleri_version": "0.12.1",
"libpcre2_version": "10.34",
"libuv_version": "1.34.2",
"local_committed_event_id": 2,
"local_stored_event_id": 2,
"log_level": "WARNING",
"msgpack_version": "3.2.1",
"next_event_id": 3,
"next_thing_id": 5,
"node_id": 0,
"node_port": 9220,
"python_interpreter": "/usr/bin/python",
"result_size_limit": 20971520,
"scheduled_backups": 0,
"status": "READY",
"storage_path": "/var/lib/thingsdb/",
"syntax_version": "v0",
"threshold_query_cache": 160,
"uptime": 7.854678630828857,
"version": "0.10.13",
"yajl_version": "2.1.0",
"zone": 0
}
This code returns just the version of ThingsDB:
node_info().load().version;
Example return value in JSON format
"0.10.13"