Skip to main content

InfluxDBClient

This item only works when running on the server. Server

Client to write InfluxDB points to the server.

Functions​

new​

</>
InfluxDBClient.new(clientConfig: InfluxDBClientConfig?) → InfluxDBClient

Creates a new InfluxDB client

SetClientConfig​

</>
InfluxDBClient.SetClientConfig(
clientConfig: InfluxDBClientConfig
) → ()

Sets the client config for this client

PromiseFlushAll​

</>
InfluxDBClient.PromiseFlushAll(self: InfluxDBClient) → Promise<()>

Flushes all write APIs. Returns a promise that resolves when all write APIs are flushed for all buckets.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new InfluxDB client",
            "params": [
                {
                    "name": "clientConfig",
                    "desc": "",
                    "lua_type": "InfluxDBClientConfig?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/influxdbclient/src/Server/InfluxDBClient.lua"
            }
        },
        {
            "name": "SetClientConfig",
            "desc": "Sets the client config for this client",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBClient"
                },
                {
                    "name": "clientConfig",
                    "desc": "",
                    "lua_type": "InfluxDBClientConfig"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/influxdbclient/src/Server/InfluxDBClient.lua"
            }
        },
        {
            "name": "PromiseFlushAll",
            "desc": "Flushes all write APIs. Returns a promise that resolves when all write APIs are flushed for all buckets.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/influxdbclient/src/Server/InfluxDBClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InfluxDBClient",
    "desc": "Client to write InfluxDB points to the server.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/influxdbclient/src/Server/InfluxDBClient.lua"
    }
}